- java.lang.Object
-
- com.google.gson.FieldAttributes
-
public final class FieldAttributes extends 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
- Author:
- Inderjeet Singh, Joel Leitch
-
-
Constructor Summary
Constructors Constructor Description FieldAttributes(Field f)Constructs a Field Attributes object from thef.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T extends Annotation>
TgetAnnotation(Class<T> annotation)Return theTannotation object from this field if it exist; otherwise returnsnull.Collection<Annotation>getAnnotations()Return the annotations that are present on this field.Class<?>getDeclaredClass()Returns theClassobject that was declared for this field.TypegetDeclaredType()For example, assume the following class definition:Class<?>getDeclaringClass()StringgetName()booleanhasModifier(int modifier)Returnstrueif the field is defined with themodifier.
-
-
-
Constructor Detail
-
FieldAttributes
public FieldAttributes(Field f)
Constructs a Field Attributes object from thef.- Parameters:
f- the field to pull attributes from
-
-
Method Detail
-
getDeclaringClass
public Class<?> getDeclaringClass()
- Returns:
- the declaring class that contains this field
-
getName
public String getName()
- Returns:
- the name of the field
-
getDeclaredType
public 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.classfor thebarfield andlistParameterizedTypefor theredfield.- Returns:
- the specific type declared for this field
-
getDeclaredClass
public Class<?> getDeclaredClass()
Returns theClassobject 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.classfor thebarfield andList.classfor theredfield.- Returns:
- the specific class object that was declared for the field
-
getAnnotation
public <T extends Annotation> T getAnnotation(Class<T> annotation)
Return theTannotation object from this field if it exist; otherwise returnsnull.- 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 Collection<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)
Returnstrueif the field is defined with themodifier.This method is meant to be called as:
boolean hasPublicModifier = fieldAttribute.hasModifier(java.lang.reflect.Modifier.PUBLIC);
- See Also:
Modifier
-
-