Oracle's implementation of the JSF 2.3 specification API. 2.3 · javax.faces.el.PropertyResolver

Access	Constructor and Description
public	PropertyResolver()

Method Summary

Modifier and Type	Method and Description
public abstract Class<T>	Returns: the `java.lang.Class` representing the type of the specified property of the specified base object, if it can be determined; otherwise `null` getType(Object The base object whose property is to be analyzed base, Object The property to be analyzed property) Return the `java.lang.Class` representing the type of the specified property.
public abstract Class<T>	Returns: The `java.lang.Class` representing the type of value at the specified index of the specified base object, if it can be determined; otherwise `null` getType(Object The base object whose property is to be analyzed base, int The index of the value whose type is to be returned index) Return the `java.lang.Class` representing the type of the specified index.
public abstract Object	Returns: The property value, or `null` if `base` or `property` is `null`, or if the property doesn't exist and the base object is a `Map` instance getValue(Object The base object whose property value is to be returned base, Object The property to be returned property) Return the value of the specified property from the specified base object.
public abstract Object	Returns: The property value, or `null` if `base` is `null`, or if the index is out of bounds for the base object getValue(Object The base object whose property value is to be returned base, int The index of the value to return index) Return the value at the specified index of the specified base object.
public abstract boolean	Returns: `true` if the specified property of the specified base object is known to be immutable; otherwise `false` isReadOnly(Object The base object whose property is to be analyzed base, Object The property to be analyzed property) Checks if the specified property is read-only.
public abstract boolean	Returns: `true` if the value at the specified index of the specified base object is known to be immutable; otherwise, `false` isReadOnly(Object The base object whose property is to be analyzed base, int The index of the value whose type is to be returned index) Checks if the specified index is read-only.
public abstract void	setValue(Object The base object whose property value is to be set base, Object The property to be set property, Object The value of the property to be set value) Set the specified value of the specified property on the specified base object.
public abstract void	setValue(Object The base object whose property value is to be set base, int The index of the value to set index, Object The value to be set value) Set the value at the specified index of the specified base object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

PropertyResolver	back to summary
public PropertyResolver()

Method Detail

getType back to summary

getType	back to summary
public abstract Class<T> getType(Object base, Object property) throws EvaluationException, PropertyNotFoundException Return the `java.lang.Class` representing the type of the specified property. An instance of any Object of that type my be set as the value of that property, as long as the property is not read-only. The actual value of the property, if non-null, is guaranteed to be an instance of this type, or an instance of a subclass of this type. This method is also useful for discovering the type of Objects that may be set as the value of the property. For a bean base object, the property is coerced to a `String` and used as the property name. For all other base object types (e.g., a Map), the property is used without any coercing. Parameters base:Object The base object whose property is to be analyzed property:Object The property to be analyzed Returns:Class<T> the `java.lang.Class` representing the type of the specified property of the specified base object, if it can be determined; otherwise `null` Exceptions EvaluationException: if an exception is thrown while testing the property (the thrown exception must be included as the `cause` property of this exception) PropertyNotFoundException: if the specified bean base object property does not exist or if `base` or `property` is `null`

public abstract Class<T> getType(Object base, Object property) throws EvaluationException, PropertyNotFoundException

Return the java.lang.Class representing the type of the specified property. An instance of any Object of that type my be set as the value of that property, as long as the property is not read-only. The actual value of the property, if non-null, is guaranteed to be an instance of this type, or an instance of a subclass of this type. This method is also useful for discovering the type of Objects that may be set as the value of the property.

For a bean base object, the property is coerced to a String and used as the property name. For all other base object types (e.g., a Map), the property is used without any coercing.

Parameters

base:Object: The base object whose property is to be analyzed
property:Object: The property to be analyzed

Returns:Class<T>

the java.lang.Class representing the type of the specified property of the specified base object, if it can be determined; otherwise null

Exceptions

EvaluationException:: if an exception is thrown while testing the property (the thrown exception must be included as the cause property of this exception)
PropertyNotFoundException:: if the specified bean base object property does not exist or if base or property is null

getType back to summary

getType	back to summary
public abstract Class<T> getType(Object base, int index) throws EvaluationException, PropertyNotFoundException Return the `java.lang.Class` representing the type of the specified index. Parameters base:Object The base object whose property is to be analyzed index:int The index of the value whose type is to be returned Returns:Class<T> The `java.lang.Class` representing the type of value at the specified index of the specified base object, if it can be determined; otherwise `null` Exceptions EvaluationException: if an exception is thrown while testing the property (the thrown exception must be included as the `cause` property of this exception) PropertyNotFoundException: if the index is out of bounds or if `base` is `null`

public abstract Class<T> getType(Object base, int index) throws EvaluationException, PropertyNotFoundException

Return the java.lang.Class representing the type of the specified index.

Parameters

base:Object: The base object whose property is to be analyzed
index:int: The index of the value whose type is to be returned

Returns:Class<T>

The java.lang.Class representing the type of value at the specified index of the specified base object, if it can be determined; otherwise null

Exceptions

EvaluationException:: if an exception is thrown while testing the property (the thrown exception must be included as the cause property of this exception)
PropertyNotFoundException:: if the index is out of bounds or if base is null

getValue back to summary

getValue	back to summary
public abstract Object getValue(Object base, Object property) throws EvaluationException, PropertyNotFoundException Return the value of the specified property from the specified base object. For a bean base object, the property is coerced to a `String` and used as the property name. For all other base object types (e.g., a Map), the property is used without any coercing. Parameters base:Object The base object whose property value is to be returned property:Object The property to be returned Returns:Object The property value, or `null` if `base` or `property` is `null`, or if the property doesn't exist and the base object is a `Map` instance Exceptions EvaluationException: if an exception is thrown while getting the property value (the thrown exception must be included as the `cause` property of this exception) PropertyNotFoundException: if the specified property for a bean base object does not exist or is not readable

public abstract Object getValue(Object base, Object property) throws EvaluationException, PropertyNotFoundException

Return the value of the specified property from the specified base object.

For a bean base object, the property is coerced to a String and used as the property name. For all other base object types (e.g., a Map), the property is used without any coercing.

Parameters

base:Object: The base object whose property value is to be returned
property:Object: The property to be returned

Returns:Object

The property value, or null if base or property is null, or if the property doesn't exist and the base object is a Map instance

Exceptions

EvaluationException:: if an exception is thrown while getting the property value (the thrown exception must be included as the cause property of this exception)
PropertyNotFoundException:: if the specified property for a bean base object does not exist or is not readable

getValue back to summary

getValue	back to summary
public abstract Object getValue(Object base, int index) throws EvaluationException, PropertyNotFoundException Return the value at the specified index of the specified base object. Parameters base:Object The base object whose property value is to be returned index:int The index of the value to return Returns:Object The property value, or `null` if `base` is `null`, or if the index is out of bounds for the base object Exceptions EvaluationException: if an exception is thrown while getting the property value (the thrown exception must be included as the `cause` property of this exception) PropertyNotFoundException: if the index is out of bounds or if `base` is `null`

public abstract Object getValue(Object base, int index) throws EvaluationException, PropertyNotFoundException

Return the value at the specified index of the specified base object.

Parameters

base:Object: The base object whose property value is to be returned
index:int: The index of the value to return

Returns:Object

The property value, or null if base is null, or if the index is out of bounds for the base object

Exceptions

EvaluationException:: if an exception is thrown while getting the property value (the thrown exception must be included as the cause property of this exception)
PropertyNotFoundException:: if the index is out of bounds or if base is null

isReadOnly back to summary

isReadOnly	back to summary
public abstract boolean isReadOnly(Object base, Object property) throws EvaluationException, PropertyNotFoundException Checks if the specified property is read-only. For a bean base object, the property is coerced to a `String` and used as the property name. For all other base object types (e.g., a Map), the property is used without any coercing. Parameters base:Object The base object whose property is to be analyzed property:Object The property to be analyzed Returns:boolean `true` if the specified property of the specified base object is known to be immutable; otherwise `false` Exceptions EvaluationException: if an exception is thrown while testing the property (the thrown exception must be included as the `cause` property of this exception) PropertyNotFoundException: if the specified bean base object property does not exist or if `base` or `property` is `null`

public abstract boolean isReadOnly(Object base, Object property) throws EvaluationException, PropertyNotFoundException

Checks if the specified property is read-only.

For a bean base object, the property is coerced to a String and used as the property name. For all other base object types (e.g., a Map), the property is used without any coercing.

Parameters

base:Object: The base object whose property is to be analyzed
property:Object: The property to be analyzed

Returns:boolean

true if the specified property of the specified base object is known to be immutable; otherwise false

Exceptions

EvaluationException:: if an exception is thrown while testing the property (the thrown exception must be included as the cause property of this exception)
PropertyNotFoundException:: if the specified bean base object property does not exist or if base or property is null

isReadOnly back to summary

isReadOnly	back to summary
public abstract boolean isReadOnly(Object base, int index) throws EvaluationException, PropertyNotFoundException Checks if the specified index is read-only. Parameters base:Object The base object whose property is to be analyzed index:int The index of the value whose type is to be returned Returns:boolean `true` if the value at the specified index of the specified base object is known to be immutable; otherwise, `false` Exceptions EvaluationException: if an exception is thrown while testing the property (the thrown exception must be included as the `cause` property of this exception) PropertyNotFoundException: if the index is out of bounds or if `base` is `null`

public abstract boolean isReadOnly(Object base, int index) throws EvaluationException, PropertyNotFoundException

Checks if the specified index is read-only.

Parameters

base:Object: The base object whose property is to be analyzed
index:int: The index of the value whose type is to be returned

Returns:boolean

true if the value at the specified index of the specified base object is known to be immutable; otherwise, false

Exceptions

EvaluationException:: if an exception is thrown while testing the property (the thrown exception must be included as the cause property of this exception)
PropertyNotFoundException:: if the index is out of bounds or if base is null

setValue back to summary

setValue	back to summary
public abstract void setValue(Object base, Object property, Object value) throws EvaluationException, PropertyNotFoundException Set the specified value of the specified property on the specified base object. For a bean base object, the property is coerced to a `String` and used as the property name. For all other base object types (e.g., a Map), the property is used without any coercing. Parameters base:Object The base object whose property value is to be set property:Object The property to be set value:Object The value of the property to be set Exceptions EvaluationException: if an exception is thrown while setting the property value (the thrown exception must be included as the `cause` property of this exception) PropertyNotFoundException: if the specified bean base object property does not exist or is not writeable, or if `base` or `name` is `null`

public abstract void setValue(Object base, Object property, Object value) throws EvaluationException, PropertyNotFoundException

Set the specified value of the specified property on the specified base object.

For a bean base object, the property is coerced to a String and used as the property name. For all other base object types (e.g., a Map), the property is used without any coercing.

Parameters

base:Object: The base object whose property value is to be set
property:Object: The property to be set
value:Object: The value of the property to be set

Exceptions

EvaluationException:: if an exception is thrown while setting the property value (the thrown exception must be included as the cause property of this exception)
PropertyNotFoundException:: if the specified bean base object property does not exist or is not writeable, or if base or name is null

setValue back to summary

setValue	back to summary
public abstract void setValue(Object base, int index, Object value) throws EvaluationException, PropertyNotFoundException Set the value at the specified index of the specified base object. Parameters base:Object The base object whose property value is to be set index:int The index of the value to set value:Object The value to be set Exceptions EvaluationException: if an exception is thrown while setting the property value (the thrown exception must be included as the `cause` property of this exception) PropertyNotFoundException: if the index is out of bounds or if `base` is `null`

public abstract void setValue(Object base, int index, Object value) throws EvaluationException, PropertyNotFoundException

Set the value at the specified index of the specified base object.

Parameters

base:Object: The base object whose property value is to be set
index:int: The index of the value to set
value:Object: The value to be set

Exceptions

EvaluationException:: if an exception is thrown while setting the property value (the thrown exception must be included as the cause property of this exception)
PropertyNotFoundException:: if the index is out of bounds or if base is null

public abstract Class PropertyResolver

Constructor Summary

Method Summary

Constructor Detail

Method Detail