com.openpojo.reflection

Interface PojoField

All Superinterfaces:

Accessible, Annotatable, Parameterizable, PojoElement

public interface PojoField
extends PojoElement, Parameterizable, Accessible

This class encapsulates the meta data definition of a field on a class.

Author:

oshoukry

Method Summary

Modifier and Type	Method and Description
Object	get(Object instance) This method gets the value of the field.
PojoClass	getDeclaringPojoClass()
PojoMethod	getGetter() Returns getter PojoMethod or null if none are set.
PojoMethod	getSetter() Returns setter PojoMethod or null if none are set.
boolean	hasGetter() Returns true if this field has a getter method.
boolean	hasSetter() Returns true if this field has a setter method.
Object	invokeGetter(Object instance) This method will invoke the getter method.
void	invokeSetter(Object instance, Object value) This method will invoke the setter method.
boolean	isArray()
boolean	isFinal()
boolean	isPrimitive()
boolean	isStatic()
boolean	isSynthetic()
boolean	isTransient()
boolean	isVolatile()
void	set(Object instance, Object value) This method sets the value of the field.
String	toString(Object instance) Returns properly formatted field=value string from instance.

Methods inherited from interface com.openpojo.reflection.PojoElement

getName

Methods inherited from interface com.openpojo.reflection.Annotatable

getAnnotation, getAnnotations

Methods inherited from interface com.openpojo.reflection.Parameterizable

getParameterTypes, getType, isParameterized

Methods inherited from interface com.openpojo.reflection.Accessible

isPackagePrivate, isPrivate, isProtected, isPublic

Method Detail

get

Object get(Object instance)

This method gets the value of the field.

Parameters:

instance - The instance to extract the value out of.

Returns:

The value of the field.

set

void set(Object instance,
         Object value)

This method sets the value of the field.

Parameters:

instance - The instance to set the value on.

value - The value to set it to.

hasGetter

boolean hasGetter()

Returns true if this field has a getter method.

Returns:

Returns true if the getter is set.

getGetter

PojoMethod getGetter()

Returns getter PojoMethod or null if none are set.

Returns:

Returns getter if one is set, null otherwise.

invokeGetter

Object invokeGetter(Object instance)

This method will invoke the getter method.

Parameters:

instance - The instance of the class to invoke the getter on.

Returns:

The value of the field.

hasSetter

boolean hasSetter()

Returns true if this field has a setter method.

Returns:

Returns true if the setter is set.

getSetter

PojoMethod getSetter()

Returns setter PojoMethod or null if none are set.

Returns:

Returns setter if one is set, null otherwise.

getDeclaringPojoClass

PojoClass getDeclaringPojoClass()

Returns:

Returns the enclosing PojoClass.

invokeSetter

void invokeSetter(Object instance,
                  Object value)

This method will invoke the setter method.

Parameters:

instance - The instance of the class to invoke the setter on.

value - The value to set the field to.

isPrimitive

boolean isPrimitive()

Returns:

True if the field is of primitive type.

isFinal

boolean isFinal()

Returns:

True if this PojoField is defined as final on the enclosing class.

isStatic

boolean isStatic()

Returns:

True if this PojoField is defined as static on the enclosing class.

isTransient

boolean isTransient()

Returns:

True if this PojoField is defined as transient on the enclosing class.

isVolatile

boolean isVolatile()

Returns:

True if this PojoField is defined as volatile on the enclosing class.

isArray

boolean isArray()

Returns:

True if this PojoField is defined as array on the enclosing class.

isSynthetic

boolean isSynthetic()

Returns:

true if this PojoField is synthetic (i.e. jdk compiler generated).

toString

String toString(Object instance)

Returns properly formatted field=value string from instance.

Parameters:

instance - The instance to pull the field value off of.

Returns:

A string representation of the field and value.