Package com.evolveum.midpoint.prism.deleg

Interface PrismContainerValueDelegator<C extends Containerable>

All Superinterfaces:

DebugDumpable, Freezable, MidpointOriginMetadata, ParentVisitable, PathVisitable, PrismContainerValue<C>, PrismValue, PrismVisitable, Revivable, SchemaLookup.Aware, Serializable, Visitable, Walkable

public interface PrismContainerValueDelegator<C extends Containerable>
extends PrismContainerValue<C>

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismContainerValue

PrismContainerValue.RemovedItemDefinitionException

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default void	accept(Visitor visitor)
default void	accept(Visitor visitor, ItemPath path, boolean recursive)
default void	acceptParentVisitor(Visitor visitor)
default <IV extends PrismValue, ID extends ItemDefinition<?>> void	add(Item<IV,ID> item)
default <IV extends PrismValue, ID extends ItemDefinition<?>> void	add(Item<IV,ID> item, boolean checkUniqueness)	Adds an item to a property container.
default void	addAll(Collection<? extends Item<?,?>> itemsToAdd)	Adds a collection of items to a property container.
default void	addAllReplaceExisting(Collection<? extends Item<?,?>> itemsToAdd)	Adds a collection of items to a property container.
default boolean	addRawElement(Object element)
default <IV extends PrismValue, ID extends ItemDefinition<?>> void	addReplaceExisting(Item<IV,ID> item)	Adds an item to a property container.
default PrismContainerValue<C>	applyDefinition(@NotNull ItemDefinition<?> itemDefinition)	Definition application MAY change the value (currently only for container values).
default PrismContainerValue<C>	applyDefinition(@NotNull ItemDefinition<?> itemDefinition, boolean force)	Definition application MAY change the value (currently only for container values).
default PrismContainerValue<C>	applyDefinition(@NotNull PrismContainerDefinition<C> containerDef, boolean force)
default void	applyDefinitionLegacy(@NotNull ItemDefinition<?> definition)	This one checks that nothing has changed.
default void	applyDefinitionLegacy(@NotNull ItemDefinition<?> definition, boolean force)	Definition application MAY change the value (currently only for container/reference values).
default C	asContainerable()
default C	asContainerable(Class<C> requiredClass)
default void	assertDefinitions(boolean tolerateRaw, Supplier<String> sourceDescriptionSupplier)
default void	assertDefinitions(Supplier<String> sourceDescriptionSupplier)
default PrismContainer<C>	asSingleValuedContainer(@NotNull QName itemName)	Returns a single-valued container (with a single-valued definition) holding just this value.
default boolean	canRepresent(Class<?> clazz)
default void	checkConsistenceInternal(Itemable rootItem, boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
default void	checkImmutable()
default void	checkMutable()
default void	checkNothingExceptFor(QName... allowedItemNames)	For simplicity, everything must be qualified: names to check, and existing names.
default void	clear()
default void	clearParent()	Used when we are removing the value from the previous parent.
default PrismContainerValue<C>	cloneComplex(@NotNull CloneStrategy strategy)	Complex clone with different cloning strategies.
default @NotNull PrismValue	cloneIfImmutable()
default boolean	contains(Item item)
default boolean	contains(ItemName itemName)
default boolean	containsItem(ItemPath propPath, boolean acceptEmptyItem)
default <IV extends PrismValue, ID extends ItemDefinition<?>, I extends Item<IV, ID>> I	createDetachedSubItem(QName name, Class<I> type, ID itemDefinition, boolean immutable)
default PrismContainerValue<C>	createImmutableClone()
default <X> PrismProperty<X>	createProperty(PrismPropertyDefinition<X> propertyDefinition)
default <X> PrismProperty<X>	createProperty(QName propertyName)
PrismContainerValue<C>	delegate()
default boolean	deleteRawElement(Object element)
default void	deleteValueMetadata()
default Collection<? extends ItemDelta>	diff(PrismValue otherValue, ParameterizedEquivalenceStrategy strategy)	Assumes matching representations.
default boolean	equals(PrismValue otherValue, @NotNull EquivalenceStrategy strategy)
default boolean	equals(PrismValue otherValue, @NotNull ParameterizedEquivalenceStrategy strategy)
default boolean	equivalent(PrismContainerValue<?> other)
default Object	find(ItemPath path)
default <X extends Containerable> PrismContainer<X>	findContainer(QName containerName)
default <IV extends PrismValue, ID extends ItemDefinition<?>, I extends Item<IV, ID>> I	findItem(ItemDefinition itemDefinition, Class<I> type)
default <IV extends PrismValue, ID extends ItemDefinition<?>> Item<IV,ID>	findItem(ItemPath itemPath)
default <IV extends PrismValue, ID extends ItemDefinition<?>, I extends Item<IV, ID>> I	findItem(ItemPath itemPath, Class<I> type)
default <T extends Containerable> PrismContainer<T>	findOrCreateContainer(QName containerName)
default <IV extends PrismValue, ID extends ItemDefinition<?>, I extends Item<IV, ID>> I	findOrCreateItem(ItemPath path, Class<I> type, ID definition)
default <IV extends PrismValue, ID extends ItemDefinition<?>> Item<IV,ID>	findOrCreateItem(QName containerName)
default <IV extends PrismValue, ID extends ItemDefinition<?>, I extends Item<IV, ID>> I	findOrCreateItem(QName containerName, Class<I> type)
default <X> PrismProperty<X>	findOrCreateProperty(ItemPath propertyPath)
default <X> PrismProperty<X>	findOrCreateProperty(PrismPropertyDefinition propertyDef)
default PrismReference	findOrCreateReference(QName referenceName)
default <IV extends PrismValue, ID extends ItemDefinition<?>> PartiallyResolvedItem<IV,ID>	findPartial(ItemPath path)
default <X> PrismProperty<X>	findProperty(ItemPath propertyPath)
default <X> PrismProperty<X>	findProperty(PrismPropertyDefinition<X> propertyDefinition)	Finds a specific property in the container by definition.
default PrismReference	findReference(QName elementName)
default void	freeze()	Should be no-op (or very quick) if the object is already immutable.
default @NotNull Collection<Item<?,?>>	getAllItems(@NotNull ItemPath path)	See Item.getAllItems(ItemPath).
default @NotNull Collection<PrismValue>	getAllValues(ItemPath path)	See Item.getAllValues(ItemPath).
default Class<C>	getCompileTimeClass()
default @Nullable ComplexTypeDefinition	getComplexTypeDefinition()
default PrismContainer<C>	getContainer()
default PrismContainerDefinition<C>	getDefinition()
default @NotNull Collection<QName>	getItemNames()
default <T> T	getItemRealValue(ItemName itemName, Class<T> type)
default @NotNull Collection<Item<?,?>>	getItems()	Returns a collection of items that the property container contains.
default <T> T	getNearestValueOfType(@NotNull Class<T> type)
default Objectable	getOriginObject()
default OriginType	getOriginType()
default PrismContainerable<C>	getParent()
default PrismContainerValue<?>	getParentContainerValue()
default @NotNull ItemPath	getPath()
default @NotNull Set<PrismProperty<?>>	getProperties()	Returns a set of properties that the property container contains.
default <T> T	getPropertyRealValue(QName propertyName, Class<T> type)
default @Nullable Class<?>	getRealClass()
default <T> T	getRealValue()	Returns the statically-typed "real value".
default @Nullable Object	getRealValueIfExists()
default @Nullable Object	getRealValueOrRawType()
default @NotNull PrismContainerValue<?>	getRootValue()
default SchemaContext	getSchemaContext()
default Map<String,Object>	getUserData()
default Object	getUserData(@NotNull String key)
default C	getValue()
default @NotNull ValueMetadata	getValueMetadata()	Returns the value metadata, creating empty one if there's none.
default <C extends Containerable> @NotNull PrismContainer<C>	getValueMetadataAsContainer()	Returns value metadata as typed PrismContainer.
default @Nullable ValueMetadata	getValueMetadataIfExists()	Returns the value metadata, if there is any.
default boolean	hasCompleteDefinition()	Returns true if all contained items have complete definitions.
default int	hashCode(@NotNull EquivalenceStrategy equivalenceStrategy)
default int	hashCode(@NotNull ParameterizedEquivalenceStrategy equivalenceStrategy)
default boolean	hasNoItems()	Like isEmpty but ignores presence of container value ID.
default boolean	hasRealClass()
default boolean	hasValueMetadata()
default boolean	isEmpty()
default boolean	isImmutable()
default boolean	isObjectable()	Returns `true` if this value represents a PrismObject value.
default boolean	isOfType(@NotNull QName expectedTypeName)	Ignores untyped values (considers them non-matching).
default boolean	isRaw()
default boolean	isTransient()
default void	keepPaths(List<? extends ItemPath> keep)
default <IV extends PrismValue, ID extends ItemDefinition<?>> boolean	merge(Item<IV,ID> item)	Merges the provided item into this item.
default void	mergeContent(@NotNull PrismContainerValue<?> other, @NotNull List<QName> overwrite)
default void	normalize()	Currently doing nothing.
default void	recompute()	Recompute the value or otherwise "initialize" it before adding it to a prism tree.
default void	recompute(PrismContext prismContext)
default <IV extends PrismValue, ID extends ItemDefinition<?>> void	remove(Item<IV,ID> item)
default void	removeAll()
default void	removeContainer(ItemPath path)
default void	removeItem(@NotNull ItemPath path)	Useful when removing something without the knowledge of its kind.
default void	removeItems(List<? extends ItemPath> itemsToRemove)
default void	removeMetadataFromPaths(List<? extends ItemPath> pathsToRemoveMetadata)	Remove metadata from specified paths Can also remove metadata from the object on which it's called, if the paths contains a "root" path (e.g.
default void	removeOperationalItems()
default void	removePaths(List<? extends ItemPath> remove)
default void	removeProperty(ItemPath path)
default boolean	removeRawElement(Object element)
default void	removeReference(ItemPath path)
default <IV extends PrismValue, ID extends ItemDefinition<?>> void	replace(Item<IV,ID> oldItem, Item<IV,ID> newItem)
default boolean	representsSameValue(PrismValue other, EquivalenceStrategy strategy, boolean lax)	Returns true if this and other value represent the same value.
default void	revive(PrismContext prismContext)	TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)
default SchemaLookup	schemaLookup()
default void	setId(Long id)
default void	setOriginObject(Objectable source)
default void	setOriginType(OriginType type)
default void	setOriginTypeRecursive(OriginType originType)	Set origin type to all values and subvalues
default void	setParent(Itemable parent)
default <T> void	setPropertyRealValue(QName propertyName, T realValue)
default void	setTransient(boolean value)
default void	setUserData(@NotNull String key, Object value)
default void	setValueMetadata(Containerable realValue)	Sets metadata from this value (from PCV).
default void	setValueMetadata(PrismContainer<?> valueMetadata)	Sets metadata for this value.
default void	setValueMetadata(ValueMetadata valueMetadata)	Sets metadata for this value.
default int	size()
default <IV extends PrismValue, ID extends ItemDefinition<?>> boolean	subtract(Item<IV,ID> item)	Subtract the provided item from this item.
default String	toHumanReadableString()
default void	walk(BiPredicate<? super ItemPath,Boolean> descendPredicate, Predicate<? super ItemPath> consumePredicate, Consumer<? super Item<?,?>> itemConsumer)	Walk through hierarchy of containing items based on provided conditions.

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

acceptVisitor, clone, getId, isIdOnly

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

getRootObjectable, getTypeName

Method Details

delegate

PrismContainerValue<C> delegate()

isImmutable

default boolean isImmutable()

Specified by:

isImmutable in interface Freezable

freeze

default void freeze()

Description copied from interface: Freezable

Should be no-op (or very quick) if the object is already immutable.

Specified by:

freeze in interface Freezable

checkMutable

default void checkMutable()

Specified by:

checkMutable in interface Freezable

checkImmutable

default void checkImmutable()

Specified by:

checkImmutable in interface Freezable

revive

default void revive(PrismContext prismContext)

Description copied from interface: Revivable

TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)

Specified by:

revive in interface Revivable

getCompileTimeClass

default Class<C> getCompileTimeClass()

Specified by:

getCompileTimeClass in interface PrismContainerValue<C extends Containerable>

getProperties

@Unused
@NotNull
default @NotNull Set<PrismProperty<?>> getProperties()

Description copied from interface: PrismContainerValue

Returns a set of properties that the property container contains.

Returned set is immutable! Any change to it will be ignored.

This method costs a bit, as the set of properties needs to be created. Consider using other methods if possible.

Specified by:

getProperties in interface PrismContainerValue<C extends Containerable>

Returns:

set of properties that the property container contains.

getItems

@Contract(pure=true)
@NotNull
default @NotNull Collection<Item<?,?>> getItems()

Description copied from interface: PrismContainerValue

Returns a collection of items that the property container contains. The items may be properties or inner property containers.

Returned collection is mutable, but the caller should NOT modify it. Instead - e.g. if it needs to remove values - it should call remove() method.

Specified by:

getItems in interface PrismContainerValue<C extends Containerable>

Returns:

collection of items that the property container contains.

setOriginTypeRecursive

default void setOriginTypeRecursive(OriginType originType)

Description copied from interface: PrismContainerValue

Set origin type to all values and subvalues

Specified by:

setOriginTypeRecursive in interface PrismContainerValue<C extends Containerable>

keepPaths

default void keepPaths(List<? extends ItemPath> keep)
                throws SchemaException

Specified by:

keepPaths in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

size

default int size()

Specified by:

size in interface PrismContainerValue<C extends Containerable>

deleteRawElement

default boolean deleteRawElement(Object element)
                          throws SchemaException

Specified by:

deleteRawElement in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

findContainer

default <X extends Containerable> PrismContainer<X> findContainer(QName containerName)

Specified by:

findContainer in interface PrismContainerValue<C extends Containerable>

findOrCreateProperty

default <X> PrismProperty<X> findOrCreateProperty(ItemPath propertyPath)
                                           throws SchemaException

Specified by:

findOrCreateProperty in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

getPropertyRealValue

default <T> T getPropertyRealValue(QName propertyName,
 Class<T> type)

Specified by:

getPropertyRealValue in interface PrismContainerValue<C extends Containerable>

equivalent

default boolean equivalent(PrismContainerValue<?> other)

Specified by:

equivalent in interface PrismContainerValue<C extends Containerable>

findOrCreateProperty

default <X> PrismProperty<X> findOrCreateProperty(PrismPropertyDefinition propertyDef)
                                           throws SchemaException

Specified by:

findOrCreateProperty in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

removeRawElement

default boolean removeRawElement(Object element)

Specified by:

removeRawElement in interface PrismContainerValue<C extends Containerable>

getParent

default PrismContainerable<C> getParent()

Specified by:

getParent in interface PrismContainerValue<C extends Containerable>

Specified by:

getParent in interface PrismValue

removeItem

default void removeItem(@NotNull
 @NotNull ItemPath path)

Description copied from interface: PrismContainerValue

Useful when removing something without the knowledge of its kind.

Specified by:

removeItem in interface PrismContainerValue<C extends Containerable>

removeProperty

default void removeProperty(ItemPath path)

Specified by:

removeProperty in interface PrismContainerValue<C extends Containerable>

remove

default <IV extends PrismValue,
ID extends ItemDefinition<?>>
void remove(Item<IV,ID> item)

Specified by:

remove in interface PrismContainerValue<C extends Containerable>

findItem

default <IV extends PrismValue,
ID extends ItemDefinition<?>,
I extends Item<IV,
ID>>
I findItem(ItemDefinition itemDefinition,
 Class<I> type)

Specified by:

findItem in interface PrismContainerValue<C extends Containerable>

hasNoItems

default boolean hasNoItems()

Description copied from interface: PrismContainerValue

Like isEmpty but ignores presence of container value ID.

Specified by:

hasNoItems in interface PrismContainerValue<C extends Containerable>

findOrCreateReference

default PrismReference findOrCreateReference(QName referenceName)
                                      throws SchemaException

Specified by:

findOrCreateReference in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

accept

default void accept(Visitor visitor,
 ItemPath path,
 boolean recursive)

Specified by:

accept in interface PathVisitable

Specified by:

accept in interface PrismContainerValue<C extends Containerable>

Specified by:

accept in interface PrismValue

getComplexTypeDefinition

@Nullable
default @Nullable ComplexTypeDefinition getComplexTypeDefinition()

Specified by:

getComplexTypeDefinition in interface PrismContainerValue<C extends Containerable>

hasCompleteDefinition

default boolean hasCompleteDefinition()

Description copied from interface: PrismContainerValue

Returns true if all contained items have complete definitions. (Currently does not check the definition of this value itself.)

Specified by:

hasCompleteDefinition in interface PrismContainerValue<C extends Containerable>

accept

default void accept(Visitor visitor)

Specified by:

accept in interface PrismContainerValue<C extends Containerable>

Specified by:

accept in interface PrismValue

Specified by:

accept in interface Visitable<C extends Containerable>

findProperty

default <X> PrismProperty<X> findProperty(ItemPath propertyPath)

Specified by:

findProperty in interface PrismContainerValue<C extends Containerable>

recompute

default void recompute(PrismContext prismContext)

Specified by:

recompute in interface PrismContainerValue<C extends Containerable>

Specified by:

recompute in interface PrismValue

removeReference

default void removeReference(ItemPath path)

Specified by:

removeReference in interface PrismContainerValue<C extends Containerable>

applyDefinition

default PrismContainerValue<C> applyDefinition(@NotNull
 @NotNull ItemDefinition<?> itemDefinition)
                                        throws SchemaException

Description copied from interface: PrismValue

Definition application MAY change the value (currently only for container values). The caller must deal with that. To be seen if this is a good idea. But probably so, because there are various situations when the definition application changes the nature of a prism value (midPoint shadow associations are currently the only places) but of prism items (midPoint attributes and associations need this; and it must be worked around for now).

Specified by:

applyDefinition in interface PrismContainerValue<C extends Containerable>

Specified by:

applyDefinition in interface PrismValue

Throws:

SchemaException

applyDefinition

default PrismContainerValue<C> applyDefinition(@NotNull
 @NotNull ItemDefinition<?> itemDefinition,
 boolean force)
                                        throws SchemaException

Description copied from interface: PrismValue

Definition application MAY change the value (currently only for container values). The caller must deal with that.

Specified by:

applyDefinition in interface PrismContainerValue<C extends Containerable>

Specified by:

applyDefinition in interface PrismValue

Throws:

SchemaException

addAll

default void addAll(Collection<? extends Item<?,?>> itemsToAdd)
             throws SchemaException

Description copied from interface: PrismContainerValue

Adds a collection of items to a property container.

Specified by:

addAll in interface PrismContainerValue<C extends Containerable>

Parameters:

itemsToAdd - items to add

Throws:

SchemaException

add

default <IV extends PrismValue,
ID extends ItemDefinition<?>>
void add(Item<IV,ID> item)
  throws SchemaException

Specified by:

add in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

addAllReplaceExisting

default void addAllReplaceExisting(Collection<? extends Item<?,?>> itemsToAdd)
                            throws SchemaException

Description copied from interface: PrismContainerValue

Adds a collection of items to a property container. Existing values will be replaced.

Specified by:

addAllReplaceExisting in interface PrismContainerValue<C extends Containerable>

Parameters:

itemsToAdd - items to add

Throws:

SchemaException

removeAll

default void removeAll()

Specified by:

removeAll in interface PrismContainerValue<C extends Containerable>

getDefinition

default PrismContainerDefinition<C> getDefinition()

Specified by:

getDefinition in interface PrismContainerValue<C extends Containerable>

createImmutableClone

default PrismContainerValue<C> createImmutableClone()

Specified by:

createImmutableClone in interface PrismContainerValue<C extends Containerable>

Specified by:

createImmutableClone in interface PrismValue

add

default <IV extends PrismValue,
ID extends ItemDefinition<?>>
void add(Item<IV,ID> item,
 boolean checkUniqueness)
  throws SchemaException

Description copied from interface: PrismContainerValue

Adds an item to a property container.

Specified by:

add in interface PrismContainerValue<C extends Containerable>

Parameters:

item - item to add.

Throws:

SchemaException

asContainerable

default C asContainerable(Class<C> requiredClass)

Specified by:

asContainerable in interface PrismContainerValue<C extends Containerable>

assertDefinitions

default void assertDefinitions(Supplier<String> sourceDescriptionSupplier)
                        throws SchemaException

Specified by:

assertDefinitions in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

removeOperationalItems

default void removeOperationalItems()

Specified by:

removeOperationalItems in interface PrismContainerValue<C extends Containerable>

contains

default boolean contains(ItemName itemName)

Specified by:

contains in interface PrismContainerValue<C extends Containerable>

getRootValue

@NotNull
default @NotNull PrismContainerValue<?> getRootValue()

Specified by:

getRootValue in interface PrismContainerValue<C extends Containerable>

Specified by:

getRootValue in interface PrismValue

subtract

default <IV extends PrismValue,
ID extends ItemDefinition<?>>
boolean subtract(Item<IV,ID> item)
          throws SchemaException

Description copied from interface: PrismContainerValue

Subtract the provided item from this item. The values of the provided item are deleted from this item. Returns true if this item was changed.

Specified by:

subtract in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

addReplaceExisting

default <IV extends PrismValue,
ID extends ItemDefinition<?>>
void addReplaceExisting(Item<IV,ID> item)
                 throws SchemaException

Description copied from interface: PrismContainerValue

Adds an item to a property container. Existing value will be replaced.

Specified by:

addReplaceExisting in interface PrismContainerValue<C extends Containerable>

Parameters:

item - item to add.

Throws:

SchemaException

schemaLookup

default SchemaLookup schemaLookup()

Specified by:

schemaLookup in interface PrismContainerValue<C extends Containerable>

Specified by:

schemaLookup in interface PrismValue

Specified by:

schemaLookup in interface SchemaLookup.Aware

clear

default void clear()

Specified by:

clear in interface PrismContainerValue<C extends Containerable>

removeContainer

default void removeContainer(ItemPath path)

Specified by:

removeContainer in interface PrismContainerValue<C extends Containerable>

assertDefinitions

default void assertDefinitions(boolean tolerateRaw,
 Supplier<String> sourceDescriptionSupplier)
                        throws SchemaException

Specified by:

assertDefinitions in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

getItemRealValue

default <T> T getItemRealValue(ItemName itemName,
 Class<T> type)

Specified by:

getItemRealValue in interface PrismContainerValue<C extends Containerable>

mergeContent

default void mergeContent(@NotNull
 @NotNull PrismContainerValue<?> other,
 @NotNull
 @NotNull List<QName> overwrite)
                   throws SchemaException

Specified by:

mergeContent in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

addRawElement

default boolean addRawElement(Object element)
                       throws SchemaException

Specified by:

addRawElement in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

getItemNames

@NotNull
default @NotNull Collection<QName> getItemNames()

Specified by:

getItemNames in interface PrismContainerValue<C extends Containerable>

getContainer

default PrismContainer<C> getContainer()

Specified by:

getContainer in interface PrismContainerValue<C extends Containerable>

findOrCreateItem

default <IV extends PrismValue,
ID extends ItemDefinition<?>,
I extends Item<IV,
ID>>
I findOrCreateItem(ItemPath path,
 Class<I> type,
 ID definition)
            throws SchemaException

Specified by:

findOrCreateItem in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

getValue

default C getValue()

Specified by:

getValue in interface PrismContainerValue<C extends Containerable>

cloneComplex

default PrismContainerValue<C> cloneComplex(@NotNull
 @NotNull CloneStrategy strategy)

Description copied from interface: PrismValue

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface PrismContainerValue<C extends Containerable>

Specified by:

cloneComplex in interface PrismValue

See Also:

• CloneStrategy

findOrCreateContainer

default <T extends Containerable> PrismContainer<T> findOrCreateContainer(QName containerName)
                                                                   throws SchemaException

Specified by:

findOrCreateContainer in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

findItem

default <IV extends PrismValue,
ID extends ItemDefinition<?>>
Item<IV,ID> findItem(ItemPath itemPath)

Specified by:

findItem in interface PrismContainerValue<C extends Containerable>

containsItem

default boolean containsItem(ItemPath propPath,
 boolean acceptEmptyItem)
                      throws SchemaException

Specified by:

containsItem in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

contains

default boolean contains(Item item)

Specified by:

contains in interface PrismContainerValue<C extends Containerable>

removeItems

default void removeItems(List<? extends ItemPath> itemsToRemove)

Specified by:

removeItems in interface PrismContainerValue<C extends Containerable>

findProperty

default <X> PrismProperty<X> findProperty(PrismPropertyDefinition<X> propertyDefinition)

Description copied from interface: PrismContainerValue

Finds a specific property in the container by definition.

Returns null if nothing is found.

Specified by:

findProperty in interface PrismContainerValue<C extends Containerable>

Parameters:

propertyDefinition - property definition to find.

Returns:

found property or null

findPartial

default <IV extends PrismValue,
ID extends ItemDefinition<?>>
PartiallyResolvedItem<IV,ID> findPartial(ItemPath path)

Specified by:

findPartial in interface PrismContainerValue<C extends Containerable>

asContainerable

@NotNull
default C asContainerable()

Specified by:

asContainerable in interface PrismContainerValue<C extends Containerable>

createProperty

default <X> PrismProperty<X> createProperty(QName propertyName)
                                     throws SchemaException

Specified by:

createProperty in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

findOrCreateItem

default <IV extends PrismValue,
ID extends ItemDefinition<?>,
I extends Item<IV,
ID>>
I findOrCreateItem(QName containerName,
 Class<I> type)
            throws SchemaException

Specified by:

findOrCreateItem in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

removePaths

default void removePaths(List<? extends ItemPath> remove)
                  throws SchemaException

Specified by:

removePaths in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

removeMetadataFromPaths

default void removeMetadataFromPaths(List<? extends ItemPath> pathsToRemoveMetadata)
                              throws SchemaException

Description copied from interface: PrismContainerValue

Remove metadata from specified paths Can also remove metadata from the object on which it's called, if the paths contains a "root" path (e.g. ItemPath.fromString("/")).

Specified by:

removeMetadataFromPaths in interface PrismContainerValue<C extends Containerable>

Parameters:

pathsToRemoveMetadata - the paths to items on which metadata should be removed.

Throws:

SchemaException

merge

default <IV extends PrismValue,
ID extends ItemDefinition<?>>
boolean merge(Item<IV,ID> item)
       throws SchemaException

Description copied from interface: PrismContainerValue

Merges the provided item into this item. The values are joined together. Returns true if new item or value was added.

Specified by:

merge in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

canRepresent

default boolean canRepresent(Class<?> clazz)

Specified by:

canRepresent in interface PrismContainerValue<C extends Containerable>

setPropertyRealValue

default <T> void setPropertyRealValue(QName propertyName,
 T realValue)
                               throws SchemaException

Specified by:

setPropertyRealValue in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

checkNothingExceptFor

default void checkNothingExceptFor(QName... allowedItemNames)

Description copied from interface: PrismContainerValue

For simplicity, everything must be qualified: names to check, and existing names.

Specified by:

checkNothingExceptFor in interface PrismContainerValue<C extends Containerable>

applyDefinition

default PrismContainerValue<C> applyDefinition(@NotNull
 @NotNull PrismContainerDefinition<C> containerDef,
 boolean force)
                                        throws SchemaException

Specified by:

applyDefinition in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

findReference

default PrismReference findReference(QName elementName)

Specified by:

findReference in interface PrismContainerValue<C extends Containerable>

findItem

default <IV extends PrismValue,
ID extends ItemDefinition<?>,
I extends Item<IV,
ID>>
I findItem(ItemPath itemPath,
 Class<I> type)

Specified by:

findItem in interface PrismContainerValue<C extends Containerable>

acceptParentVisitor

default void acceptParentVisitor(Visitor visitor)

Specified by:

acceptParentVisitor in interface ParentVisitable

Specified by:

acceptParentVisitor in interface PrismContainerValue<C extends Containerable>

createDetachedSubItem

default <IV extends PrismValue,
ID extends ItemDefinition<?>,
I extends Item<IV,
ID>>
I createDetachedSubItem(QName name,
 Class<I> type,
 ID itemDefinition,
 boolean immutable)
                 throws SchemaException,
PrismContainerValue.RemovedItemDefinitionException

Specified by:

createDetachedSubItem in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

PrismContainerValue.RemovedItemDefinitionException

createProperty

default <X> PrismProperty<X> createProperty(PrismPropertyDefinition<X> propertyDefinition)
                                     throws SchemaException

Specified by:

createProperty in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

asSingleValuedContainer

default PrismContainer<C> asSingleValuedContainer(@NotNull
 @NotNull QName itemName)
                                           throws SchemaException

Description copied from interface: PrismContainerValue

Returns a single-valued container (with a single-valued definition) holding just this value.

Specified by:

asSingleValuedContainer in interface PrismContainerValue<C extends Containerable>

Parameters:

itemName - Item name for newly-created container.

Throws:

SchemaException

findOrCreateItem

default <IV extends PrismValue,
ID extends ItemDefinition<?>>
Item<IV,ID> findOrCreateItem(QName containerName)
                      throws SchemaException

Specified by:

findOrCreateItem in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

replace

default <IV extends PrismValue,
ID extends ItemDefinition<?>>
void replace(Item<IV,ID> oldItem,
 Item<IV,ID> newItem)
      throws SchemaException

Specified by:

replace in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

setOriginObject

default void setOriginObject(Objectable source)

Specified by:

setOriginObject in interface MidpointOriginMetadata

setOriginType

default void setOriginType(OriginType type)

Specified by:

setOriginType in interface MidpointOriginMetadata

getOriginType

default OriginType getOriginType()

Specified by:

getOriginType in interface MidpointOriginMetadata

getOriginObject

default Objectable getOriginObject()

Specified by:

getOriginObject in interface MidpointOriginMetadata

getUserData

default Object getUserData(@NotNull
 @NotNull String key)

Specified by:

getUserData in interface PrismValue

getUserData

default Map<String,Object> getUserData()

Specified by:

getUserData in interface PrismValue

isRaw

default boolean isRaw()

Specified by:

isRaw in interface PrismValue

isTransient

@Experimental
default boolean isTransient()

Specified by:

isTransient in interface PrismValue

Returns:

True if the value is transient, so it won't be serialized if serialization of transient value is disabled.

normalize

default void normalize()

Description copied from interface: PrismValue

Currently doing nothing.

Specified by:

normalize in interface PrismValue

getRealValueIfExists

@Experimental
@Nullable
default @Nullable Object getRealValueIfExists()

Specified by:

getRealValueIfExists in interface PrismValue

isOfType

@Experimental
default boolean isOfType(@NotNull
 @NotNull QName expectedTypeName)

Description copied from interface: PrismValue

Ignores untyped values (considers them non-matching). Supports non-static types. (May be slower.)

Specified by:

isOfType in interface PrismValue

hasRealClass

@Experimental
default boolean hasRealClass()

Specified by:

hasRealClass in interface PrismValue

deleteValueMetadata

default void deleteValueMetadata()

Specified by:

deleteValueMetadata in interface PrismValue

clearParent

default void clearParent()

Description copied from interface: PrismValue

Used when we are removing the value from the previous parent. Or when we know that the previous parent will be discarded and we want to avoid unnecessary cloning.

Specified by:

clearParent in interface PrismValue

equals

default boolean equals(PrismValue otherValue,
 @NotNull
 @NotNull EquivalenceStrategy strategy)

Specified by:

equals in interface PrismValue

equals

default boolean equals(PrismValue otherValue,
 @NotNull
 @NotNull ParameterizedEquivalenceStrategy strategy)

Specified by:

equals in interface PrismValue

getAllValues

@NotNull
default @NotNull Collection<PrismValue> getAllValues(ItemPath path)

Description copied from interface: PrismValue

See Item.getAllValues(ItemPath).

Specified by:

getAllValues in interface PrismValue

setUserData

default void setUserData(@NotNull
 @NotNull String key,
 Object value)

Specified by:

setUserData in interface PrismValue

setParent

default void setParent(Itemable parent)

Specified by:

setParent in interface PrismValue

getValueMetadata

@NotNull
default @NotNull ValueMetadata getValueMetadata()

Description copied from interface: PrismValue

Returns the value metadata, creating empty one if there's none. When performance is critical, consider using PrismValue.getValueMetadataIfExists() instead; or call PrismValue.hasValueMetadata() first.

Specified by:

getValueMetadata in interface PrismValue

getValueMetadataIfExists

@Nullable
default @Nullable ValueMetadata getValueMetadataIfExists()

Description copied from interface: PrismValue

Returns the value metadata, if there is any.

Specified by:

getValueMetadataIfExists in interface PrismValue

setTransient

@Experimental
default void setTransient(boolean value)

Specified by:

setTransient in interface PrismValue

isEmpty

default boolean isEmpty()

Specified by:

isEmpty in interface PrismValue

applyDefinitionLegacy

default void applyDefinitionLegacy(@NotNull
 @NotNull ItemDefinition<?> definition,
 boolean force)
                            throws SchemaException

Description copied from interface: PrismValue

Definition application MAY change the value (currently only for container/reference values). The caller must deal with that.

Specified by:

applyDefinitionLegacy in interface PrismValue

Throws:

SchemaException

getRealValueOrRawType

@Experimental
@Nullable
default @Nullable Object getRealValueOrRawType()

Specified by:

getRealValueOrRawType in interface PrismValue

getValueMetadataAsContainer

@Experimental
@NotNull
default <C extends Containerable>
@NotNull PrismContainer<C> getValueMetadataAsContainer()

Description copied from interface: PrismValue

Returns value metadata as typed PrismContainer. Useful for lazy clients because of the type matching.

Specified by:

getValueMetadataAsContainer in interface PrismValue

getSchemaContext

default SchemaContext getSchemaContext()

Specified by:

getSchemaContext in interface PrismValue

getNearestValueOfType

@Nullable
default <T> T getNearestValueOfType(@NotNull
 @NotNull Class<T> type)

Specified by:

getNearestValueOfType in interface PrismValue

cloneIfImmutable

@NotNull
default @NotNull PrismValue cloneIfImmutable()

Specified by:

cloneIfImmutable in interface PrismValue

diff

default Collection<? extends ItemDelta> diff(PrismValue otherValue,
 ParameterizedEquivalenceStrategy strategy)

Description copied from interface: PrismValue

Assumes matching representations. I.e. it assumes that both this and otherValue represent the same instance of item. E.g. the container with the same ID.

Specified by:

diff in interface PrismValue

getRealClass

@Nullable
default @Nullable Class<?> getRealClass()

Specified by:

getRealClass in interface PrismValue

getAllItems

@NotNull
default @NotNull Collection<Item<?,?>> getAllItems(@NotNull
 @NotNull ItemPath path)

Description copied from interface: PrismValue

See Item.getAllItems(ItemPath). Here the path is never empty.

Specified by:

getAllItems in interface PrismValue

hasValueMetadata

default boolean hasValueMetadata()

Specified by:

hasValueMetadata in interface PrismValue

Returns:

True if this value has any metadata (i.e. the metadata container has any value). TODO Or should we accept only non-empty values? Probably not.

setValueMetadata

@Experimental
default void setValueMetadata(ValueMetadata valueMetadata)

Description copied from interface: PrismValue

Sets metadata for this value.

Specified by:

setValueMetadata in interface PrismValue

setValueMetadata

@Experimental
default void setValueMetadata(PrismContainer<?> valueMetadata)

Description copied from interface: PrismValue

Sets metadata for this value.

Specified by:

setValueMetadata in interface PrismValue

setValueMetadata

@Experimental
default void setValueMetadata(Containerable realValue)
                       throws SchemaException

Description copied from interface: PrismValue

Sets metadata from this value (from PCV). To be removed (most probably).

Specified by:

setValueMetadata in interface PrismValue

Throws:

SchemaException

hashCode

default int hashCode(@NotNull
 @NotNull ParameterizedEquivalenceStrategy equivalenceStrategy)

Specified by:

hashCode in interface PrismValue

find

default Object find(ItemPath path)

Specified by:

find in interface PrismValue

isObjectable

default boolean isObjectable()

Description copied from interface: PrismValue

Returns `true` if this value represents a PrismObject value. Temporary implementation that uses real value to do the check, as PrismObjectValue can mask itself as a PrismContainerValue, at least for now.

Specified by:

isObjectable in interface PrismValue

getParentContainerValue

default PrismContainerValue<?> getParentContainerValue()

Specified by:

getParentContainerValue in interface PrismValue

getPath

@NotNull
default @NotNull ItemPath getPath()

Specified by:

getPath in interface PrismValue

applyDefinitionLegacy

default void applyDefinitionLegacy(@NotNull
 @NotNull ItemDefinition<?> definition)
                            throws SchemaException

Description copied from interface: PrismValue

This one checks that nothing has changed.

Specified by:

applyDefinitionLegacy in interface PrismValue

Throws:

SchemaException

checkConsistenceInternal

default void checkConsistenceInternal(Itemable rootItem,
 boolean requireDefinitions,
 boolean prohibitRaw,
 ConsistencyCheckScope scope)

Specified by:

checkConsistenceInternal in interface PrismValue

hashCode

default int hashCode(@NotNull
 @NotNull EquivalenceStrategy equivalenceStrategy)

Specified by:

hashCode in interface PrismValue

representsSameValue

default boolean representsSameValue(PrismValue other,
 EquivalenceStrategy strategy,
 boolean lax)

Description copied from interface: PrismValue

Returns true if this and other value represent the same value. E.g. if they have the same IDs, OIDs or it is otherwise know that they "belong together" without a deep examination of the values.

Specified by:

representsSameValue in interface PrismValue

lax - If we can reasonably assume that the two values belong together even if they don't have the same ID, e.g. if they both belong to single-valued parent items. This is useful e.g. when comparing multi-valued containers. But can cause problems when we want to be sure we are removing the correct value.

recompute

default void recompute()

Description copied from interface: PrismValue

Recompute the value or otherwise "initialize" it before adding it to a prism tree. This may as well do nothing if no recomputing or initialization is needed.

Specified by:

recompute in interface PrismValue

toHumanReadableString

default String toHumanReadableString()

Specified by:

toHumanReadableString in interface PrismValue

setId

default void setId(Long id)

Specified by:

setId in interface PrismContainerValue<C extends Containerable>

getRealValue

@Nullable
default <T> T getRealValue()

Description copied from interface: PrismValue

Returns the statically-typed "real value". TODO specify when exactly the returned value can be null. TODO decide for containers: they throw an exception if the value is not statically typed.

Specified by:

getRealValue in interface PrismValue

walk

default void walk(BiPredicate<? super ItemPath,Boolean> descendPredicate,
 Predicate<? super ItemPath> consumePredicate,
 Consumer<? super Item<?,?>> itemConsumer)
           throws SchemaException

Description copied from interface: Walkable

Walk through hierarchy of containing items based on provided conditions. Caller can provide two types of conditions. One (consumePredicate) is used to decide if currently iterated item should be consumed (by provided itemConsumer). Second (descendPredicate) tells, if walk should descend into currently iterated item. Descending condition is a BiPredicate in order to allow caller decide not just based on item path, but also based on the fact if the item was also consumed (depending on implementation, the results of consumePredicate could be directly passed to the descending condition).

Specified by:

walk in interface Walkable

Parameters:

descendPredicate - the BiPredicate which tells whether to descend into current item. Boolean parameter tells whether the item was also consumed or not.

consumePredicate - the Predicate which tells whether to consume current item.

itemConsumer - the consumer to consume item with if it passes the consumePredicate test.

Throws:

SchemaException - when something wrong happen during the walk.