Author: kkolinko
Date: Sun Oct 19 17:38:56 2014
New Revision: 1632958
URL: http://svn.apache.org/r1632958
Log:
Merged r1631717 from tomcat/trunk:
Fix the remaining Javadoc warnings for the EL API when building with Java 8.
Modified:
tomcat/tc7.0.x/trunk/ (props changed)
tomcat/tc7.0.x/trunk/java/javax/el/ELContext.java
tomcat/tc7.0.x/trunk/java/javax/el/ELContextEvent.java
tomcat/tc7.0.x/trunk/java/javax/el/ELResolver.java
tomcat/tc7.0.x/trunk/java/javax/el/ExpressionFactory.java
tomcat/tc7.0.x/trunk/java/javax/el/MethodExpression.java
tomcat/tc7.0.x/trunk/java/javax/el/ValueExpression.java
Propchange: tomcat/tc7.0.x/trunk/
------------------------------------------------------------------------------
Merged /tomcat/trunk:r1631717
Modified: tomcat/tc7.0.x/trunk/java/javax/el/ELContext.java
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/javax/el/ELContext.java?rev=1632958&r1=1632957&r2=1632958&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/javax/el/ELContext.java (original)
+++ tomcat/tc7.0.x/trunk/java/javax/el/ELContext.java Sun Oct 19 17:38:56 2014
@@ -41,8 +41,14 @@ public abstract class ELContext {
// Can't use Class<?> because API needs to match specification
/**
+ * Obtain the context object for the given key.
+ *
+ * @param key The key of the required context object
+ *
+ * @return The value of the context object associated with the given key
+ *
* @throws NullPointerException
- * If the provided key is <code>null</code>
+ * If the supplied key is <code>null</code>
*/
public Object getContext(@SuppressWarnings("rawtypes") Class key) {
if (key == null) {
@@ -55,6 +61,15 @@ public abstract class ELContext {
}
// Can't use Class<?> because API needs to match specification
+ /**
+ * Add an object to this EL context under the given key.
+ *
+ * @param key The key under which to store the object
+ * @param contextObject The object to add
+ *
+ * @throws NullPointerException
+ * If the supplied key or context is <code>null</code>
+ */
public void putContext(@SuppressWarnings("rawtypes") Class key,
Object contextObject) throws NullPointerException {
if (key == null || contextObject == null) {
Modified: tomcat/tc7.0.x/trunk/java/javax/el/ELContextEvent.java
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/javax/el/ELContextEvent.java?rev=1632958&r1=1632957&r2=1632958&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/javax/el/ELContextEvent.java (original)
+++ tomcat/tc7.0.x/trunk/java/javax/el/ELContextEvent.java Sun Oct 19 17:38:56
2014
@@ -19,15 +19,12 @@ package javax.el;
import java.util.EventObject;
-/**
- *
- */
public class ELContextEvent extends EventObject {
private static final long serialVersionUID = 1255131906285426769L;
/**
- * @param source
+ * @param source The EL context that was the source of this event
*/
public ELContextEvent(ELContext source) {
super(source);
Modified: tomcat/tc7.0.x/trunk/java/javax/el/ELResolver.java
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/javax/el/ELResolver.java?rev=1632958&r1=1632957&r2=1632958&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/javax/el/ELResolver.java (original)
+++ tomcat/tc7.0.x/trunk/java/javax/el/ELResolver.java Sun Oct 19 17:38:56 2014
@@ -30,10 +30,55 @@ public abstract class ELResolver {
public abstract Object getValue(ELContext context, Object base, Object
property) throws NullPointerException, PropertyNotFoundException, ELException;
+ /**
+ * @param context The EL context for this evaluation
+ * @param base The base object on which the property is to be found
+ * @param property The property whose type is to be returned
+ * @return the type of the provided property
+ * @throws NullPointerException
+ * If the supplied context is <code>null</code>
+ * @throws PropertyNotFoundException
+ * If the base/property combination provided to the resolver
is
+ * one that the resolver can handle but no match was found or
a
+ * match was found but was not readable
+ * @throws ELException
+ * Wraps any exception throw whilst resolving the property
+ */
public abstract Class<?> getType(ELContext context, Object base, Object
property) throws NullPointerException, PropertyNotFoundException, ELException;
+ /**
+ * @param context The EL context for this evaluation
+ * @param base The base object on which the property is to be found
+ * @param property The property whose value is to be set
+ * @param value The value to set the property to
+ * @throws NullPointerException
+ * If the supplied context is <code>null</code>
+ * @throws PropertyNotFoundException
+ * If the base/property combination provided to the resolver
is
+ * one that the resolver can handle but no match was found
+ * @throws PropertyNotWritableException
+ * If the base/property combination provided to the resolver
is
+ * one that the resolver can handle but the property was not
+ * writable
+ * @throws ELException
+ * Wraps any exception throw whilst resolving the property
+ */
public abstract void setValue(ELContext context, Object base, Object
property, Object value) throws NullPointerException, PropertyNotFoundException,
PropertyNotWritableException, ELException;
+ /**
+ * @param context The EL context for this evaluation
+ * @param base The base object on which the property is to be found
+ * @param property The property to be checked for read only status
+ * @return <code>true</code> if the identified property is read only,
+ * otherwise <code>false</code>
+ * @throws NullPointerException
+ * If the supplied context is <code>null</code>
+ * @throws PropertyNotFoundException
+ * If the base/property combination provided to the resolver
is
+ * one that the resolver can handle but no match was found
+ * @throws ELException
+ * Wraps any exception throw whilst resolving the property
+ */
public abstract boolean isReadOnly(ELContext context, Object base, Object
property) throws NullPointerException, PropertyNotFoundException, ELException;
public abstract Iterator<java.beans.FeatureDescriptor>
getFeatureDescriptors(ELContext context, Object base);
@@ -41,13 +86,22 @@ public abstract class ELResolver {
public abstract Class<?> getCommonPropertyType(ELContext context, Object
base);
/**
+ * Invokes a method on the the given object. This default implementation
+ * always returns <code>null</code>.
+ *
+ * @param context The EL context for this evaluation
+ * @param base The base object on which the method is to be found
+ * @param method The method to invoke
+ * @param paramTypes The types of the parameters of the method to invoke
+ * @param params The parameters with which to invoke the method
+ *
+ * @return Always <code>null</code>
+ *
* @since EL 2.2
*/
- public Object invoke(@SuppressWarnings("unused") ELContext context,
- @SuppressWarnings("unused") Object base,
- @SuppressWarnings("unused") Object method,
- @SuppressWarnings("unused") Class<?>[] paramTypes,
- @SuppressWarnings("unused") Object[] params) {
+ public Object invoke(ELContext context, Object base, Object method,
+ Class<?>[] paramTypes, Object[] params) {
return null;
}
+
}
Modified: tomcat/tc7.0.x/trunk/java/javax/el/ExpressionFactory.java
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/javax/el/ExpressionFactory.java?rev=1632958&r1=1632957&r2=1632958&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/javax/el/ExpressionFactory.java (original)
+++ tomcat/tc7.0.x/trunk/java/javax/el/ExpressionFactory.java Sun Oct 19
17:38:56 2014
@@ -86,9 +86,35 @@ public abstract class ExpressionFactory
}
}
+ /**
+ * Coerce the supplied object to the requested type.
+ *
+ * @param obj The object to be coerced
+ * @param expectedType The type to which the object should be coerced
+ *
+ * @return An instance of the requested type.
+ *
+ * @throws ELException
+ * If the conversion fails
+ */
public abstract Object coerceToType(Object obj, Class<?> expectedType)
throws ELException;
+ /**
+ * Create a new value expression.
+ *
+ * @param context The EL context for this evaluation
+ * @param expression The String representation of the value expression
+ * @param expectedType The expected type of the result of evaluating the
+ * expression
+ *
+ * @return A new value expression formed from the input parameters
+ *
+ * @throws NullPointerException
+ * If the expected type is <code>null</code>
+ * @throws ELException
+ * If there are syntax errors in the provided expression
+ */
public abstract ValueExpression createValueExpression(ELContext context,
String expression, Class<?> expectedType)
throws NullPointerException, ELException;
@@ -96,6 +122,23 @@ public abstract class ExpressionFactory
public abstract ValueExpression createValueExpression(Object instance,
Class<?> expectedType);
+ /**
+ * Create a new method expression instance.
+ *
+ * @param context The EL context for this evaluation
+ * @param expression The String representation of the method
+ * expression
+ * @param expectedReturnType The expected type of the result of invoking
the
+ * method
+ * @param expectedParamTypes The expected types of the input parameters
+ *
+ * @return A new method expression formed from the input parameters.
+ *
+ * @throws NullPointerException
+ * If the expected parameters types are <code>null</code>
+ * @throws ELException
+ * If there are syntax errors in the provided expression
+ */
public abstract MethodExpression createMethodExpression(ELContext context,
String expression, Class<?> expectedReturnType,
Class<?>[] expectedParamTypes) throws ELException,
Modified: tomcat/tc7.0.x/trunk/java/javax/el/MethodExpression.java
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/javax/el/MethodExpression.java?rev=1632958&r1=1632957&r2=1632958&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/javax/el/MethodExpression.java (original)
+++ tomcat/tc7.0.x/trunk/java/javax/el/MethodExpression.java Sun Oct 19
17:38:56 2014
@@ -24,8 +24,40 @@ public abstract class MethodExpression e
private static final long serialVersionUID = 8163925562047324656L;
+ /**
+ * @param context The EL context for this evaluation
+ *
+ * @return Information about the method that this expression resolves to
+ *
+ * @throws NullPointerException
+ * If the supplied context is <code>null</code>
+ * @throws PropertyNotFoundException
+ * If a property/variable resolution failed because no match
+ * was found or a match was found but was not readable
+ * @throws MethodNotFoundException
+ * If no matching method can be found
+ * @throws ELException
+ * Wraps any exception throw whilst resolving the property
+ */
public abstract MethodInfo getMethodInfo(ELContext context) throws
NullPointerException, PropertyNotFoundException, MethodNotFoundException,
ELException;
+ /**
+ * @param context The EL context for this evaluation
+ * @param params The parameters with which to invoke this method
expression
+ *
+ * @return The result of invoking this method expression
+ *
+ * @throws NullPointerException
+ * If the supplied context is <code>null</code>
+ * @throws PropertyNotFoundException
+ * If a property/variable resolution failed because no match
+ * was found or a match was found but was not readable
+ * @throws MethodNotFoundException
+ * If no matching method can be found
+ * @throws ELException
+ * Wraps any exception throw whilst resolving the property or
+ * coercion of the result to the expected return type fails
+ */
public abstract Object invoke(ELContext context, Object[] params) throws
NullPointerException, PropertyNotFoundException, MethodNotFoundException,
ELException;
/**
Modified: tomcat/tc7.0.x/trunk/java/javax/el/ValueExpression.java
URL:
http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/javax/el/ValueExpression.java?rev=1632958&r1=1632957&r2=1632958&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/java/javax/el/ValueExpression.java (original)
+++ tomcat/tc7.0.x/trunk/java/javax/el/ValueExpression.java Sun Oct 19 17:38:56
2014
@@ -26,15 +26,79 @@ public abstract class ValueExpression ex
public abstract Class<?> getExpectedType();
+ /**
+ * @param context The EL context for this evaluation
+ *
+ * @return The type of the result of this value expression
+ *
+ * @throws NullPointerException
+ * If the supplied context is <code>null</code>
+ * @throws PropertyNotFoundException
+ * If a property/variable resolution failed because no match
+ * was found or a match was found but was not readable
+ * @throws ELException
+ * Wraps any exception throw whilst resolving a property or
+ * variable
+ */
public abstract Class<?> getType(ELContext context) throws
NullPointerException, PropertyNotFoundException, ELException;
+ /**
+ * @param context The EL context for this evaluation
+ *
+ * @return <code>true</code> if this expression is read only otherwise
+ * <code>false</code>
+ *
+ * @throws NullPointerException
+ * If the supplied context is <code>null</code>
+ * @throws PropertyNotFoundException
+ * If a property/variable resolution failed because no match
+ * was found or a match was found but was not readable
+ * @throws ELException
+ * Wraps any exception throw whilst resolving a property or
+ * variable
+ */
public abstract boolean isReadOnly(ELContext context) throws
NullPointerException, PropertyNotFoundException, ELException;
+ /**
+ * @param context The EL context for this evaluation
+ * @param value The value to set the property to which this value
+ * expression refers
+ *
+ * @throws NullPointerException
+ * If the supplied context is <code>null</code>
+ * @throws PropertyNotFoundException
+ * If a property/variable resolution failed because no match
+ * was found
+ * @throws PropertyNotWritableException
+ * If a property/variable resolution failed because a match
was
+ * found but was not writable
+ * @throws ELException
+ * Wraps any exception throw whilst resolving a property or
+ * variable
+ */
public abstract void setValue(ELContext context, Object value) throws
NullPointerException, PropertyNotFoundException, PropertyNotWritableException,
ELException;
+ /**
+ * @param context The EL context for this evaluation
+ *
+ * @return The result of evaluating this value expression
+ *
+ * @throws NullPointerException
+ * If the supplied context is <code>null</code>
+ * @throws PropertyNotFoundException
+ * If a property/variable resolution failed because no match
+ * was found or a match was found but was not readable
+ * @throws ELException
+ * Wraps any exception throw whilst resolving a property or
+ * variable
+ */
public abstract Object getValue(ELContext context) throws
NullPointerException, PropertyNotFoundException, ELException;
/**
+ * @param context The EL context for this evaluation
+ *
+ * @return This default implementation always returns <code>null</code>
+ *
* @since EL 2.2
*/
public ValueReference getValueReference(@SuppressWarnings("unused")
ELContext context) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
