Package com.evolveum.midpoint.prism
Interface PrismContainerDefinition<C extends Containerable>
- All Superinterfaces:
Cloneable
,DebugDumpable
,Definition
,Freezable
,ItemDefinition<PrismContainer<C>>
,LocalItemDefinitionStore
,PrismContextSensitive
,PrismItemAccessDefinition
,Revivable
,Serializable
,SmartVisitable<Definition>
,Visitable<Definition>
- All Known Subinterfaces:
AttributeContainerDefinitionDelegator
,ContainerDefinitionDelegator<C>
,MutablePrismContainerDefinition<C>
,MutablePrismObjectDefinition<O>
,ObjectDefinitionDelegator<O>
,PrismContainerWrapper<C>
,PrismObjectDefinition<O>
,PrismObjectWrapper<O>
,ResourceAttributeContainerDefinition
,ShadowWrapper
- All Known Implementing Classes:
AssignmentHolderWrapper
,AuthenticationBehaviorWrapper
,CaseWorkItemTypeWrapper
,com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl
,PrismContainerWrapperImpl
,PrismObjectWrapperImpl
,ProfilingClassLoggerContainerWrapperImpl
,ResourceAttributeContainerDefinitionImpl
,ResourceAttributeMappingWrapper
,ResourceWrapper
,ShadowAssociationWrapperImpl
,ShadowWrapperImpl
,ValueMetadataWrapperImpl
public interface PrismContainerDefinition<C extends Containerable>
extends ItemDefinition<PrismContainer<C>>, LocalItemDefinitionStore
Definition of a prism container.
Note: a lot is delegated to a
ComplexTypeDefinition
.-
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 TypeMethodDescriptionboolean
canRepresent
(@NotNull QName type) TODO@NotNull PrismContainerDefinition<C>
clone()
cloneWithReplacedDefinition
(QName itemName, ItemDefinition<?> newDefinition) TODO@NotNull ContainerDelta<C>
createEmptyDelta
(ItemPath path) Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.TODOdefault Collection<QName>
Returns list of items which should be always used for equals, even if they are operational, and equivalence strategy does not consider operational data.Static (compile-time) class holding the container values.Definition of the container values.@NotNull List<? extends ItemDefinition<?>>
Returns a list of item definitions in this container.default Collection<ItemName>
Returns names of items that are defined within this container definition.Returns set of property definitions.Returns a compile-time class that is used to represent items.default boolean
isAlwaysUseForEquals
(QName name) Returns true, if item is explicitly specified mentioned to be used for equalsdefault boolean
Returns true if the instantiated container can contain only items that are explicitly defined here.boolean
isEmpty()
TODOvoid
replaceDefinition
(QName itemName, ItemDefinition<?> newDefinition) TODOdefault Optional<ComplexTypeDefinition>
Returns complex type definition of item, if underlying value is possible structured.Returns an interface to mutate this definition.Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable
debugDump, debugDump, debugDumpLazily, debugDumpLazily
Methods inherited from interface com.evolveum.midpoint.prism.Definition
debugDump, getAnnotation, getAnnotations, getDeprecatedSince, getDiagrams, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, 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
adoptElementDefinitionFrom, canBeDefinitionOf, canBeDefinitionOf, debugDumpShortToString, deepClone, findItemDefinition, getItemName, getMaxOccurs, getMinOccurs, getSubstitutionHead, getValueEnumerationRef, instantiate, instantiate, isDynamic, isHeterogeneousListItem, isIndexOnly, isInherited, isMandatory, isMultiValue, isOperational, isOptional, isSearchable, isSingleValue, isValidFor
Methods inherited from interface com.evolveum.midpoint.prism.LocalItemDefinitionStore
containsItemDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition, 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
-
Method Details
-
getCompileTimeClass
Static (compile-time) class holding the container values. May be null. (Let's not mark it as @Nullable to avoid lots of warnings.) -
getComplexTypeDefinition
ComplexTypeDefinition getComplexTypeDefinition()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. -
getDefinitions
Returns a list of item definitions in this container. It is intentionally aList
because it is ordered. (To provide standard format for serialization.) Usually obtained fromComplexTypeDefinition
. So please do not modify the content of the list!- Specified by:
getDefinitions
in interfaceLocalItemDefinitionStore
-
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
default boolean isCompletelyDefined()Returns true if the instantiated container can contain only items that are explicitly defined here. -
getPropertyDefinitions
List<PrismPropertyDefinition<?>> getPropertyDefinitions()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.- Returns:
- set of definitions
-
createEmptyDelta
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 interfaceItemDefinition<C extends Containerable>
-
clone
- Specified by:
clone
in interfaceDefinition
- Specified by:
clone
in interfaceItemDefinition<C extends Containerable>
-
cloneWithReplacedDefinition
PrismContainerDefinition<C> cloneWithReplacedDefinition(QName itemName, ItemDefinition<?> newDefinition) TODO -
replaceDefinition
TODO -
createValue
PrismContainerValue<C> createValue()TODO -
isEmpty
boolean isEmpty()TODO -
canRepresent
TODO -
toMutable
MutablePrismContainerDefinition<C> toMutable()Description copied from interface:Definition
Returns an interface to mutate this definition.- Specified by:
toMutable
in interfaceDefinition
- Specified by:
toMutable
in interfaceItemDefinition<C extends Containerable>
-
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 interfaceDefinition
-
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 interfaceItemDefinition<C extends Containerable>
-
isAlwaysUseForEquals
Returns true, if item is explicitly specified mentioned to be used for equals -
getAlwaysUseForEquals
Returns list of items which should be always used for equals, even if they are operational, and equivalence strategy does not consider operational data.
-