io.micronaut.coherence.annotation

Annotation Type PofExtractor

@Inherited
 @ExtractorBinding
 @Documented
 @Retention(value=RUNTIME)
 @Repeatable(value=PofExtractor.Extractors.class)
public @interface PofExtractor

A ExtractorBinding annotation representing a com.tangosol.util.extractor.PofExtractor.

This annotation can be used to define an extractor that extracts and attribute from a POF stream based on an array of integer property indices, in which case the type is optional, or a property path based on serialized field names concatenated using period (ie. address.city, in which case type() attribute must be set as well.

The latter approach can only be used if the specified type is annotated with a @PortableType annotation and has been instrumented using com.tangosol.io.pof.generator.PortableTypeGenerator (typically via pof-maven-plugin).

Either index() or path() must be specified within this annotation in order for it to be valid.

Since:

1.0

Author:

Jonathan Knight

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int[]	index Returns an array of POF indexes to use to extract the value.
java.lang.String	path Returns a property path to use to extract the value.
java.lang.Class<?>	type Returns the root type to extract property from.

Element Detail

index

public abstract int[] index

Returns an array of POF indexes to use to extract the value.

Returns:

an array of POF indexes to use to extract the value

Default:

{}

path

public abstract java.lang.String path

Returns a property path to use to extract the value.

This attribute can only be used in combination with the type() attribute, and only if the specified type is annotated with a @PortableType annotation and instrumented using com.tangosol.io.pof.generator.PortableTypeGenerator.

Returns:

a property path to use to extract the value

Default:

""

type

public abstract java.lang.Class<?> type

Returns the root type to extract property from.

Returns:

the root type to extract property from

Default:

java.lang.Object.class