CodableFieldInfo (Codec 3.3.0 API)

java.lang.Object
- com.addthis.codec.reflection.CodableFieldInfo

```
@Beta
public final class CodableFieldInfo
extends Object
```
information about a field in a class - expensive to get so runs and gets cached

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ARRAY`
`static int`	`CODABLE`
`static int`	`COLLECTION`
`static int`	`ENUM`
`static int`	`GENERIC`
`static int`	`MAP`
`static int`	`NATIVE`
`static int`	`NUMBER`
`static int`	`READONLY`
`static int`	`REQUIRED`
`static int`	`WRITEONLY`

Constructor Summary

Constructors
Constructor and Description

CodableFieldInfo(Field field)

Constructors
Constructor and Description
`CodableFieldInfo(Field field)`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`get(Object src)`
`Class<?>`	`getCollectionClass()`
`Field`	`getField()`
`Type[]`	`getGenericTypes()`
`Class<?>`	`getMapKeyClass()`
`Class<?>`	`getMapValueClass()`
`String`	`getName()`
`Class<?>`	`getTypeOrComponentType()`
`boolean`	`isArray()`
`boolean`	`isCodable()`
`boolean`	`isCollection()`
`boolean`	`isCollectionArray()`
`boolean`	`isEnum()`
`boolean`	`isGeneric()`
`boolean`	`isMap()`
`boolean`	`isMapKeyArray()`
`boolean`	`isMapValueArray()`
`boolean`	`isNative()`
`boolean`	`isReadOnly()`
`boolean`	`isRequired()`
`boolean`	`isWriteOnly()`
`Object`	`newInstance()`
`void`	`set(Object dst, Object value)`
`void`	`setStrict(Object dst, Object value)` Sets the field value for the destination object if and only if it is non-null and passes the field's validation method (if any).
`String`	`toString()`

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

Field Detail
- ARRAY
```
public static final int ARRAY
```
  See Also:
  Constant Field Values
- CODABLE
```
public static final int CODABLE
```
  See Also:
  Constant Field Values
- COLLECTION
```
public static final int COLLECTION
```
  See Also:
  Constant Field Values
- GENERIC
```
public static final int GENERIC
```
  See Also:
  Constant Field Values
- NATIVE
```
public static final int NATIVE
```
  See Also:
  Constant Field Values
- MAP
```
public static final int MAP
```
  See Also:
  Constant Field Values
- NUMBER
```
public static final int NUMBER
```
  See Also:
  Constant Field Values
- REQUIRED
```
public static final int REQUIRED
```
  See Also:
  Constant Field Values
- READONLY
```
public static final int READONLY
```
  See Also:
  Constant Field Values
- WRITEONLY
```
public static final int WRITEONLY
```
  See Also:
  Constant Field Values
- ENUM
```
public static final int ENUM
```
  See Also:
  Constant Field Values

Constructor Detail

CodableFieldInfo

public CodableFieldInfo(@Nonnull
                Field field)

Method Detail

getField
```
@Nonnull
public Field getField()
```

getName
```
public String getName()
```

getTypeOrComponentType

@Nonnull
public Class<?> getTypeOrComponentType()

getGenericTypes

@Nullable
public Type[] getGenericTypes()

newInstance

public Object newInstance()
                   throws Exception

Throws:: Exception

getCollectionClass

@Nullable
public Class<?> getCollectionClass()

getMapKeyClass

@Nullable
public Class<?> getMapKeyClass()

getMapValueClass

@Nullable
public Class<?> getMapValueClass()

isCollectionArray
```
public boolean isCollectionArray()
```

isMapKeyArray
```
public boolean isMapKeyArray()
```

isMapValueArray
```
public boolean isMapValueArray()
```

get
```
public Object get(Object src)
```

setStrict
```
public void setStrict(@Nonnull
             Object dst,
             @Nullable
             Object value)
               throws IllegalAccessException
```
Sets the field value for the destination object if and only if it is non-null and passes the field's validation method (if any). If the value is null and the field is marked as required, then an exception is thrown, otherwise the null value is ignored and the current value (if any) is kept.

Throws:

IllegalAccessException

set

public void set(@Nonnull
       Object dst,
       @Nullable
       Object value)

isArray
```
public boolean isArray()
```

isCodable
```
public boolean isCodable()
```

isCollection
```
public boolean isCollection()
```

isGeneric
```
public boolean isGeneric()
```

isMap
```
public boolean isMap()
```

isEnum
```
public boolean isEnum()
```

isNative
```
public boolean isNative()
```

isRequired
```
public boolean isRequired()
```

isReadOnly
```
public boolean isReadOnly()
```

isWriteOnly
```
public boolean isWriteOnly()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

Class CodableFieldInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ARRAY

CODABLE

COLLECTION

GENERIC

NATIVE

MAP

NUMBER

REQUIRED

READONLY

WRITEONLY

ENUM

Constructor Detail

CodableFieldInfo

Method Detail

getField

getName

getTypeOrComponentType

getGenericTypes

newInstance

getCollectionClass

getMapKeyClass

getMapValueClass

isCollectionArray

isMapKeyArray

isMapValueArray

get

setStrict

set

isArray

isCodable

isCollection

isGeneric

isMap

isEnum

isNative

isRequired

isReadOnly

isWriteOnly

toString