Package com.evolveum.midpoint.prism.schema

Interface DefinitionFeature<V,DB,XC,SD>

Type Parameters:

V - type for value of the feature (Boolean, String, or more complex type)

DB - definition builder (or mutable definition) object to which it's applicable when parsing

XC - source XSOM object that this feature can be parsed from; Object means XSComponent or XSAnnotation

SD - serializable definition object to which it's applicable when serializing

All Known Implementing Classes:

AnnotationBasedFeature, DefinitionFeature.DefaultImpl

public interface DefinitionFeature<V,DB,XC,SD>

An identifiable feature of a item or type definition. Currently, it supports parsing and sometimes also serialization. For parsing, it knows: . How to be parsed from XSOM (via DefinitionFeatureParser). . How to be applied to the definition object or builder (via setterMethod()). For serialization: . How to be taken from the definition (via DefinitionFeature.DefaultImpl.getterMethod) . How to be put into XSD DOM (via serializer()). Work in progress.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DefinitionFeature.DefaultImpl<V,DB,XC,SD>

Method Summary

Modifier and Type	Method	Description
default <DB2> DefinitionFeature<V,DB2,XC,SD>	asForBuilder(Class<DB2> builderClass)	Used when we know that the feature will be applicable to given builder class, e.g., when passing as "extra feature" like in ComplexTypeDefinition.ComplexTypeDefinitionLikeBuilder.getExtraFeaturesToParse().
@NotNull Class<DB>	definitionBuilderType()
static <V, DB, XC, SD> DefinitionFeature<V,DB,XC,SD>	of(@NotNull Class<V> valueType, @NotNull Class<DB> setterInterface, @NotNull BiConsumer<DB,V> setterMethod, @NotNull DefinitionFeatureParser<V,XC> processor)
static <V, DB, XC, SD> DefinitionFeature<V,DB,XC,SD>	of(@NotNull Class<V> valueType, @NotNull Class<DB> setterInterface, @NotNull BiConsumer<DB,V> setterMethod, @NotNull DefinitionFeatureParser<V,XC> parser, @NotNull Class<SD> serializableDefinitionType, @NotNull Function<SD,V> getterMethod, @NotNull DefinitionFeatureSerializer<V> serializer)
V	parse(DB target, XC source)	Obtains the value from `source` (e.g.
default V	parseIfApplicable(DB target, XC source)
void	serialize(@NotNull SerializableDefinition source, @NotNull DefinitionFeatureSerializer.SerializationTarget target)	Obtains the value from `source` definition and serializes it into `target` (e.g.
DefinitionFeatureSerializer<V>	serializer()
default void	set(DB target, V value)
default boolean	settableOn(@NotNull Object target)
@NotNull BiConsumer<DB,V>	setterMethod()
@NotNull Class<V>	valueType()
@NotNull DefinitionFeatureParser<V,XC>	xsomParser()

Method Details

of

static <V,
DB,
XC,
SD> DefinitionFeature<V,DB,XC,SD> of(@NotNull
 @NotNull Class<V> valueType,
 @NotNull
 @NotNull Class<DB> setterInterface,
 @NotNull
 @NotNull BiConsumer<DB,V> setterMethod,
 @NotNull
 @NotNull DefinitionFeatureParser<V,XC> processor)

of

static <V,
DB,
XC,
SD> DefinitionFeature<V,DB,XC,SD> of(@NotNull
 @NotNull Class<V> valueType,
 @NotNull
 @NotNull Class<DB> setterInterface,
 @NotNull
 @NotNull BiConsumer<DB,V> setterMethod,
 @NotNull
 @NotNull DefinitionFeatureParser<V,XC> parser,
 @NotNull
 @NotNull Class<SD> serializableDefinitionType,
 @NotNull
 @NotNull Function<SD,V> getterMethod,
 @NotNull
 @NotNull DefinitionFeatureSerializer<V> serializer)

valueType

@NotNull
@NotNull Class<V> valueType()

definitionBuilderType

@NotNull
@NotNull Class<DB> definitionBuilderType()

setterMethod

@NotNull
@NotNull BiConsumer<DB,V> setterMethod()

xsomParser

@NotNull
@NotNull DefinitionFeatureParser<V,XC> xsomParser()

serializer

DefinitionFeatureSerializer<V> serializer()

settableOn

default boolean settableOn(@NotNull
 @NotNull Object target)

set

default void set(@NotNull
 DB target,
 V value)

parseIfApplicable

default V parseIfApplicable(DB target,
 XC source)
                     throws SchemaException

Throws:

SchemaException

parse

V parse(@NotNull
 DB target,
 @Nullable
 XC source)
 throws SchemaException

Obtains the value from `source` (e.g. XSOM component) and sets it to `target` definition builder.

Throws:

SchemaException

serialize

void serialize(@NotNull
 @NotNull SerializableDefinition source,
 @NotNull
 @NotNull DefinitionFeatureSerializer.SerializationTarget target)

Obtains the value from `source` definition and serializes it into `target` (e.g. DOM element in XSD).

asForBuilder

default <DB2> DefinitionFeature<V,DB2,XC,SD> asForBuilder(Class<DB2> builderClass)

Used when we know that the feature will be applicable to given builder class, e.g., when passing as "extra feature" like in ComplexTypeDefinition.ComplexTypeDefinitionLikeBuilder.getExtraFeaturesToParse().