FieldInfo (Apache Juneau 8.2.0)

java.lang.Object
- org.apache.juneau.reflect.FieldInfo

All Implemented Interfaces:

Comparable<FieldInfo>
```
@BeanIgnore
public final class FieldInfo
extends Object
implements Comparable<FieldInfo>
```
Lightweight utility class for introspecting information about a field.

Constructor Summary

Constructors
Modifier Constructor and Description

protected FieldInfo(ClassInfo declaringClass, Field f)
Constructor.

Constructors
Modifier	Constructor and Description
`protected`	`FieldInfo(ClassInfo declaringClass, Field f)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldInfo`	`accessible()` Attempts to call `x.setAccessible(true)` and quietly ignores security exceptions.
`int`	`compareTo(FieldInfo o)`
`<T extends Annotation> T`	`getAnnotation(Class<T> a)` Returns the specified annotation on this field.
`<T extends Annotation> T`	`getAnnotation(Class<T> a, MetaProvider mp)` Returns the specified annotation on this field.
`ClassInfo`	`getDeclaringClass()` Returns metadata about the declaring class.
`String`	`getName()` Returns the name of this field.
`ClassInfo`	`getType()` Returns the type of this field.
`boolean`	`hasAnnotation(Class<? extends Annotation> a)` Returns true if the specified annotation is present.
`boolean`	`hasAnnotation(Class<? extends Annotation> a, MetaProvider mp)` Returns true if the specified annotation is present.
`boolean`	`hasName(String name)` Returns true if the field has the specified name.
`Field`	`inner()` Returns the wrapped field.
`Object`	`invoke(Object o)` Invokes this field on the specified object.
`boolean`	`isAll(ReflectFlags... flags)` Returns true if all specified flags are applicable to this field.
`boolean`	`isAny(ReflectFlags... flags)` Returns true if all specified flags are applicable to this field.
`boolean`	`isDeprecated()` Returns true if this field has the `@Deprecated` annotation on it.
`boolean`	`isNotDeprecated()` Returns true if this field doesn't have the `@Deprecated` annotation on it.
`boolean`	`isNotPublic()` Returns true if this field is not public.
`boolean`	`isNotStatic()` Returns true if this field is not static.
`boolean`	`isNotTransient()` Returns true if this field is not transient.
`boolean`	`isPublic()` Returns true if this field is public.
`boolean`	`isStatic()` Returns true if this field is static.
`boolean`	`isTransient()` Returns true if this field is transient.
`boolean`	`isVisible(Visibility v)` Identifies if the specified visibility matches this field.
`static FieldInfo`	`of(ClassInfo declaringClass, Field f)` Convenience method for instantiating a `FieldInfo`;
`static FieldInfo`	`of(Field f)` Convenience method for instantiating a `FieldInfo`;
`boolean`	`setAccessible()` Attempts to call `x.setAccessible(true)` and quietly ignores security exceptions.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FieldInfo
```
protected FieldInfo(ClassInfo declaringClass,
                    Field f)
```
    Constructor.
    
    Parameters:
    
    declaringClass - The class that declares this method.
    
    f - The field being wrapped.
- Method Detail
  - of
```
public static FieldInfo of(ClassInfo declaringClass,
                           Field f)
```
    Convenience method for instantiating a FieldInfo;
    
    Parameters:
    
    declaringClass - The class that declares this method.
    
    f - The field being wrapped.
    
    Returns:
    
    A new FieldInfo object, or null if the field was null.
  - of
```
public static FieldInfo of(Field f)
```
    Convenience method for instantiating a FieldInfo;
    
    Parameters:
    
    f - The field being wrapped.
    
    Returns:
    
    A new FieldInfo object, or null if the field was null.
  - inner
```
public Field inner()
```
    Returns the wrapped field.
    
    Returns:
    
    The wrapped field.
  - getDeclaringClass
```
public ClassInfo getDeclaringClass()
```
    Returns metadata about the declaring class.
    
    Returns:
    
    Metadata about the declaring class.
  - getAnnotation
```
public <T extends Annotation> T getAnnotation(Class<T> a)
```
    Returns the specified annotation on this field.
    
    Parameters:
    
    a - The annotation to look for.
    
    Returns:
    
    The annotation, or null if not found.
  - getAnnotation
```
public <T extends Annotation> T getAnnotation(Class<T> a,
                                              MetaProvider mp)
```
    Returns the specified annotation on this field.
    
    Parameters:
    
    a - The annotation to look for.
    
    mp - The meta provider for looking up annotations on reflection objects (classes, methods, fields, constructors).
    
    Returns:
    
    The annotation, or null if not found.
  - hasAnnotation
```
public boolean hasAnnotation(Class<? extends Annotation> a)
```
    Returns true if the specified annotation is present.
    
    Parameters:
    
    a - The annotation to check for.
    
    Returns:
    
    true if the specified annotation is present.
  - hasAnnotation
```
public boolean hasAnnotation(Class<? extends Annotation> a,
                             MetaProvider mp)
```
    Returns true if the specified annotation is present.
    
    Parameters:
    
    a - The annotation to check for.
    
    mp - The meta provider for looking up annotations on reflection objects (classes, methods, fields, constructors).
    
    Returns:
    
    true if the specified annotation is present.
  - isAll
```
public boolean isAll(ReflectFlags... flags)
```
    Returns true if all specified flags are applicable to this field.
    
    Parameters:
    
    flags - The flags to test for.
    
    Returns:
    
    true if all specified flags are applicable to this field.
  - isAny
```
public boolean isAny(ReflectFlags... flags)
```
    Returns true if all specified flags are applicable to this field.
    
    Parameters:
    
    flags - The flags to test for.
    
    Returns:
    
    true if all specified flags are applicable to this field.
  - isDeprecated
```
public boolean isDeprecated()
```
    Returns true if this field has the @Deprecated annotation on it.
    
    Returns:
    
    true if this field has the @Deprecated annotation on it.
  - isNotDeprecated
```
public boolean isNotDeprecated()
```
    Returns true if this field doesn't have the @Deprecated annotation on it.
    
    Returns:
    
    true if this field doesn't have the @Deprecated annotation on it.
  - isPublic
```
public boolean isPublic()
```
    Returns true if this field is public.
    
    Returns:
    
    true if this field is public.
  - isNotPublic
```
public boolean isNotPublic()
```
    Returns true if this field is not public.
    
    Returns:
    
    true if this field is not public.
  - isStatic
```
public boolean isStatic()
```
    Returns true if this field is static.
    
    Returns:
    
    true if this field is static.
  - isNotStatic
```
public boolean isNotStatic()
```
    Returns true if this field is not static.
    
    Returns:
    
    true if this field is not static.
  - isTransient
```
public boolean isTransient()
```
    Returns true if this field is transient.
    
    Returns:
    
    true if this field is transient.
  - isNotTransient
```
public boolean isNotTransient()
```
    Returns true if this field is not transient.
    
    Returns:
    
    true if this field is not transient.
  - hasName
```
public boolean hasName(String name)
```
    Returns true if the field has the specified name.
    
    Parameters:
    
    name - The name to compare against.
    
    Returns:
    
    true if the field has the specified name.
  - accessible
```
public FieldInfo accessible()
```
    Attempts to call x.setAccessible(true) and quietly ignores security exceptions.
    
    Returns:
    
    This object (for method chaining).
  - setAccessible
```
public boolean setAccessible()
```
    Attempts to call x.setAccessible(true) and quietly ignores security exceptions.
    
    Returns:
    
    true if call was successful.
  - isVisible
```
public boolean isVisible(Visibility v)
```
    Identifies if the specified visibility matches this field.
    
    Parameters:
    
    v - The visibility to validate against.
    
    Returns:
    
    true if this visibility matches the modifier attribute of this field.
  - getType
```
public ClassInfo getType()
```
    Returns the type of this field.
    
    Returns:
    
    The type of this field.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(FieldInfo o)
```
    Specified by:
    
    compareTo in interface Comparable<FieldInfo>
  - getName
```
public String getName()
```
    Returns the name of this field.
    
    Returns:
    
    The name of this field.
  - invoke
```
public Object invoke(Object o)
              throws IllegalArgumentException,
                     IllegalAccessException
```
    Invokes this field on the specified object.
    
    Parameters:
    
    o - The object containing the field.
    
    Returns:
    
    The field value.
    
    Throws:
    
    IllegalAccessException - Field was not accessible.
    
    IllegalArgumentException - Field does not belong to object.

Class FieldInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FieldInfo

Method Detail

of

of

inner

getDeclaringClass

getAnnotation

getAnnotation

hasAnnotation

hasAnnotation

isAll

isAny

isDeprecated

isNotDeprecated

isPublic

isNotPublic

isStatic

isNotStatic

isTransient

isNotTransient

hasName

accessible

setAccessible

isVisible

getType

toString

compareTo

getName

invoke