org.jadira.reflection.access.model

Class FieldModel<C>

java.lang.Object

org.jadira.reflection.access.model.FieldModel<C>

public class FieldModel<C>
extends Object

Provides a model resulting from introspection of a field of a class suitable for use with Java Reflection

Method Summary

Modifier and Type	Method and Description
static <C> FieldModel<C>	get(Field f, FieldAccess<C> fieldAccess) Returns a field model for the given Field and FieldAccess instance.
Field	getField() Access the Field associated with the FieldModel
FieldAccess<C>	getFieldAccess() Access the FieldAccess associated with the FieldModel
Class<?>	getFieldClass() Gets the Declared Class for the Field
FieldType	getFieldType() Indicates the type of the Field - Primitive, Array or Object
boolean	isPrivate() Indicates whether the field is private access
boolean	isSynthetic() Indicates whether the field is synthetic according to the Java Language Specific
boolean	isTransientAnnotatedField() Indicates whether the field carries a Transient annotation
boolean	isTransientField() Indicates whether the field is transient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public static final <C> FieldModel<C> get(Field f,
                                          FieldAccess<C> fieldAccess)

Returns a field model for the given Field and FieldAccess instance. If a FieldModel already exists, it will be reused.

Type Parameters:

C - The type of class being accessed

Parameters:

f - The Field

fieldAccess - The Field Access that can be used to introspect the field

Returns:

The Field Model

getFieldAccess

public FieldAccess<C> getFieldAccess()

Access the FieldAccess associated with the FieldModel

Returns:

The associated FieldAccess.

getField

public Field getField()

Access the Field associated with the FieldModel

Returns:

The associated Field

getFieldType

public FieldType getFieldType()

Indicates the type of the Field - Primitive, Array or Object

Returns:

The FieldType

getFieldClass

public Class<?> getFieldClass()

Gets the Declared Class for the Field

Returns:

The Class for the Field

isTransientField

public boolean isTransientField()

Indicates whether the field is transient

Returns:

True if transient

isTransientAnnotatedField

public boolean isTransientAnnotatedField()

Indicates whether the field carries a Transient annotation

Returns:

True if transient annotated

isSynthetic

public boolean isSynthetic()

Indicates whether the field is synthetic according to the Java Language Specific

Returns:

True if synthetic

isPrivate

public boolean isPrivate()

Indicates whether the field is private access

Returns:

True if private