MappedFieldMetaData (NEBA core 5.2.3 API)

java.lang.Object
- io.neba.core.resourcemodels.metadata.MappedFieldMetaData

```
public class MappedFieldMetaData
extends Object
```
Represents meta-data of a mappable resource model field. Used to prevent the costly retrieval of this meta-data upon each resource to model mapping.

Author:

Olaf Otto

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MappedFieldMetaData.NebaDelegatingLazyLoadingProxy

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MappedFieldMetaData.NebaDelegatingLazyLoadingProxy`

Constructor Summary

Constructors
Constructor and Description

MappedFieldMetaData(Field field, Class<?> modelType)
Immediately extracts all metadata for the provided field.

Constructors
Constructor and Description
`MappedFieldMetaData(Field field, Class<?> modelType)` Immediately extracts all metadata for the provided field.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Annotations`	`getAnnotations()`
`String`	`getAppendPathOnReference()`
`Class<?>`	`getArrayTypeOfTypeParameter()`
`Field`	`getField()`
`Object`	`getLazyLoadingProxy(Callable<?> valueFactory)`
`ResourcePaths.ResourcePath`	`getPath()`
`String`	`getResolveBelowEveryChildPathOnChildren()`
`Class<?>`	`getType()`
`Class<?>`	`getTypeParameter()`
`int`	`hashCode()`
`boolean`	`isAppendPathPresentOnReference()`
`boolean`	`isChildrenAnnotationPresent()` Whether the field has a `Children` annotation.
`boolean`	`isCollectionType()` Whether the type of this field is assignable from `Collection`.
`boolean`	`isInstantiableCollectionType()`
`boolean`	`isLazy()`
`boolean`	`isPathAnnotationPresent()`
`boolean`	`isPropertyType()` Whether the type of this field can only be represented by a resource property (and not a resource).
`boolean`	`isReference()`
`boolean`	`isResolveBelowEveryChildPathPresentOnChildren()`
`boolean`	`isThisReference()`
`String`	`toString()`

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

- Constructor Detail
  - MappedFieldMetaData
```
public MappedFieldMetaData(Field field,
                           Class<?> modelType)
```
    Immediately extracts all metadata for the provided field.
    
    Parameters:
    
    field - must not be null.
- Method Detail
  - getLazyLoadingProxy
```
public Object getLazyLoadingProxy(Callable<?> valueFactory)
```
  - getField
```
public Field getField()
```
    Returns:
    
    The accessible Field represented by this meta data.
  - isReference
```
public boolean isReference()
```
    Returns:
    
    Whether this field is annotated with Reference.
  - isAppendPathPresentOnReference
```
public boolean isAppendPathPresentOnReference()
```
    Returns:
    
    Whether this field has a Reference annotation with a non-empty append path.
  - getAppendPathOnReference
```
public String getAppendPathOnReference()
```
    Returns:
    
    the append path of the Reference annotation, or null if either the annotation or the value for the append path are not present.
  - isThisReference
```
public boolean isThisReference()
```
    Returns:
    
    Whether this field is annotated with This.
  - getPath
```
public ResourcePaths.ResourcePath getPath()
```
    Returns:
    
    The path from which this field's value shall be mapped; may stem from the field name or a Path annotation.
  - getType
```
public Class<?> getType()
```
    Returns:
    
    the type the resolved value for the field shall have, which is either the field type, or the generic parameter type in case of lazy} fields.
  - isPathAnnotationPresent
```
public boolean isPathAnnotationPresent()
```
    Returns:
    
    Whether this field has a Path annotation.
  - isPropertyType
```
public boolean isPropertyType()
```
    Whether the type of this field can only be represented by a resource property (and not a resource).
  - isCollectionType
```
public boolean isCollectionType()
```
    Whether the type of this field is assignable from Collection.
  - isInstantiableCollectionType
```
public boolean isInstantiableCollectionType()
```
    Returns:
    
    whether this field is a collection type that can be instantiated.
  - isChildrenAnnotationPresent
```
public boolean isChildrenAnnotationPresent()
```
    Whether the field has a Children annotation.
  - isResolveBelowEveryChildPathPresentOnChildren
```
public boolean isResolveBelowEveryChildPathPresentOnChildren()
```
    Returns:
    
    whether a Children annotation is present with a non-empty Children.resolveBelowEveryChild() path.
  - getResolveBelowEveryChildPathOnChildren
```
public String getResolveBelowEveryChildPathOnChildren()
```
    Returns:
    
    the Children.resolveBelowEveryChild() path, or null if no such annotation or path exist.
  - getTypeParameter
```
public Class<?> getTypeParameter()
```
    Returns:
    
    The generic type of this field if it has a generic type declaration, such as List<MyModel> field; or Optional<MyModel> field;
  - getArrayTypeOfTypeParameter
```
public Class<?> getArrayTypeOfTypeParameter()
```
    Returns:
    
    the array type representation of the component type, or null if the component type is null.
  - getAnnotations
```
public Annotations getAnnotations()
```
    Returns:
    
    the annotations of the field, never null.
  - isLazy
```
public boolean isLazy()
```
    Returns:
    
    whether the field is of type Lazy.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MappedFieldMetaData

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MappedFieldMetaData

Method Detail

getLazyLoadingProxy

getField

isReference

isAppendPathPresentOnReference

getAppendPathOnReference

isThisReference

getPath

getType

isPathAnnotationPresent

isPropertyType

isCollectionType

isInstantiableCollectionType

isChildrenAnnotationPresent

isResolveBelowEveryChildPathPresentOnChildren

getResolveBelowEveryChildPathOnChildren

getTypeParameter

getArrayTypeOfTypeParameter

getAnnotations

isLazy

hashCode

equals

toString