org.picketlink.common.properties.query

Class PropertyAdapter<V>

java.lang.Object

org.picketlink.common.properties.query.PropertyAdapter<V>

All Implemented Interfaces:

Property<V>

public class PropertyAdapter<V>
extends Object
implements Property<V>

This class is an adapter that encapsulates a FieldProperty and MethodProperty instance for a property, giving a single view of a property and its related information independent of the member type: field or method. The latter usually being a accessor or a mutator method.

This adapter is specially useful when checking for property's metadata independent of the member. This is the case when checking the presence of annotations. As annotations can be defined in one of the members only, if one of the members define the annotation the property itself has the annotation too.

Author:

Pedro Igor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AnnotatedElement	getAnnotatedElement() Get the element responsible for retrieving the property value
Type	getBaseType() Returns the property type
Class<?>	getDeclaringClass() Returns the class that declares the property
Class<V>	getJavaClass() Returns the property type
Member	getMember() Get the member responsible for retrieving the property value
String	getName() Returns the name of the property.
V	getValue(Object instance) Returns the property value for the specified bean.
int	hashCode()
boolean	isAnnotationPresent(Class<? extends Annotation> annotation) Indicates whether the given annotation is defined for this property.
boolean	isReadOnly() Indicates whether this is a read-only property
void	setAccessible() Calls the setAccessible method on the underlying member(s).
void	setValue(Object instance, V value) This method sets the property value for a specified bean to the specified value.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Description copied from interface: Property

Returns the name of the property. If the property is a field, then the field name is returned. Otherwise, if the property is a method, then the name that is returned is the getter method name without the "get" or "is" prefix, and a lower case first letter.

Specified by:

getName in interface Property<V>

Returns:

The name of the property

getBaseType

public Type getBaseType()

Description copied from interface: Property

Returns the property type

Specified by:

getBaseType in interface Property<V>

Returns:

The property type

getJavaClass

public Class<V> getJavaClass()

Description copied from interface: Property

Returns the property type

Specified by:

getJavaClass in interface Property<V>

Returns:

The property type

getAnnotatedElement

public AnnotatedElement getAnnotatedElement()

Description copied from interface: Property

Get the element responsible for retrieving the property value

Specified by:

getAnnotatedElement in interface Property<V>

Returns:

getMember

public Member getMember()

Description copied from interface: Property

Get the member responsible for retrieving the property value

Specified by:

getMember in interface Property<V>

Returns:

getValue

public V getValue(Object instance)

Description copied from interface: Property

Returns the property value for the specified bean. The property to be returned is either a field or getter method.

Specified by:

getValue in interface Property<V>

Returns:

The property value

setValue

public void setValue(Object instance,
                     V value)

Description copied from interface: Property

This method sets the property value for a specified bean to the specified value. The property to be set is either a field or setter method.

Specified by:

setValue in interface Property<V>

value - The new property value

getDeclaringClass

public Class<?> getDeclaringClass()

Description copied from interface: Property

Returns the class that declares the property

Specified by:

getDeclaringClass in interface Property<V>

Returns:

isReadOnly

public boolean isReadOnly()

Description copied from interface: Property

Indicates whether this is a read-only property

Specified by:

isReadOnly in interface Property<V>

Returns:

setAccessible

public void setAccessible()

Description copied from interface: Property

Calls the setAccessible method on the underlying member(s).

The operation should be performed within a PrivilegedAction

Specified by:

setAccessible in interface Property<V>

isAnnotationPresent

public boolean isAnnotationPresent(Class<? extends Annotation> annotation)

Description copied from interface: Property

Indicates whether the given annotation is defined for this property. This method will consider the annotations present in both field and accessor method.

Specified by:

isAnnotationPresent in interface Property<V>

Parameters:

annotation - The Annotation to check.

Returns:

True if the annotation is defined. Otherwise is false.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object