com.k2.Util.classes

Class FieldGetter<E,T>

java.lang.Object

com.k2.Util.classes.FieldGetter<E,T>

Type Parameters:

E - The type of object that includes the field

T - The type of value held in the field

All Implemented Interfaces:

Getter<E,T>

public class FieldGetter<E,T>
extends java.lang.Object
implements Getter<E,T>

This class implements the Getter interface for a field value

Author:

simon

Nested Class Summary

Nested classes/interfaces inherited from interface com.k2.Util.classes.Getter

Getter.Type

Constructor Summary

Constructors

Constructor and Description
FieldGetter(java.lang.Class<E> objectClass, java.lang.Class<T> fieldClass, java.lang.reflect.Field field) Create an instance of FieldGetter for the given object class, field class and field

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Allows equality comparsons between getters
T	get(E object) This method get the value from the underlying field or getter method
java.lang.String	getAlias() The alias of the field or getter method.
java.lang.Class<?>	getDeclaringClass()
java.lang.Class<T>	getJavaType() The type of the value returned by the call to get()
java.lang.Class<E>	getThroughClass()
Getter.Type	getType() This method returns the type of the getter, METHOD or FIELD
int	hashCode() Allows equality comparisons between getters
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldGetter

public FieldGetter(java.lang.Class<E> objectClass,
                   java.lang.Class<T> fieldClass,
                   java.lang.reflect.Field field)

Create an instance of FieldGetter for the given object class, field class and field

Parameters:

objectClass - The class through which the getter will be invoked

fieldClass - The class of the objects identified by the field

field - The field from which the getter will draw its value

Method Detail

hashCode

public int hashCode()

Description copied from interface: Getter

Allows equality comparisons between getters

Specified by:

hashCode in interface Getter<E,T>

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code for the getter

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: Getter

Allows equality comparsons between getters

Specified by:

equals in interface Getter<E,T>

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to compare to this getter

Returns:

True if the objects are equal

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

get

public T get(E object)

Description copied from interface: Getter

This method get the value from the underlying field or getter method

Specified by:

get in interface Getter<E,T>

Parameters:

object - The object from which the value is to be got

Returns:

The value of the underlying field or returned by the underlying getter method

getJavaType

public java.lang.Class<T> getJavaType()

Description copied from interface: Getter

The type of the value returned by the call to get()

Specified by:

getJavaType in interface Getter<E,T>

Returns:

The type of the value returned by the call to get()

getAlias

public java.lang.String getAlias()

Description copied from interface: Getter

The alias of the field or getter method. The alias of the field is the name by which the field is known in the java code. In the case of method getter this is the portion of the method name after the initial 'get' with it's first character in lower case

Specified by:

getAlias in interface Getter<E,T>

Returns:

The alias of the getter

getType

public Getter.Type getType()

Description copied from interface: Getter

This method returns the type of the getter, METHOD or FIELD

Specified by:

getType in interface Getter<E,T>

Returns:

The type of the getter

getThroughClass

public java.lang.Class<E> getThroughClass()

Specified by:

getThroughClass in interface Getter<E,T>

Returns:

The class on which the getter is to be executed

getDeclaringClass

public java.lang.Class<?> getDeclaringClass()

Specified by:

getDeclaringClass in interface Getter<E,T>

Returns:

The class on which the underlying field or method is defined