Package com.evolveum.midpoint.prism.deleg

Interface PrismContainerValueDelegator<C extends Containerable>

All Superinterfaces:

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

All Known Subinterfaces:

PrismObjectValueDelegator<O>

All Known Implementing Classes:

GenericLazyPrismContainerValue

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

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 boolean	acceptVisitor(PrismVisitor visitor)	Accept visitor and visits prism item or value and it's children Note: name is not accept, but accept visitor to prevent naming conflict in lambdas dynamic languages such as groovy with Visitable.accept(com.evolveum.midpoint.prism.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 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	checkNothingExceptFor(QName... allowedItemNames)	For simplicity, everything must be qualified: names to check, and existing names.
default void	clear()
default PrismContainerValue<C>	clone()	Literal clone.
default PrismContainerValue<C>	cloneComplex(@NotNull CloneStrategy strategy)	Complex clone with different cloning strategies.
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 boolean	equivalent(PrismContainerValue<?> other)
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 Class<C>	getCompileTimeClass()
default @Nullable ComplexTypeDefinition	getComplexTypeDefinition()
default PrismContainer<C>	getContainer()
default PrismContainerDefinition<C>	getDefinition()
default Long	getId()
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 PrismContainerable<C>	getParent()
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 @NotNull PrismContainerValue<?>	getRootValue()
default C	getValue()
default boolean	hasCompleteDefinition()	Returns true if all contained items have complete definitions.
default boolean	hasNoItems()	Like isEmpty but ignores presence of container value ID.
default boolean	isIdOnly()
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	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)	BEWARE!!
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 void	revive(PrismContext prismContext)	TODO: Is revive necessary if prism context is static?
default SchemaLookup	schemaLookup()
default void	setId(Long id)
default void	setOriginTypeRecursive(OriginType originType)	Set origin type to all values and subvalues
default <T> void	setPropertyRealValue(QName propertyName, T realValue)
default int	size()
default <IV extends PrismValue, ID extends ItemDefinition<?>> boolean	subtract(Item<IV,ID> item)	Subtract the provided item from this item.
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.prism.Freezable

checkImmutable, checkMutable, freeze, isImmutable

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

copy, immutableCopy, mutableCopy

Methods inherited from interface com.evolveum.midpoint.prism.deleg.PrismValueDelegator

applyDefinitionLegacy, applyDefinitionLegacy, checkConsistenceInternal, clearParent, cloneIfImmutable, debugDump, debugDump, debugDumpLazily, debugDumpLazily, deleteValueMetadata, diff, equals, equals, find, getAllItems, getAllValues, getNearestValueOfType, getOriginObject, getOriginType, getParentContainerValue, getPath, getRealClass, getRealValue, getRealValueIfExists, getRealValueOrRawType, getRootObjectable, getSchemaContext, getTypeName, getUserData, getUserData, getValueMetadata, getValueMetadataAsContainer, getValueMetadataIfExists, hashCode, hashCode, hasRealClass, hasValueMetadata, isEmpty, isObjectable, isOfType, isRaw, isTransient, normalize, recompute, representsSameValue, setOriginObject, setOriginType, setParent, setTransient, setUserData, setValueMetadata, setValueMetadata, setValueMetadata, toHumanReadableString

Method Details

delegate

PrismContainerValue<C> delegate()

Specified by:

delegate in interface PrismValueDelegator

acceptVisitor

default boolean acceptVisitor(PrismVisitor visitor)

Description copied from interface: PrismVisitable

Accept visitor and visits prism item or value and it's children Note: name is not accept, but accept visitor to prevent naming conflict in lambdas dynamic languages such as groovy with Visitable.accept(com.evolveum.midpoint.prism.Visitor)

Specified by:

acceptVisitor in interface PrismContainerValue<C extends Containerable>

Specified by:

acceptVisitor in interface PrismValue

Specified by:

acceptVisitor in interface PrismValueDelegator

Specified by:

acceptVisitor in interface PrismVisitable

Returns:

return value of PrismVisitor.visit(PrismVisitable) invocation for this visitable.

schemaLookup

default SchemaLookup schemaLookup()

Specified by:

schemaLookup in interface PrismContainerValue<C extends Containerable>

Specified by:

schemaLookup in interface PrismValue

Specified by:

schemaLookup in interface PrismValueDelegator

Specified by:

schemaLookup in interface SchemaLookup.Aware

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>

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>

acceptParentVisitor

default void acceptParentVisitor(Visitor visitor)

Specified by:

acceptParentVisitor in interface ParentVisitable

Specified by:

acceptParentVisitor in interface PrismContainerValue<C extends Containerable>

getDefinition

default PrismContainerDefinition<C> getDefinition()

Specified by:

getDefinition in interface PrismContainerValue<C extends Containerable>

removeOperationalItems

default void removeOperationalItems()

Specified by:

removeOperationalItems in interface PrismContainerValue<C extends Containerable>

removeItems

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

Description copied from interface: PrismContainerValue

BEWARE!! Assumes the container has no parent! Otherwise item.getPath() provides wrong values.

Specified by:

removeItems in interface PrismContainerValue<C extends Containerable>

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

removePaths

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

Specified by:

removePaths in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

keepPaths

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

Specified by:

keepPaths in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

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>

getRootValue

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

Specified by:

getRootValue in interface PrismContainerValue<C extends Containerable>

Specified by:

getRootValue in interface PrismValue

Specified by:

getRootValue in interface PrismValueDelegator

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

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

getComplexTypeDefinition

@Nullable
default @Nullable ComplexTypeDefinition getComplexTypeDefinition()

Specified by:

getComplexTypeDefinition in interface PrismContainerValue<C extends Containerable>

equivalent

default boolean equivalent(PrismContainerValue<?> other)

Specified by:

equivalent 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 ComplexCopyable<C extends Containerable>

Specified by:

cloneComplex in interface PrismContainerValue<C extends Containerable>

Specified by:

cloneComplex in interface PrismValue

Specified by:

cloneComplex in interface PrismValueDelegator

See Also:

• CloneStrategy

createImmutableClone

default PrismContainerValue<C> createImmutableClone()

Specified by:

createImmutableClone in interface PrismContainerValue<C extends Containerable>

Specified by:

createImmutableClone in interface PrismValue

Specified by:

createImmutableClone in interface PrismValueDelegator

clone

default PrismContainerValue<C> clone()

Description copied from interface: PrismValue

Literal clone.

Specified by:

clone in interface PrismContainerValue<C extends Containerable>

Specified by:

clone in interface PrismValue

Specified by:

clone in interface PrismValueDelegator

assertDefinitions

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

Specified by:

assertDefinitions in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

assertDefinitions

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

Specified by:

assertDefinitions in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

isIdOnly

default boolean isIdOnly()

Specified by:

isIdOnly 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

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

Specified by:

applyDefinition in interface PrismValueDelegator

Throws:

SchemaException

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

Specified by:

applyDefinition in interface PrismValueDelegator

Throws:

SchemaException

removeRawElement

default boolean removeRawElement(Object element)

Specified by:

removeRawElement 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

addRawElement

default boolean addRawElement(Object element)
                       throws SchemaException

Specified by:

addRawElement in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

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,
 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

Specified by:

accept in interface PrismValueDelegator

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 PrismValueDelegator

Specified by:

accept in interface Visitable<C extends Containerable>

recompute

default void recompute(PrismContext prismContext)

Specified by:

recompute in interface PrismContainerValue<C extends Containerable>

Specified by:

recompute in interface PrismValue

Specified by:

recompute in interface PrismValueDelegator

getItemRealValue

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

Specified by:

getItemRealValue in interface PrismContainerValue<C extends Containerable>

getPropertyRealValue

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

Specified by:

getPropertyRealValue 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

removeReference

default void removeReference(ItemPath path)

Specified by:

removeReference in interface PrismContainerValue<C extends Containerable>

removeContainer

default void removeContainer(ItemPath path)

Specified by:

removeContainer in interface PrismContainerValue<C extends Containerable>

removeProperty

default void removeProperty(ItemPath path)

Specified by:

removeProperty in interface PrismContainerValue<C extends Containerable>

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>

createProperty

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

Specified by:

createProperty in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

createProperty

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

Specified by:

createProperty in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

findOrCreateProperty

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

Specified by:

findOrCreateProperty in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

findOrCreateProperty

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

Specified by:

findOrCreateProperty in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

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

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

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

findOrCreateReference

default PrismReference findOrCreateReference(QName referenceName)
                                      throws SchemaException

Specified by:

findOrCreateReference in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

findOrCreateContainer

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

Specified by:

findOrCreateContainer in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

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

containsItem

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

Specified by:

containsItem in interface PrismContainerValue<C extends Containerable>

Throws:

SchemaException

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>

findItem

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

Specified by:

findItem 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>

findReference

default PrismReference findReference(QName elementName)

Specified by:

findReference in interface PrismContainerValue<C extends Containerable>

findContainer

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

Specified by:

findContainer 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

findProperty

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

Specified by:

findProperty in interface PrismContainerValue<C extends Containerable>

findPartial

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

Specified by:

findPartial in interface PrismContainerValue<C extends Containerable>

contains

default boolean contains(ItemName itemName)

Specified by:

contains in interface PrismContainerValue<C extends Containerable>

contains

default boolean contains(Item item)

Specified by:

contains in interface PrismContainerValue<C extends Containerable>

clear

default void clear()

Specified by:

clear in interface PrismContainerValue<C extends Containerable>

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

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

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

removeAll

default void removeAll()

Specified by:

removeAll 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>

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

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

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

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

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

getItemNames

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

Specified by:

getItemNames in interface PrismContainerValue<C extends Containerable>

asContainerable

default C asContainerable(Class<C> requiredClass)

Specified by:

asContainerable in interface PrismContainerValue<C extends Containerable>

canRepresent

default boolean canRepresent(Class<?> clazz)

Specified by:

canRepresent in interface PrismContainerValue<C extends Containerable>

getCompileTimeClass

default Class<C> getCompileTimeClass()

Specified by:

getCompileTimeClass in interface PrismContainerValue<C extends Containerable>

asContainerable

@NotNull
default C asContainerable()

Specified by:

asContainerable in interface PrismContainerValue<C extends Containerable>

getValue

default C getValue()

Specified by:

getValue in interface PrismContainerValue<C extends Containerable>

getContainer

default PrismContainer<C> getContainer()

Specified by:

getContainer 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

Specified by:

getParent in interface PrismValueDelegator

setId

default void setId(Long id)

Specified by:

setId in interface PrismContainerValue<C extends Containerable>

getId

default Long getId()

Specified by:

getId 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.

size

default int size()

Specified by:

size in interface PrismContainerValue<C extends Containerable>

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.

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

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.