Package com.evolveum.midpoint.prism.deleg

Interface ContainerDefinitionDelegator<C extends Containerable>

All Superinterfaces:

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

All Known Subinterfaces:

AttributeContainerDefinitionDelegator, ObjectDefinitionDelegator<O>

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)	TODO
default PrismContainerDefinition<C>	cloneWithReplacedDefinition(QName itemName, ItemDefinition<?> newDefinition)	TODO
default @NotNull ContainerDelta<C>	createEmptyDelta(ItemPath path)	Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.
default PrismContainerValue<C>	createValue()	TODO
PrismContainerDefinition<C>	delegate()
default <C extends Containerable> PrismContainerDefinition<C>	findContainerDefinition(@NotNull ItemPath path)	Returns PrismContainerDefinition corresponding to given path (rooted at this store).
default <T extends ItemDefinition<?>> T	findItemDefinition(@NotNull ItemPath path, @NotNull Class<T> clazz)	Used to find a matching item definition _within_ this definition.
default Class<C>	getCompileTimeClass()	Static (compile-time) class holding the container values.
default ComplexTypeDefinition	getComplexTypeDefinition()	Definition of the container values.
default @NotNull List<? extends ItemDefinition<?>>	getDefinitions()	Returns a list of item definitions in this container.
default Collection<ItemName>	getItemNames()	Returns names of items that are defined within this container definition.
default List<PrismPropertyDefinition<?>>	getPropertyDefinitions()	Returns set of property definitions.
default Class<C>	getTypeClass()	Returns a compile-time class that is used to represent items.
default boolean	isEmpty()	TODO
default void	replaceDefinition(QName itemName, ItemDefinition<?> newDefinition)	TODO
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, getAnnotations, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getPrismContext, getProcessing, getRemovedSince, getSchemaMigrations, getSchemaRegistry, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRemoved, isRuntimeSchema, setAnnotation

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

checkImmutable, checkMutable, freeze, isImmutable

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

isMandatory, isMultiValue, isOptional, isSingleValue

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

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

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

containsItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition, findReferenceDefinition

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

clone, getAlwaysUseForEquals, isAlwaysUseForEquals, isCompletelyDefined, toMutable

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

revive

Method Details

delegate

PrismContainerDefinition<C> delegate()

Specified by:

delegate in interface DefinitionDelegator

Specified by:

delegate in interface ItemDefinitionDelegator<C extends Containerable>

getCompileTimeClass

default Class<C> getCompileTimeClass()

Description copied from interface: PrismContainerDefinition

Static (compile-time) class holding the container values. May be null. (Let's not mark it as @Nullable to avoid lots of warnings.)

Specified by:

getCompileTimeClass in interface PrismContainerDefinition<C extends Containerable>

getComplexTypeDefinition

default ComplexTypeDefinition getComplexTypeDefinition()

Description copied from interface: PrismContainerDefinition

Definition of the container values. May be null. (Let's not mark it as @Nullable to avoid lots of warnings.) Note that individual values can hold their own (more specific) complex type definitions.

Specified by:

getComplexTypeDefinition in interface PrismContainerDefinition<C extends Containerable>

getDefinitions

@NotNull
default @NotNull List<? extends ItemDefinition<?>> getDefinitions()

Description copied from interface: PrismContainerDefinition

Returns a list of item definitions in this container. It is intentionally a List because it is ordered. (To provide standard format for serialization.) Usually obtained from ComplexTypeDefinition. So please do not modify the content of the list!

Specified by:

getDefinitions in interface LocalItemDefinitionStore

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>

getPropertyDefinitions

default List<PrismPropertyDefinition<?>> getPropertyDefinitions()

Description copied from interface: PrismContainerDefinition

Returns set of property definitions. The set contains all property definitions of all types that were parsed. Order of definitions is insignificant. The returned set is immutable! All changes may be lost.

Specified by:

getPropertyDefinitions in interface PrismContainerDefinition<C extends Containerable>

Returns:

set of definitions

findItemDefinition

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

Description copied from interface: ItemDefinition

Used to find a matching item definition _within_ this definition. Treats e.g. de-referencing in prism references.

Specified by:

findItemDefinition in interface ItemDefinition<C extends Containerable>

Specified by:

findItemDefinition in interface ItemDefinitionDelegator<C extends Containerable>

Specified by:

findItemDefinition in interface LocalItemDefinitionStore

cloneWithReplacedDefinition

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

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

cloneWithReplacedDefinition in interface PrismContainerDefinition<C extends Containerable>

replaceDefinition

default void replaceDefinition(QName itemName,
 ItemDefinition<?> newDefinition)

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

replaceDefinition in interface PrismContainerDefinition<C extends Containerable>

createValue

default PrismContainerValue<C> createValue()

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

createValue in interface PrismContainerDefinition<C extends Containerable>

isEmpty

default boolean isEmpty()

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

isEmpty in interface PrismContainerDefinition<C extends Containerable>

canRepresent

default boolean canRepresent(@NotNull
 @NotNull QName type)

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

canRepresent in interface PrismContainerDefinition<C extends Containerable>

findContainerDefinition

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

Description copied from interface: LocalItemDefinitionStore

Returns PrismContainerDefinition corresponding to given path (rooted at this store). Tries the global resolution in the case of "any" content.

Specified by:

findContainerDefinition in interface LocalItemDefinitionStore

createEmptyDelta

@NotNull
default @NotNull ContainerDelta<C> createEmptyDelta(ItemPath path)

Description copied from interface: ItemDefinition

Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given 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, subclasses 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>