Package com.evolveum.midpoint.prism.deleg

Interface PrismValueDelegator

All Superinterfaces:

ComplexCopyable<PrismValue>, DebugDumpable, Freezable, MidpointOriginMetadata, PathVisitable, PrismValue, PrismVisitable, Revivable, SchemaLookup.Aware, Serializable, Visitable

All Known Subinterfaces:

PrismContainerValueDelegator<C>, PrismObjectValueDelegator<O>, PrismPropertyValueDelegator<T>, PrismReferenceValueDelegator

All Known Implementing Classes:

FlyweightClonedValue, GenericLazyPrismContainerValue

public interface PrismValueDelegator
extends PrismValue

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 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 PrismValue	applyDefinition(@NotNull ItemDefinition<?> definition)	Definition application MAY change the value (currently only for container values).
default PrismValue	applyDefinition(@NotNull ItemDefinition<?> definition, boolean force)	Definition application MAY change the value (currently only for container values).
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 void	checkConsistenceInternal(Itemable rootItem, boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
default void	clearParent()	Used when we are removing the value from the previous parent.
default PrismValue	clone()	Literal clone.
default PrismValue	cloneComplex(@NotNull CloneStrategy strategy)	Complex clone with different cloning strategies.
default @NotNull PrismValue	cloneIfImmutable()
default PrismValue	createImmutableClone()
default String	debugDump()	Show the content of the object intended for diagnostics by system administrator.
default String	debugDump(int indent)
default Object	debugDumpLazily()
default Object	debugDumpLazily(int indent)
PrismValue	delegate()
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 Object	find(ItemPath path)
default @NotNull Collection<Item<?,?>>	getAllItems(@NotNull ItemPath path)	See Item.getAllItems(ItemPath).
default @NotNull Collection<PrismValue>	getAllValues(ItemPath path)	See Item.getAllValues(ItemPath).
default <T> T	getNearestValueOfType(@NotNull Class<T> type)
default Objectable	getOriginObject()
default OriginType	getOriginType()
default Itemable	getParent()
default PrismContainerValue<?>	getParentContainerValue()
default @NotNull ItemPath	getPath()
default @Nullable Class<?>	getRealClass()
default <T> T	getRealValue()	Returns the statically-typed "real value".
default @Nullable Object	getRealValueIfExists()
default @Nullable Object	getRealValueOrRawType()
default @Nullable Objectable	getRootObjectable()	Returns the top-most object (Objectable).
default @NotNull PrismValue	getRootValue()
default SchemaContext	getSchemaContext()
default QName	getTypeName()
default Map<String,Object>	getUserData()
default Object	getUserData(@NotNull String key)
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 int	hashCode(@NotNull EquivalenceStrategy equivalenceStrategy)
default int	hashCode(@NotNull ParameterizedEquivalenceStrategy equivalenceStrategy)
default boolean	hasRealClass()
default boolean	hasValueMetadata()
default boolean	isEmpty()
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	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 boolean	representsSameValue(PrismValue other, EquivalenceStrategy strategy, boolean lax)	Returns true if this and other value represent the same value.
default SchemaLookup	schemaLookup()
default void	setOriginObject(Objectable source)
default void	setOriginType(OriginType type)
default void	setParent(Itemable parent)
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 String	toHumanReadableString()

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

checkImmutable, checkMutable, freeze, isImmutable

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

copy, immutableCopy, mutableCopy

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

revive

Method Details

delegate

PrismValue delegate()

getUserData

default Map<String,Object> getUserData()

Specified by:

getUserData in interface PrismValue

getUserData

default Object getUserData(@NotNull
 @NotNull String key)

Specified by:

getUserData in interface PrismValue

setUserData

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

Specified by:

setUserData in interface PrismValue

getParent

default Itemable getParent()

Specified by:

getParent 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

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

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

deleteValueMetadata

default void deleteValueMetadata()

Specified by:

deleteValueMetadata in interface PrismValue

getPath

@NotNull
default @NotNull ItemPath getPath()

Specified by:

getPath 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

applyDefinition

default PrismValue applyDefinition(@NotNull
 @NotNull ItemDefinition<?> definition)
                            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 PrismValue

Throws:

SchemaException

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

applyDefinition

default PrismValue applyDefinition(@NotNull
 @NotNull ItemDefinition<?> definition,
 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 PrismValue

Throws:

SchemaException

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

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

recompute

default void recompute(PrismContext prismContext)

Specified by:

recompute in interface PrismValue

accept

default void accept(Visitor visitor)

Specified by:

accept in interface PrismValue

Specified by:

accept in interface Visitable

accept

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

Specified by:

accept in interface PathVisitable

Specified by:

accept in interface PrismValue

checkConsistenceInternal

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

Specified by:

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

normalize

default void normalize()

Description copied from interface: PrismValue

Currently doing nothing.

Specified by:

normalize in interface PrismValue

clone

default PrismValue clone()

Description copied from interface: PrismValue

Literal clone.

Specified by:

clone in interface PrismValue

createImmutableClone

default PrismValue createImmutableClone()

Specified by:

createImmutableClone in interface PrismValue

cloneComplex

default PrismValue cloneComplex(@NotNull
 @NotNull CloneStrategy strategy)

Description copied from interface: PrismValue

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface ComplexCopyable<PrismValue>

Specified by:

cloneComplex in interface PrismValue

See Also:

• CloneStrategy

hashCode

default int hashCode(@NotNull
 @NotNull EquivalenceStrategy equivalenceStrategy)

Specified by:

hashCode in interface PrismValue

hashCode

default int hashCode(@NotNull
 @NotNull ParameterizedEquivalenceStrategy equivalenceStrategy)

Specified by:

hashCode 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

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

hasRealClass

@Experimental
default boolean hasRealClass()

Specified by:

hasRealClass in interface PrismValue

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

getRealValueOrRawType

@Experimental
@Nullable
default @Nullable Object getRealValueOrRawType()

Specified by:

getRealValueOrRawType in interface PrismValue

getRealValueIfExists

@Experimental
@Nullable
default @Nullable Object getRealValueIfExists()

Specified by:

getRealValueIfExists in interface PrismValue

getRootValue

@NotNull
default @NotNull PrismValue getRootValue()

Specified by:

getRootValue in interface PrismValue

getRootObjectable

@Nullable
default @Nullable Objectable getRootObjectable()

Description copied from interface: PrismValue

Returns the top-most object (Objectable).

Specified by:

getRootObjectable in interface PrismValue

getNearestValueOfType

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

Specified by:

getNearestValueOfType in interface PrismValue

getParentContainerValue

default PrismContainerValue<?> getParentContainerValue()

Specified by:

getParentContainerValue in interface PrismValue

getTypeName

default QName getTypeName()

Specified by:

getTypeName 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

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

isRaw

default boolean isRaw()

Specified by:

isRaw in interface PrismValue

isEmpty

default boolean isEmpty()

Specified by:

isEmpty in interface PrismValue

toHumanReadableString

default String toHumanReadableString()

Specified by:

toHumanReadableString in interface PrismValue

find

default Object find(ItemPath path)

Specified by:

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

setTransient

@Experimental
default void setTransient(boolean value)

Specified by:

setTransient 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

cloneIfImmutable

@NotNull
default @NotNull PrismValue cloneIfImmutable()

Specified by:

cloneIfImmutable 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

getSchemaContext

default SchemaContext getSchemaContext()

Specified by:

getSchemaContext in interface PrismValue

schemaLookup

default SchemaLookup schemaLookup()

Specified by:

schemaLookup in interface PrismValue

Specified by:

schemaLookup in interface SchemaLookup.Aware

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 PrismValue

Specified by:

acceptVisitor in interface PrismVisitable

Returns:

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

debugDump

default String debugDump()

Description copied from interface: DebugDumpable

Show the content of the object intended for diagnostics by system administrator. The out put should be suitable to use in system logs at "debug" level. It may be multi-line, but in that case it should be well indented and quite terse. As it is intended to be used by system administrator, it should not use any developer terms such as class names, exceptions or stack traces.

Specified by:

debugDump in interface DebugDumpable

Returns:

content of the object intended for diagnostics by system administrator.

debugDump

default String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

debugDumpLazily

default Object debugDumpLazily()

Specified by:

debugDumpLazily in interface DebugDumpable

debugDumpLazily

default Object debugDumpLazily(int indent)

Specified by:

debugDumpLazily in interface DebugDumpable

getOriginObject

default Objectable getOriginObject()

Specified by:

getOriginObject in interface MidpointOriginMetadata

getOriginType

default OriginType getOriginType()

Specified by:

getOriginType in interface MidpointOriginMetadata

setOriginType

default void setOriginType(OriginType type)

Specified by:

setOriginType in interface MidpointOriginMetadata

setOriginObject

default void setOriginObject(Objectable source)

Specified by:

setOriginObject in interface MidpointOriginMetadata