Package com.evolveum.midpoint.prism.deleg

Interface ContainerDefinitionDelegator<C extends Containerable>

All Superinterfaces:

Cloneable, DebugDumpable, Definition, DefinitionDelegator, Freezable, ItemDefinition<PrismContainer<C>>, ItemDefinitionDelegator<PrismContainer<C>>, LocalDefinitionStore, PrismContainerDefinition<C>, PrismContextSensitive, PrismItemAccessDefinition, Revivable, Serializable, SmartVisitable<Definition>, Visitable<Definition>

All Known Subinterfaces:

AttributeContainerDefinitionDelegator, ObjectDefinitionDelegator<O>

All Known Implementing Classes:

TransformableContainerDefinition, TransformableContainerDefinition.AttributeContainer, TransformableObjectDefinition

public interface ContainerDefinitionDelegator<C extends Containerable>
extends ItemDefinitionDelegator<PrismContainer<C>>, PrismContainerDefinition<C>

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition

PrismItemAccessDefinition.Mutable

Field Summary

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default boolean	canRepresent(@NotNull QName type)
default PrismContainerDefinition<C>	cloneWithReplacedDefinition(QName itemName, ItemDefinition newDefinition)
default ContainerDelta<C>	createEmptyDelta(ItemPath path)
default PrismContainerValue<C>	createValue()
PrismContainerDefinition<C>	delegate()
default <C extends Containerable> PrismContainerDefinition<C>	findContainerDefinition(@NotNull ItemPath path)
default <C extends Containerable> PrismContainerDefinition<C>	findContainerDefinition(@NotNull String name)
default <ID extends ItemDefinition> ID	findItemDefinition(@NotNull ItemPath path)
default <T extends ItemDefinition> T	findItemDefinition(@NotNull ItemPath path, @NotNull Class<T> clazz)
default <ID extends ItemDefinition> ID	findLocalItemDefinition(@NotNull QName name)
default <ID extends ItemDefinition> ID	findLocalItemDefinition(@NotNull QName name, @NotNull Class<ID> clazz, boolean caseInsensitive)
default <ID extends ItemDefinition> ID	findNamedItemDefinition(@NotNull QName firstName, @NotNull ItemPath rest, @NotNull Class<ID> clazz)
default <T> PrismPropertyDefinition<T>	findPropertyDefinition(@NotNull ItemPath path)
default PrismReferenceDefinition	findReferenceDefinition(@NotNull ItemName name)
default PrismReferenceDefinition	findReferenceDefinition(@NotNull ItemPath path)
default Class<C>	getCompileTimeClass()
default ComplexTypeDefinition	getComplexTypeDefinition()
default String	getDefaultNamespace()
default List<? extends ItemDefinition>	getDefinitions()
default List<String>	getIgnoredNamespaces()
default Collection<ItemName>	getItemNames()	Returns names of items that are defined within this container definition.
default List<PrismPropertyDefinition>	getPropertyDefinitions()
default Class<C>	getTypeClass()	Returns a compile-time class that is used to represent items.
default boolean	isCompletelyDefined()	Returns true if the instantiated container can contain only items that are explicitly defined here.
default boolean	isEmpty()
default void	replaceDefinition(QName itemName, ItemDefinition newDefinition)
default Optional<ComplexTypeDefinition>	structuredType()	Returns complex type definition of item, if underlying value is possible structured.

Methods inherited from interface com.evolveum.midpoint.prism.deleg.DefinitionDelegator

accept, accept, debugDump, debugDump, debugDump, debugDumpLazily, debugDumpLazily, getAnnotation, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getPrismContext, getProcessing, getSchemaMigrations, getSchemaRegistry, getTypeClassIfKnown, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRuntimeSchema, setAnnotation

Methods inherited from interface com.evolveum.midpoint.prism.Freezable

checkImmutable, checkMutable, freeze, isImmutable

Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition

isMultiValue, isSingleValue, revive

Methods inherited from interface com.evolveum.midpoint.prism.deleg.ItemDefinitionDelegator

adoptElementDefinitionFrom, canAdd, canBeDefinitionOf, canBeDefinitionOf, canModify, canRead, debugDumpShortToString, deepClone, deepClone, getDiagrams, getItemName, getMaxOccurs, getMinOccurs, getNamespace, getSubstitutionHead, getValueEnumerationRef, instantiate, instantiate, isDynamic, isHeterogeneousListItem, isIndexOnly, isInherited, isMandatory, isOperational, isOptional, isValidFor, isValidFor

Methods inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition

clone, toMutable

Method Detail

delegate

PrismContainerDefinition<C> delegate()

Specified by:

delegate in interface DefinitionDelegator

Specified by:

delegate in interface ItemDefinitionDelegator<C extends Containerable>

getCompileTimeClass

default Class<C> getCompileTimeClass()

Specified by:

getCompileTimeClass in interface PrismContainerDefinition<C extends Containerable>

getComplexTypeDefinition

default ComplexTypeDefinition getComplexTypeDefinition()

Specified by:

getComplexTypeDefinition in interface PrismContainerDefinition<C extends Containerable>

getDefaultNamespace

default String getDefaultNamespace()

Specified by:

getDefaultNamespace in interface PrismContainerDefinition<C extends Containerable>

getIgnoredNamespaces

default List<String> getIgnoredNamespaces()

Specified by:

getIgnoredNamespaces in interface PrismContainerDefinition<C extends Containerable>

getDefinitions

default List<? extends ItemDefinition> getDefinitions()

Specified by:

getDefinitions in interface PrismContainerDefinition<C extends Containerable>

getItemNames

default Collection<ItemName> getItemNames()

Description copied from interface: PrismContainerDefinition

Returns names of items that are defined within this container definition. They do NOT include items that can be put into instantiated container by means of "xsd:any" mechanism.

Specified by:

getItemNames in interface PrismContainerDefinition<C extends Containerable>

findLocalItemDefinition

default <ID extends ItemDefinition> ID findLocalItemDefinition(@NotNull
                                                               @NotNull QName name,
                                                               @NotNull
                                                               @NotNull Class<ID> clazz,
                                                               boolean caseInsensitive)

Specified by:

findLocalItemDefinition in interface LocalDefinitionStore

findLocalItemDefinition

default <ID extends ItemDefinition> ID findLocalItemDefinition(@NotNull
                                                               @NotNull QName name)

Specified by:

findLocalItemDefinition in interface LocalDefinitionStore

isCompletelyDefined

default boolean isCompletelyDefined()

Description copied from interface: PrismContainerDefinition

Returns true if the instantiated container can contain only items that are explicitly defined here.

Specified by:

isCompletelyDefined in interface PrismContainerDefinition<C extends Containerable>

getPropertyDefinitions

default List<PrismPropertyDefinition> getPropertyDefinitions()

Specified by:

getPropertyDefinitions in interface PrismContainerDefinition<C extends Containerable>

findItemDefinition

default <ID extends ItemDefinition> ID findItemDefinition(@NotNull
                                                          @NotNull ItemPath path)

Specified by:

findItemDefinition in interface LocalDefinitionStore

findReferenceDefinition

default PrismReferenceDefinition findReferenceDefinition(@NotNull
                                                         @NotNull ItemName name)

Specified by:

findReferenceDefinition in interface LocalDefinitionStore

findItemDefinition

default <T extends ItemDefinition> T findItemDefinition(@NotNull
                                                        @NotNull ItemPath path,
                                                        @NotNull
                                                        @NotNull Class<T> clazz)

Specified by:

findItemDefinition in interface ItemDefinition<C extends Containerable>

Specified by:

findItemDefinition in interface ItemDefinitionDelegator<C extends Containerable>

Specified by:

findItemDefinition in interface LocalDefinitionStore

cloneWithReplacedDefinition

default PrismContainerDefinition<C> cloneWithReplacedDefinition(QName itemName,
                                                                ItemDefinition newDefinition)

Specified by:

cloneWithReplacedDefinition in interface PrismContainerDefinition<C extends Containerable>

replaceDefinition

default void replaceDefinition(QName itemName,
                               ItemDefinition newDefinition)

Specified by:

replaceDefinition in interface PrismContainerDefinition<C extends Containerable>

createValue

default PrismContainerValue<C> createValue()

Specified by:

createValue in interface PrismContainerDefinition<C extends Containerable>

findContainerDefinition

default <C extends Containerable> PrismContainerDefinition<C> findContainerDefinition(@NotNull
                                                                                      @NotNull String name)

Specified by:

findContainerDefinition in interface LocalDefinitionStore

isEmpty

default boolean isEmpty()

Specified by:

isEmpty in interface PrismContainerDefinition<C extends Containerable>

canRepresent

default boolean canRepresent(@NotNull
                             @NotNull QName type)

Specified by:

canRepresent in interface PrismContainerDefinition<C extends Containerable>

findNamedItemDefinition

default <ID extends ItemDefinition> ID findNamedItemDefinition(@NotNull
                                                               @NotNull QName firstName,
                                                               @NotNull
                                                               @NotNull ItemPath rest,
                                                               @NotNull
                                                               @NotNull Class<ID> clazz)

Specified by:

findNamedItemDefinition in interface LocalDefinitionStore

findPropertyDefinition

default <T> PrismPropertyDefinition<T> findPropertyDefinition(@NotNull
                                                              @NotNull ItemPath path)

Specified by:

findPropertyDefinition in interface LocalDefinitionStore

findReferenceDefinition

default PrismReferenceDefinition findReferenceDefinition(@NotNull
                                                         @NotNull ItemPath path)

Specified by:

findReferenceDefinition in interface LocalDefinitionStore

findContainerDefinition

default <C extends Containerable> PrismContainerDefinition<C> findContainerDefinition(@NotNull
                                                                                      @NotNull ItemPath path)

Specified by:

findContainerDefinition in interface LocalDefinitionStore

createEmptyDelta

default ContainerDelta<C> createEmptyDelta(ItemPath path)

Specified by:

createEmptyDelta in interface ItemDefinition<C extends Containerable>

Specified by:

createEmptyDelta in interface ItemDefinitionDelegator<C extends Containerable>

Specified by:

createEmptyDelta in interface PrismContainerDefinition<C extends Containerable>

getTypeClass

default Class<C> getTypeClass()

Description copied from interface: Definition

Returns a compile-time class that is used to represent items. E.g. returns String, Integer, sublcasses of Objectable and Containerable and so on.

Specified by:

getTypeClass in interface Definition

Specified by:

getTypeClass in interface DefinitionDelegator

Specified by:

getTypeClass in interface PrismContainerDefinition<C extends Containerable>

structuredType

default Optional<ComplexTypeDefinition> structuredType()

Description copied from interface: ItemDefinition

Returns complex type definition of item, if underlying value is possible structured. NOTE: This seems weird, since properties and references are simple values, but actually object reference is serialized as structured value and some of properties are also.

Specified by:

structuredType in interface ItemDefinition<C extends Containerable>

Specified by:

structuredType in interface ItemDefinitionDelegator<C extends Containerable>

Specified by:

structuredType in interface PrismContainerDefinition<C extends Containerable>

Returns: