Interface PrismContainerDelegator<C extends Containerable>
- All Superinterfaces:
- Cloneable,- ComplexCopyable<Item<PrismContainerValue<C>,,- PrismContainerDefinition<C>>> - DebugDumpable,- Freezable,- Item<PrismContainerValue<C>,,- PrismContainerDefinition<C>> - Itemable,- ItemDelegator<PrismContainerValue<C>,,- PrismContainerDefinition<C>> - ParentVisitable,- PathVisitable,- PrismContainer<C>,- PrismContainerable<C>,- PrismVisitable,- Revivable,- Serializable,- Visitable
- All Known Subinterfaces:
- PrismObjectDelegator<O>
public interface PrismContainerDelegator<C extends Containerable>
extends PrismContainer<C>, ItemDelegator<PrismContainerValue<C>,PrismContainerDefinition<C>> 
- 
Field SummaryFields inherited from interface com.evolveum.midpoint.util.DebugDumpableINDENT_STRINGFields inherited from interface com.evolveum.midpoint.prism.ItemKEY_NAMESPACE_CONTEXT
- 
Method SummaryModifier and TypeMethodDescriptiondefault voiddefault voidConvenience method.default booleancanRepresent(@NotNull Class<?> compileTimeClass) Returns true if values of this container can be represented as specified compile-time class.default booleancanRepresent(QName type) Returns true if values of this container can be presented as specified type (from compile-time or runtime schema).default PrismContainer<C>clone()Literal clone.default @NotNull PrismContainer<C>cloneComplex(@NotNull CloneStrategy strategy) Complex clone with different cloning strategies.default booleancontainsItem(ItemPath itemPath, boolean acceptEmptyItem) default ContainerDelta<C>Creates specific subclass of ItemDelta appropriate for type of item that this definition represents (e.g.default ContainerDelta<C>createDelta(ItemPath path) default PrismContainer<C>default PrismContainerValue<C>default PrismContainerDefinition<C>deepCloneDefinition(@NotNull DeepCloneOperation operation) delegate()default ContainerDelta<C>diff(PrismContainer<C> other) default ContainerDelta<C>diff(PrismContainer<C> other, ParameterizedEquivalenceStrategy strategy) diffModifications(PrismContainer<C> other, ParameterizedEquivalenceStrategy strategy) default booleanequivalent(Object obj) This method ignores some part of the object during comparison (e.g. source demarcation in values) These methods compare the "meaningful" parts of the objects.default <T extends Containerable>
 PrismContainer<T>findContainer(ItemPath path) default <IV extends PrismValue,ID extends ItemDefinition<?>, I extends Item<IV, ID>> 
 IfindCreateItem(ItemPath itemPath, Class<I> type, ID itemDefinition, boolean create) default <IV extends PrismValue,ID extends ItemDefinition<?>, I extends Item<IV, ID>> 
 IfindCreateItem(QName itemQName, Class<I> type, boolean create) Deprecated.default <IV extends PrismValue,ID extends ItemDefinition<?>> 
 Item<IV,ID> default <IV extends PrismValue,ID extends ItemDefinition<?>, I extends Item<IV, ID>> 
 Idefault <IV extends PrismValue,ID extends ItemDefinition<?>, I extends Item<IV, ID>> 
 IDeprecated.default <T extends Containerable>
 PrismContainer<T>findOrCreateContainer(ItemPath containerPath) default <IV extends PrismValue,ID extends ItemDefinition<?>, I extends Item<IV, ID>> 
 IfindOrCreateItem(ItemPath containerPath, Class<I> type) default <IV extends PrismValue,ID extends ItemDefinition<?>, I extends Item<IV, ID>> 
 IfindOrCreateItem(ItemPath containerPath, Class<I> type, ID definition) default <T> PrismProperty<T>findOrCreateProperty(ItemPath propertyPath) default PrismReferencefindOrCreateReference(ItemPath propertyPath) default <IV extends PrismValue,ID extends ItemDefinition<?>> 
 PartiallyResolvedItem<IV,ID> findPartial(ItemPath path) default <T> PrismProperty<T>findProperty(ItemPath path) default PrismReferencefindReference(ItemPath path) default PrismContainerValue<C>findValue(long id) Returns the static type of data represented by values of this container, if known and applicable.default ComplexTypeDefinitiondefault PrismContainerDefinition<C>Returns applicable definition.default <T> TgetPropertyRealValue(ItemPath propertyPath, Class<T> type) default CReturns the "real value" (content) of this item: - value contained in PrismPropertyValue - Referencable in PrismReferenceValue - Containerable in PrismContainerValue - Objectable in PrismObjectValue Note that the real value can contain operational items.default @NotNull Collection<C>Returns (potentially empty) collection of "real values".default @NotNull PrismContainerValue<C>getValue()Returns the value, if there is only one.default PrismContainerValue<C>default @NotNull List<PrismContainerValue<C>>Returns the values for this item.default voidmergeValue(PrismContainerValue<C> otherValue) default voidmergeValues(PrismContainer<C> other) default voidmergeValues(Collection<PrismContainerValue<C>> otherValues) default voidConvenience method.default voidremoveContainer(ItemPath path) default <IV extends PrismValue,ID extends ItemDefinition<?>, I extends Item<IV, ID>> 
 voidremoveItem(ItemPath path, Class<I> itemType) default voidremoveProperty(ItemPath path) default voidremoveReference(ItemPath path) default <C1 extends Containerable>
 voidsetContainerRealValue(QName containerName, C1 realValue) default <T> voidsetPropertyRealValue(QName propertyName, T realValue) default <T> voidsetPropertyRealValues(QName propertyName, T... realValues) default voidsetRealValue(C value) default voidsetValue(@NotNull PrismContainerValue<C> value) default voidtrim()Remove all empty valuesdefault voidtrimDefinitionTree(Collection<? extends ItemPath> alwaysKeep) Optimizes (trims) definition tree by removing any definitions not corresponding to items in this container.Methods inherited from interface com.evolveum.midpoint.prism.deleg.ItemDelegatoraccept, acceptParentVisitor, acceptVisitor, add, add, addAll, addAll, addIgnoringEquivalents, addRespectingMetadataAndCloning, applyDefinition, applyDefinition, applyDefinitionIfMissing, assertDefinitions, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistenceInternal, checkImmutable, checkMutable, clear, contains, contains, debugDump, debugDump, debugDumpLazily, debugDumpLazily, diff, diff, equals, equals, filterValues, filterYields, find, findValue, findValue, freeze, getAllItems, getAllValues, getAnyValue, getAnyValue, getClonedValues, getDisplayName, getElementName, getHelp, getHighestId, getNamespaceContext, getParent, getPath, getRealValue, getRealValues, getRealValuesArray, getRealValuesOrRawTypes, getUserData, getUserData, hasAnyValue, hasCompleteDefinition, hashCode, hashCode, hasNoValues, hasRaw, isEmpty, isImmutable, isIncomplete, isOperational, isRaw, isSingleValue, isSingleValueByDefinition, merge, normalize, recomputeAllValues, remove, remove, removeAll, removeIf, removeRespectingMetadata, replace, replaceAll, revive, setDefinition, setElementName, setIncomplete, setParent, setUserData, size, valuesStreamMethods inherited from interface com.evolveum.midpoint.prism.PrismContainercopy, immutableCopy, mutableCopy
- 
Method Details- 
delegatePrismContainer<C> delegate()- Specified by:
- delegatein interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
 
- 
getDefinitionDescription copied from interface:ItemReturns applicable definition.May return null if no definition is applicable or the definition is not known. - Specified by:
- getDefinitionin interface- Item<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- getDefinitionin interface- Itemable
- Specified by:
- getDefinitionin interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- getDefinitionin interface- PrismContainer<C extends Containerable>
- Specified by:
- getDefinitionin interface- PrismContainerable<C extends Containerable>
- Returns:
- applicable definition
 
- 
getCompileTimeClassDescription copied from interface:PrismContainerReturns the static type of data represented by values of this container, if known and applicable. (There are containers that are purely dynamic, i.e. without any compile time class.)- Specified by:
- getCompileTimeClassin interface- PrismContainer<C extends Containerable>
- Specified by:
- getCompileTimeClassin interface- PrismContainerable<C extends Containerable>
 
- 
canRepresentDescription copied from interface:PrismContainerReturns true if values of this container can be represented as specified compile-time class. For example, PrismContainer of AbstractRoleType has: - canRepresent(AbstractRoleType.class) = true - canRepresent(FocusType.class) = true - canRepresent(ObjectType.class) = true - canRepresent(TaskType.class) = false - canRepresent(RoleType.class) = false- Specified by:
- canRepresentin interface- PrismContainer<C extends Containerable>
 
- 
canRepresentDescription copied from interface:PrismContainerReturns true if values of this container can be presented as specified type (from compile-time or runtime schema). In particular, returns true if type of this container or any of its supertypes match given type.- Specified by:
- canRepresentin interface- PrismContainer<C extends Containerable>
 
- 
getRealValuesDescription copied from interface:ItemReturns (potentially empty) collection of "real values". The list itself is detached, freely modifiable. (Note that the values can still embed a parent, e.g., for containers and references.)- Specified by:
- getRealValuesin interface- Item<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- getRealValuesin interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- getRealValuesin interface- PrismContainer<C extends Containerable>
- Returns:
- List of current values. The list itself is freely modifiable - it is independent on the list of values in this container. However, values themselves are directly linked to the PCVs.
- See Also:
 
- 
getRealValueDescription copied from interface:ItemReturns the "real value" (content) of this item: - value contained in PrismPropertyValue - Referencable in PrismReferenceValue - Containerable in PrismContainerValue - Objectable in PrismObjectValue Note that the real value can contain operational items. It can also contain container IDs (although they are not considered to be part of the real value). It does not contain information about item element name nor other metadata like origin, definition, etc. (Although e.g. Containerable can be converted back into PrismContainerValue that can be used to retrieve this information.)- Specified by:
- getRealValuein interface- Item<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- getRealValuein interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- getRealValuein interface- PrismContainer<C extends Containerable>
 
- 
setRealValue- Specified by:
- setRealValuein interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
setValue- Specified by:
- setValuein interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
getValueDescription copied from interface:ItemReturns the value, if there is only one. Throws exception if there are more values. If there is no value, this method either: - returns null (for properties) - throws an exception (for items that can hold multiple values) - creates an empty value (for containers and references). TODO think again whether getOrCreateValue would not be better- Specified by:
- getValuein interface- Item<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- getValuein interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- getValuein interface- PrismContainer<C extends Containerable>
 
- 
getValue- Specified by:
- getValuein interface- PrismContainer<C extends Containerable>
 
- 
getValuesDescription copied from interface:ItemReturns the values for this item. Although the ordering of this values is not important, and each value should be present at most once, we currently return them as a list instead of a set. TODO reconsider this FIXME we should return immutable list, to avoid manipulating the values directly FIXME and maybe we should return List<? extends V> to avoid specializing the values, see ShadowAssociationValue in midPoint- Specified by:
- getValuesin interface- Item<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- getValuesin interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- getValuesin interface- PrismContainer<C extends Containerable>
 
- 
setPropertyRealValue- Specified by:
- setPropertyRealValuein interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
setContainerRealValuedefault <C1 extends Containerable> void setContainerRealValue(QName containerName, C1 realValue) throws SchemaException - Specified by:
- setContainerRealValuein interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
setPropertyRealValues- Specified by:
- setPropertyRealValuesin interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
getPropertyRealValue- Specified by:
- getPropertyRealValuein interface- PrismContainer<C extends Containerable>
 
- 
addDescription copied from interface:PrismContainerConvenience method. Works only on single-valued containers.- Specified by:
- addin interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
createNewValue- Specified by:
- createNewValuein interface- PrismContainer<C extends Containerable>
 
- 
mergeValues- Specified by:
- mergeValuesin interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
mergeValues- Specified by:
- mergeValuesin interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
mergeValue- Specified by:
- mergeValuein interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
trimdefault void trim()Description copied from interface:PrismContainerRemove all empty values- Specified by:
- trimin interface- PrismContainer<C extends Containerable>
 
- 
findItem@Deprecated default <IV extends PrismValue,ID extends ItemDefinition<?>, I findItemI extends Item<IV, ID>> (QName itemQName, Class<I> type) Deprecated.- Specified by:
- findItemin interface- PrismContainer<C extends Containerable>
 
- 
findPartialdefault <IV extends PrismValue,ID extends ItemDefinition<?>> PartiallyResolvedItem<IV,ID> findPartial(ItemPath path) - Specified by:
- findPartialin interface- Item<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- findPartialin interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- findPartialin interface- PrismContainer<C extends Containerable>
 
- 
findCreateItem@Deprecated default <IV extends PrismValue,ID extends ItemDefinition<?>, I findCreateItemI extends Item<IV, ID>> (QName itemQName, Class<I> type, boolean create) throws SchemaException Deprecated.- Specified by:
- findCreateItemin interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
findItemdefault <IV extends PrismValue,ID extends ItemDefinition<?>, I findItemI extends Item<IV, ID>> (ItemPath path, Class<I> type) - Specified by:
- findItemin interface- PrismContainer<C extends Containerable>
 
- 
findItem- Specified by:
- findItemin interface- PrismContainer<C extends Containerable>
 
- 
containsItem- Specified by:
- containsItemin interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
findCreateItemdefault <IV extends PrismValue,ID extends ItemDefinition<?>, I findCreateItemI extends Item<IV, ID>> (ItemPath itemPath, Class<I> type, ID itemDefinition, boolean create) throws SchemaException - Specified by:
- findCreateItemin interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
findValue- Specified by:
- findValuein interface- PrismContainer<C extends Containerable>
 
- 
findContainer- Specified by:
- findContainerin interface- PrismContainer<C extends Containerable>
 
- 
findProperty- Specified by:
- findPropertyin interface- PrismContainer<C extends Containerable>
 
- 
findReference- Specified by:
- findReferencein interface- PrismContainer<C extends Containerable>
 
- 
findOrCreateItemdefault <IV extends PrismValue,ID extends ItemDefinition<?>, I findOrCreateItemI extends Item<IV, ID>> (ItemPath containerPath, Class<I> type) throws SchemaException - Specified by:
- findOrCreateItemin interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
findOrCreateItemdefault <IV extends PrismValue,ID extends ItemDefinition<?>, I findOrCreateItemI extends Item<IV, ID>> (ItemPath containerPath, Class<I> type, ID definition) throws SchemaException - Specified by:
- findOrCreateItemin interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
findOrCreateContainerdefault <T extends Containerable> PrismContainer<T> findOrCreateContainer(ItemPath containerPath) throws SchemaException - Specified by:
- findOrCreateContainerin interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
findOrCreateProperty- Specified by:
- findOrCreatePropertyin interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
findOrCreateReference- Specified by:
- findOrCreateReferencein interface- PrismContainer<C extends Containerable>
- Throws:
- SchemaException
 
- 
removeDescription copied from interface:PrismContainerConvenience method. Works only on single-valued containers.- Specified by:
- removein interface- PrismContainer<C extends Containerable>
 
- 
removeProperty- Specified by:
- removePropertyin interface- PrismContainer<C extends Containerable>
 
- 
removeContainer- Specified by:
- removeContainerin interface- PrismContainer<C extends Containerable>
 
- 
removeReference- Specified by:
- removeReferencein interface- PrismContainer<C extends Containerable>
 
- 
removeItemdefault <IV extends PrismValue,ID extends ItemDefinition<?>, void removeItemI extends Item<IV, ID>> (ItemPath path, Class<I> itemType) - Specified by:
- removeItemin interface- PrismContainer<C extends Containerable>
 
- 
createDeltaDescription copied from interface:ItemCreates specific subclass of ItemDelta appropriate for type of item that this definition represents (e.g. PropertyDelta, ContainerDelta, ...)- Specified by:
- createDeltain interface- Item<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- createDeltain interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- createDeltain interface- PrismContainer<C extends Containerable>
 
- 
createDelta- Specified by:
- createDeltain interface- Item<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- createDeltain interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- createDeltain interface- PrismContainer<C extends Containerable>
 
- 
diff- Specified by:
- diffin interface- PrismContainer<C extends Containerable>
 
- 
diff- Specified by:
- diffin interface- PrismContainer<C extends Containerable>
 
- 
diffModificationsdefault List<? extends ItemDelta> diffModifications(PrismContainer<C> other, ParameterizedEquivalenceStrategy strategy) - Specified by:
- diffModificationsin interface- PrismContainer<C extends Containerable>
 
- 
cloneDescription copied from interface:ItemLiteral clone.- Specified by:
- clonein interface- Item<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- clonein interface- PrismContainer<C extends Containerable>
 
- 
createImmutableClone- Specified by:
- createImmutableClonein interface- Item<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- createImmutableClonein interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- createImmutableClonein interface- PrismContainer<C extends Containerable>
 
- 
cloneComplexDescription copied from interface:ItemComplex clone with different cloning strategies.- Specified by:
- cloneComplexin interface- ComplexCopyable<C extends Containerable>
- Specified by:
- cloneComplexin interface- Item<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- cloneComplexin interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- cloneComplexin interface- PrismContainer<C extends Containerable>
- See Also:
 
- 
deepCloneDefinitiondefault PrismContainerDefinition<C> deepCloneDefinition(@NotNull @NotNull DeepCloneOperation operation) - Specified by:
- deepCloneDefinitionin interface- PrismContainer<C extends Containerable>
 
- 
accept- Specified by:
- acceptin interface- ItemDelegator<PrismContainerValue<C extends Containerable>,- PrismContainerDefinition<C extends Containerable>> 
- Specified by:
- acceptin interface- PathVisitable
- Specified by:
- acceptin interface- PrismContainer<C extends Containerable>
 
- 
equivalentDescription copied from interface:PrismContainerThis method ignores some part of the object during comparison (e.g. source demarcation in values) These methods compare the "meaningful" parts of the objects.- Specified by:
- equivalentin interface- PrismContainer<C extends Containerable>
 
- 
trimDefinitionTreeDescription copied from interface:PrismContainerOptimizes (trims) definition tree by removing any definitions not corresponding to items in this container. Works recursively by sub-containers of this one. USE WITH CARE. Make sure the definitions are not shared by other objects!- Specified by:
- trimDefinitionTreein interface- PrismContainer<C extends Containerable>
 
- 
getComplexTypeDefinition- Specified by:
- getComplexTypeDefinitionin interface- PrismContainerable<C extends Containerable>
 
 
-