io.neba.api.spi

Interface AnnotatedFieldMapper.OngoingMapping<FieldType,AnnotationType>

Type Parameters:

FieldType - the field type

AnnotationType - the type

Enclosing interface:

AnnotatedFieldMapper<FieldType,AnnotationType extends Annotation>

public static interface AnnotatedFieldMapper.OngoingMapping<FieldType,AnnotationType>

Represents the contextual data of a field mapping during a resource to model mapping.

Author:

Olaf Otto

Method Summary

Modifier and Type	Method and Description
AnnotationType	getAnnotation()
Map<Class<? extends Annotation>,Annotation>	getAnnotationsOfField()
Field	getField()
Class<?>	getFieldType()
Class<?>	getFieldTypeParameter()
Object	getModel()
org.apache.sling.api.resource.ValueMap	getProperties()
String	getRepositoryPath()
FieldType	getResolvedValue()
org.apache.sling.api.resource.Resource	getResource()

Method Detail

getResolvedValue

@CheckForNull
FieldType getResolvedValue()

Returns:

The currently resolved value of the field, or null if no value could be resolved for the field. This value has not been set to the field at this point.

getAnnotation

@Nonnull
AnnotationType getAnnotation()

Returns:

The instance of the annotation this mapper is registered for. Never null.

getModel

@Nonnull
Object getModel()

Returns:

The mapped model. At this point, the mapping is still incomplete and no post-processors have been invoked on the model. Never null.

getField

@Nonnull
Field getField()

Returns:

the mapped field. Never null. The field's value was not changed at this point, i.e. it is likely to deviate from getResolvedValue(). Note: do not rely on this field's type but use the provided field type instead, as these types may be different, for instance in case of Lazy fields.

getAnnotationsOfField

@Nonnull
Map<Class<? extends Annotation>,Annotation> getAnnotationsOfField()

Returns:

All annotations (including meta-annotations, i.e. annotations of annotations) present on the field. Never null.

getFieldType

@Nonnull
Class<?> getFieldType()

Returns:

The mapped type of the field. Note: In case the field is Lazy, this type is the component type, i.e. the type targeted by the optional field. However, field mappers are not applied optional fields but to the subsequent mapping, when the lazy value is actually mapped. Never null.

getFieldTypeParameter

@CheckForNull
Class<?> getFieldTypeParameter()

Returns:

the generic type parameter of the field type, or null if no such parameter exists.

getRepositoryPath

@Nonnull
String getRepositoryPath()

Returns:

the repository path that shall be resolved to the field's value, as determined by the field name or path annotation. Placeholders in the path are resolved at this point. Never null.

getResource

@Nonnull
org.apache.sling.api.resource.Resource getResource()

Returns:

The resource that is mapped to the model. Never null, but may be a synthetic resource.

getProperties

@CheckForNull
org.apache.sling.api.resource.ValueMap getProperties()

Returns:

The ValueMap representation of the resource. This value map does support primitive types, e.g. int. May be null if the resource has no properties, e.g. if it is synthetic.