Annotation Type PofExtractor
-
@Inherited @ExtractorBinding @Documented @Retention(RUNTIME) @Repeatable(Extractors.class) public @interface PofExtractor
AExtractorBinding
annotation representing aPofExtractor
.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 casetype()
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 usingPortableTypeGenerator
(typically viapof-maven-plugin
).Either
index()
orpath()
must be specified within this annotation in order for it to be valid.- Since:
- 3.0
- Author:
- Gunnar Hillert
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element 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.
-
-
-
-
path
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 usingPortableTypeGenerator
.- Returns:
- a property path to use to extract the value
- Default:
- ""
-
-