com.artemis.utils.reflect

Class Field

java.lang.Object

com.artemis.utils.reflect.Field

public final class Field
extends Object

Provides information about, and access to, a single field of a class or interface.

Author:

nexsoftware

Method Summary

Methods

Modifier and Type	Method and Description
Object	get(Object obj) Returns the value of the field on the supplied object.
<T extends Annotation> T	getAnnotation(Class<T> annotationClass) Deprecated.
Annotation	getDeclaredAnnotation(Class<? extends Annotation> annotationType) Returns an Annotation object reflecting the annotation provided, or null of this field doesn't have such an annotation.
Annotation[]	getDeclaredAnnotations() Returns an array of Annotation objects reflecting all annotations declared by this field, or an empty array if there are none.
Class	getDeclaringClass() Returns the Class object representing the class or interface that declares the field.
Class	getElementType(int index) If the type of the field is parameterized, returns the Class object representing the parameter type at the specified index, null otherwise.
String	getName() Returns the name of the field.
Class	getType() Returns a Class object that identifies the declared type for the field.
boolean	hasAnnotation(Class annotationClass) Deprecated.
boolean	isAccessible()
boolean	isAnnotationPresent(Class<? extends Annotation> annotationType) Returns true if the field includes an annotation of the provided class type.
boolean	isDefaultAccess() Return true if the field does not include any of the private, protected, or public modifiers.
boolean	isFinal() Return true if the field includes the final modifier.
boolean	isPrivate() Return true if the field includes the private modifier.
boolean	isProtected() Return true if the field includes the protected modifier.
boolean	isPublic() Return true if the field includes the public modifier.
boolean	isStatic() Return true if the field includes the static modifier.
boolean	isSynthetic() Return true if the field is a synthetic field.
boolean	isTransient() Return true if the field includes the transient modifier.
boolean	isVolatile() Return true if the field includes the volatile modifier.
void	set(Object obj, Object value) Sets the value of the field on the supplied object.
void	setAccessible(boolean accessible)

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Returns the name of the field.

getType

public Class getType()

Returns a Class object that identifies the declared type for the field.

getDeclaringClass

public Class getDeclaringClass()

Returns the Class object representing the class or interface that declares the field.

isAccessible

public boolean isAccessible()

setAccessible

public void setAccessible(boolean accessible)

isDefaultAccess

public boolean isDefaultAccess()

Return true if the field does not include any of the private, protected, or public modifiers.

isFinal

public boolean isFinal()

Return true if the field includes the final modifier.

isPrivate

public boolean isPrivate()

Return true if the field includes the private modifier.

isProtected

public boolean isProtected()

Return true if the field includes the protected modifier.

isPublic

public boolean isPublic()

Return true if the field includes the public modifier.

isStatic

public boolean isStatic()

Return true if the field includes the static modifier.

isTransient

public boolean isTransient()

Return true if the field includes the transient modifier.

isVolatile

public boolean isVolatile()

Return true if the field includes the volatile modifier.

isSynthetic

public boolean isSynthetic()

Return true if the field is a synthetic field.

getElementType

public Class getElementType(int index)

If the type of the field is parameterized, returns the Class object representing the parameter type at the specified index, null otherwise.

get

public Object get(Object obj)
           throws ReflectionException

Returns the value of the field on the supplied object.

Throws:

ReflectionException

set

public void set(Object obj,
       Object value)
         throws ReflectionException

Sets the value of the field on the supplied object.

Throws:

ReflectionException

hasAnnotation

@Deprecated
public boolean hasAnnotation(Class annotationClass)

Deprecated.

Deprecated: Use isAnnotationPresent instead.

getAnnotation

@Deprecated
public <T extends Annotation> T getAnnotation(Class<T> annotationClass)

Deprecated.

Deprecated: Use getDeclaredAnnotation instead.

isAnnotationPresent

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

Returns true if the field includes an annotation of the provided class type.

getDeclaredAnnotations

public Annotation[] getDeclaredAnnotations()

Returns an array of Annotation objects reflecting all annotations declared by this field, or an empty array if there are none. Does not include inherited annotations.

getDeclaredAnnotation

public Annotation getDeclaredAnnotation(Class<? extends Annotation> annotationType)

Returns an Annotation object reflecting the annotation provided, or null of this field doesn't have such an annotation. This is a convenience function if the caller knows already which annotation type he's looking for.