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:
- 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 aComplexTypeDefinition.
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinitionPrismItemAccessDefinition.Mutable
 
- 
 - 
Field Summary- 
Fields inherited from interface com.evolveum.midpoint.util.DebugDumpableINDENT_STRING
 
- 
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description booleancanRepresent(@NotNull QName type)TODO@NotNull PrismContainerDefinition<C>clone()PrismContainerDefinition<C>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.PrismContainerValue<C>createValue()TODOdefault Collection<QName>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.Class<C>getCompileTimeClass()Static (compile-time) class holding the container values.ComplexTypeDefinitiongetComplexTypeDefinition()Definition of the container values.@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.List<PrismPropertyDefinition<?>>getPropertyDefinitions()Returns set of property definitions.Class<C>getTypeClass()Returns a compile-time class that is used to represent items.default booleanisAlwaysUseForEquals(QName name)Returns true, if item is explicitly specified mentioned to be used for equalsdefault booleanisCompletelyDefined()Returns true if the instantiated container can contain only items that are explicitly defined here.booleanisEmpty()TODOvoidreplaceDefinition(QName itemName, ItemDefinition<?> newDefinition)TODOdefault Optional<ComplexTypeDefinition>structuredType()Returns complex type definition of item, if underlying value is possible structured.MutablePrismContainerDefinition<C>toMutable()Returns an interface to mutate this definition.- 
Methods inherited from interface com.evolveum.midpoint.util.DebugDumpabledebugDump, debugDump, debugDumpLazily, debugDumpLazily
 - 
Methods inherited from interface com.evolveum.midpoint.prism.DefinitiondebugDump, getAnnotation, getAnnotations, getDeprecatedSince, getDiagrams, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getProcessing, getSchemaMigrations, getSchemaRegistry, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRuntimeSchema, setAnnotation
 - 
Methods inherited from interface com.evolveum.midpoint.prism.FreezablecheckImmutable, checkMutable, freeze, isImmutable
 - 
Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinitionadoptElementDefinitionFrom, canBeDefinitionOf, canBeDefinitionOf, debugDumpShortToString, deepClone, findItemDefinition, getItemName, getMaxOccurs, getMinOccurs, getSubstitutionHead, getValueEnumerationRef, instantiate, instantiate, isDynamic, isHeterogeneousListItem, isIndexOnly, isInherited, isMandatory, isMultiValue, isOperational, isOptional, isSingleValue, isValidFor
 - 
Methods inherited from interface com.evolveum.midpoint.prism.LocalItemDefinitionStorecontainsItemDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition, findReferenceDefinition
 - 
Methods inherited from interface com.evolveum.midpoint.prism.PrismContextSensitivegetPrismContext
 - 
Methods inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinitioncanAdd, canModify, canRead
 - 
Methods inherited from interface com.evolveum.midpoint.prism.SmartVisitableaccept
 
- 
 
- 
- 
- 
Method Detail- 
getCompileTimeClassClass<C> getCompileTimeClass() Static (compile-time) class holding the container values. May be null. (Let's not mark it as @Nullable to avoid lots of warnings.)
 - 
getComplexTypeDefinitionComplexTypeDefinition 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@NotNull @NotNull List<? extends ItemDefinition<?>> getDefinitions() Returns a list of item definitions in this container. It is intentionally aListbecause it is ordered. (To provide standard format for serialization.) Usually obtained fromComplexTypeDefinition. So please do not modify the content of the list!- Specified by:
- getDefinitionsin interface- LocalItemDefinitionStore
 
 - 
getItemNamesdefault 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.
 - 
isCompletelyDefineddefault boolean isCompletelyDefined() Returns true if the instantiated container can contain only items that are explicitly defined here.
 - 
getPropertyDefinitionsList<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@NotNull @NotNull ContainerDelta<C> createEmptyDelta(ItemPath path) Description copied from interface:ItemDefinitionCreates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.- Specified by:
- createEmptyDeltain interface- ItemDefinition<C extends Containerable>
 
 - 
clone@NotNull @NotNull PrismContainerDefinition<C> clone() - Specified by:
- clonein interface- Definition
- Specified by:
- clonein interface- ItemDefinition<C extends Containerable>
 
 - 
cloneWithReplacedDefinitionPrismContainerDefinition<C> cloneWithReplacedDefinition(QName itemName, ItemDefinition<?> newDefinition) TODO
 - 
replaceDefinitionvoid replaceDefinition(QName itemName, ItemDefinition<?> newDefinition) TODO
 - 
createValuePrismContainerValue<C> createValue() TODO
 - 
isEmptyboolean isEmpty() TODO
 - 
canRepresentboolean canRepresent(@NotNull @NotNull QName type)TODO
 - 
toMutableMutablePrismContainerDefinition<C> toMutable() Description copied from interface:DefinitionReturns an interface to mutate this definition.- Specified by:
- toMutablein interface- Definition
- Specified by:
- toMutablein interface- ItemDefinition<C extends Containerable>
 
 - 
getTypeClassClass<C> getTypeClass() Description copied from interface:DefinitionReturns 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:
- getTypeClassin interface- Definition
 
 - 
structuredTypedefault Optional<ComplexTypeDefinition> structuredType() Description copied from interface:ItemDefinitionReturns 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:
- structuredTypein interface- ItemDefinition<C extends Containerable>
 
 - 
isAlwaysUseForEquals@Experimental default boolean isAlwaysUseForEquals(QName name) Returns true, if item is explicitly specified mentioned to be used for equals
 - 
getAlwaysUseForEquals@Experimental default Collection<QName> 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.
 
- 
 
-