Package com.evolveum.midpoint.prism

Interface PrismContainerDefinition<C extends Containerable>

All Superinterfaces:

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

All Known Subinterfaces:

AttributeContainerDefinitionDelegator, ContainerDefinitionDelegator<C>, MutablePrismContainerDefinition<C>, MutablePrismObjectDefinition<O>, ObjectDefinitionDelegator<O>, PrismObjectDefinition<O>, ResourceAttributeContainerDefinition

All Known Implementing Classes:

com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl, ResourceAttributeContainerDefinitionImpl

public interface PrismContainerDefinition<C extends Containerable>
extends ItemDefinition<PrismContainer<C>>, LocalDefinitionStore

TODO

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
boolean	canRepresent(@NotNull QName type)
@NotNull PrismContainerDefinition<C>	clone()
PrismContainerDefinition<C>	cloneWithReplacedDefinition(QName itemName, ItemDefinition newDefinition)
ContainerDelta<C>	createEmptyDelta(ItemPath path)
PrismContainerValue<C>	createValue()
Class<C>	getCompileTimeClass()
ComplexTypeDefinition	getComplexTypeDefinition()
String	getDefaultNamespace()
List<? extends ItemDefinition>	getDefinitions()
List<String>	getIgnoredNamespaces()
default Collection<ItemName>	getItemNames()	Returns names of items that are defined within this container definition.
List<PrismPropertyDefinition>	getPropertyDefinitions()
Class<C>	getTypeClass()	Returns a compile-time class that is used to represent items.
boolean	isCompletelyDefined()	Returns true if the instantiated container can contain only items that are explicitly defined here.
boolean	isEmpty()
void	replaceDefinition(QName itemName, ItemDefinition newDefinition)
default Optional<ComplexTypeDefinition>	structuredType()	Returns complex type definition of item, if underlying value is possible structured.
MutablePrismContainerDefinition<C>	toMutable()

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

debugDump, getAnnotation, getDeprecatedSince, getDiagrams, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, 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

adoptElementDefinitionFrom, canBeDefinitionOf, canBeDefinitionOf, debugDumpShortToString, deepClone, deepClone, findItemDefinition, getItemName, getMaxOccurs, getMinOccurs, getNamespace, getSubstitutionHead, getValueEnumerationRef, instantiate, instantiate, isDynamic, isHeterogeneousListItem, isIndexOnly, isInherited, isMandatory, isMultiValue, isOperational, isOptional, isSingleValue, isValidFor, isValidFor, revive

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

findContainerDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findNamedItemDefinition, findPropertyDefinition, findReferenceDefinition, findReferenceDefinition

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

getPrismContext

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

canAdd, canModify, canRead

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

accept

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

accept

Method Detail

getCompileTimeClass

Class<C> getCompileTimeClass()

getComplexTypeDefinition

ComplexTypeDefinition getComplexTypeDefinition()

getDefaultNamespace

String getDefaultNamespace()

getIgnoredNamespaces

List<String> getIgnoredNamespaces()

getDefinitions

List<? extends ItemDefinition> getDefinitions()

getItemNames

default Collection<ItemName> getItemNames()

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.

isCompletelyDefined

boolean isCompletelyDefined()

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

getPropertyDefinitions

List<PrismPropertyDefinition> getPropertyDefinitions()

createEmptyDelta

ContainerDelta<C> createEmptyDelta(ItemPath path)

Specified by:

createEmptyDelta in interface ItemDefinition<C extends Containerable>

clone

@NotNull
@NotNull PrismContainerDefinition<C> clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<C extends Containerable>

cloneWithReplacedDefinition

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

replaceDefinition

void replaceDefinition(QName itemName,
                       ItemDefinition newDefinition)

createValue

PrismContainerValue<C> createValue()

isEmpty

boolean isEmpty()

canRepresent

boolean canRepresent(@NotNull
                     @NotNull QName type)

toMutable

MutablePrismContainerDefinition<C> toMutable()

Specified by:

toMutable in interface Definition

Specified by:

toMutable in interface ItemDefinition<C extends Containerable>

getTypeClass

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

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>

Returns: