com.google.gson

Class FieldAttributes

java.lang.Object

com.google.gson.FieldAttributes

public final class FieldAttributes
extends java.lang.Object

A data object that stores attributes of a field.

This class is immutable; therefore, it can be safely shared across threads.

Since:

1.4

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.reflect.Field	field

Constructor Summary

Constructors

Constructor and Description
FieldAttributes(java.lang.reflect.Field f) Constructs a Field Attributes object from the f.

Method Summary

Modifier and Type	Method and Description
(package private) java.lang.Object	get(java.lang.Object instance) Returns the value of the field represented by this Field, on the specified object.
<T extends java.lang.annotation.Annotation> T	getAnnotation(java.lang.Class<T> annotation) Return the T annotation object from this field if it exist; otherwise returns null.
java.util.Collection<java.lang.annotation.Annotation>	getAnnotations() Return the annotations that are present on this field.
java.lang.Class<?>	getDeclaredClass() Returns the Class object that was declared for this field.
java.lang.reflect.Type	getDeclaredType() For example, assume the following class definition: public class Foo { private String bar; private List<String> red; } Type listParameterizedType = new TypeToken<List<String>>() {}.getType();
java.lang.Class<?>	getDeclaringClass()
java.lang.String	getName()
boolean	hasModifier(int modifier) Returns true if the field is defined with the modifier.
(package private) boolean	isSynthetic() This is exposed internally only for the removing synthetic fields from the JSON output.

Methods inherited from class java.lang.Object

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

Field Detail

field

private final java.lang.reflect.Field field

Constructor Detail

FieldAttributes

public FieldAttributes(java.lang.reflect.Field f)

Constructs a Field Attributes object from the f.

Parameters:

f - the field to pull attributes from

Method Detail

getDeclaringClass

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

Returns:

the declaring class that contains this field

getName

public java.lang.String getName()

Returns:

the name of the field

getDeclaredType

public java.lang.reflect.Type getDeclaredType()

For example, assume the following class definition:

 public class Foo {
   private String bar;
   private List<String> red;
 }

 Type listParameterizedType = new TypeToken<List<String>>() {}.getType();
 

This method would return String.class for the bar field and listParameterizedType for the red field.

Returns:

the specific type declared for this field

getDeclaredClass

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

Returns the Class object that was declared for this field.

For example, assume the following class definition:

 public class Foo {
   private String bar;
   private List<String> red;
 }
 

This method would return String.class for the bar field and List.class for the red field.

Returns:

the specific class object that was declared for the field

getAnnotation

public <T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<T> annotation)

Return the T annotation object from this field if it exist; otherwise returns null.

Parameters:

annotation - the class of the annotation that will be retrieved

Returns:

the annotation instance if it is bound to the field; otherwise null

getAnnotations

public java.util.Collection<java.lang.annotation.Annotation> getAnnotations()

Return the annotations that are present on this field.

Returns:

an array of all the annotations set on the field

Since:

1.4

hasModifier

public boolean hasModifier(int modifier)

Returns true if the field is defined with the modifier.

This method is meant to be called as:

 boolean hasPublicModifier = fieldAttribute.hasModifier(java.lang.reflect.Modifier.PUBLIC);
 

See Also:

Modifier

get

java.lang.Object get(java.lang.Object instance)
              throws java.lang.IllegalAccessException

Returns the value of the field represented by this Field, on the specified object. The value is automatically wrapped in an object if it has a primitive type.

Returns:

the value of the represented field in object obj; primitive values are wrapped in an appropriate object before being returned

Throws:

java.lang.IllegalAccessException

java.lang.IllegalArgumentException

isSynthetic

boolean isSynthetic()

This is exposed internally only for the removing synthetic fields from the JSON output.

Returns:

true if the field is synthetic; otherwise false