Package com.evolveum.midpoint.prism.impl

Class PrismValueImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.PrismValueImpl

All Implemented Interfaces:

Freezable, ItemDefinitionTransformer.TransformableValue, MidpointOriginMetadata, PathVisitable, PrismContextSensitive, PrismValue, Revivable, Visitable, DebugDumpable, Serializable

Direct Known Subclasses:

PrismContainerValueImpl, PrismPropertyValueImpl, PrismReferenceValueImpl

public abstract class PrismValueImpl
extends AbstractFreezable
implements PrismValue, ItemDefinitionTransformer.TransformableValue

Author:

semancik

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected EquivalenceStrategy	defaultEquivalenceStrategy

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)
void	accept(Visitor visitor, ItemPath path, boolean recursive)
protected void	appendOriginDump(StringBuilder builder)
void	applyDefinition(ItemDefinition definition)
void	applyDefinition(ItemDefinition definition, boolean force)
abstract void	checkConsistenceInternal(Itemable rootItem, boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
void	clearParent()	Used when we are removing the value from the previous parent.
abstract PrismValue	clone()	Literal clone.
abstract PrismValue	cloneComplex(CloneStrategy strategy)	Complex clone with different cloning strategies.
protected void	copyValues(CloneStrategy strategy, PrismValueImpl clone)
PrismValue	createImmutableClone()
Collection<? extends ItemDelta>	diff(PrismValue otherValue, ParameterizedEquivalenceStrategy strategy)	Assumes matching representations.
final void	diffMatchingRepresentation(PrismValue otherValue, Collection<? extends ItemDelta> deltas, ParameterizedEquivalenceStrategy strategy)
boolean	diffMatchingRepresentation(PrismValue otherValue, Collection<? extends ItemDelta> deltas, ParameterizedEquivalenceStrategy strategy, boolean exitOnDiff)
boolean	equals(PrismValue otherValue, @NotNull EquivalenceStrategy equivalenceStrategy)
boolean	equals(PrismValue other, @NotNull ParameterizedEquivalenceStrategy strategy)
boolean	equals(Object other)
@NotNull Collection<Item<?,?>>	getAllItems(@NotNull ItemPath path)	See Item.getAllItems(ItemPath).
@NotNull Collection<PrismValue>	getAllValues(ItemPath path)	See Item.getAllValues(ItemPath).
protected ItemDefinition	getDefinition()
Objectable	getOriginObject()
OriginType	getOriginType()
Itemable	getParent()
PrismContainerValue<?>	getParentContainerValue()
@NotNull ItemPath	getPath()
protected Object	getPathComponent()
PrismContext	getPrismContext()
abstract @Nullable Class<?>	getRealClass()
abstract <T> T	getRealValue()	Returns the statically-typed "real value".
@NotNull PrismValue	getRootValue()
QName	getTypeName()
Map<String,Object>	getUserData()
Object	getUserData(@NotNull String key)
@NotNull ValueMetadata	getValueMetadata()	Maybe it is better to expect empty value metadata if these are absent.
int	hashCode()
int	hashCode(@NotNull EquivalenceStrategy equivalenceStrategy)
int	hashCode(@NotNull ParameterizedEquivalenceStrategy equivalenceStrategy)
boolean	hasValueMetadata()
boolean	isTransient()
void	normalize()	Currently doing nothing.
protected void	performFreeze()
void	recompute()	Recompute the value or otherwise "initialize" it before adding it to a prism tree.
abstract void	recompute(PrismContext prismContext)
boolean	representsSameValue(PrismValue other, boolean lax)	Returns true if this and other value represent the same value.
void	revive(PrismContext prismContext)	TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)
void	setOriginObject(Objectable source)
void	setOriginType(OriginType type)
void	setParent(Itemable parent)
void	setPrismContext(PrismContext prismContext)
void	setTransient(boolean value)
void	setUserData(@NotNull String key, Object value)
void	setValueMetadata(Containerable realValue)	Sets metadata from this value (from PCV).
void	setValueMetadata(PrismContainer<?> valueMetadataContainer)	Sets metadata for this value.
void	setValueMetadata(ValueMetadata valueMetadata)	Sets metadata for this value.
abstract String	toHumanReadableString()

Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

checkImmutable, checkMutable, freeze, isImmutable

Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinitionTransformer.TransformableValue

transformDefinition

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

cloneIfImmutable, find, getNearestValueOfType, getRealValueIfExists, getRealValueOrRawType, getRootObjectable, getValueMetadataAsContainer, hasRealClass, isEmpty, isObjectable, isOfType, isRaw, valueMetadata

Field Details

defaultEquivalenceStrategy

protected EquivalenceStrategy defaultEquivalenceStrategy

Method Details

setPrismContext

public void setPrismContext(PrismContext prismContext)

Specified by:

setPrismContext in interface PrismValue

setOriginObject

public void setOriginObject(Objectable source)

Specified by:

setOriginObject in interface MidpointOriginMetadata

setOriginType

public void setOriginType(OriginType type)

Specified by:

setOriginType in interface MidpointOriginMetadata

getOriginType

public OriginType getOriginType()

Specified by:

getOriginType in interface MidpointOriginMetadata

getOriginObject

public Objectable getOriginObject()

Specified by:

getOriginObject in interface MidpointOriginMetadata

getUserData

public Map<String,Object> getUserData()

Specified by:

getUserData in interface PrismValue

getUserData

public Object getUserData(@NotNull
 @NotNull String key)

Specified by:

getUserData in interface PrismValue

setUserData

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

Specified by:

setUserData in interface PrismValue

getParent

public Itemable getParent()

Specified by:

getParent in interface PrismValue

setParent

public void setParent(Itemable parent)

Specified by:

setParent in interface PrismValue

getPath

@NotNull
public @NotNull ItemPath getPath()

Specified by:

getPath in interface PrismValue

getPathComponent

protected Object getPathComponent()

clearParent

public void clearParent()

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

getPrismContext

public PrismContext getPrismContext()

Specified by:

getPrismContext in interface PrismContextSensitive

getDefinition

protected ItemDefinition getDefinition()

applyDefinition

public void applyDefinition(ItemDefinition definition)
                     throws SchemaException

Specified by:

applyDefinition in interface PrismValue

Throws:

SchemaException

applyDefinition

public void applyDefinition(ItemDefinition definition,
 boolean force)
                     throws SchemaException

Specified by:

applyDefinition in interface PrismValue

Throws:

SchemaException

revive

public 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

recompute

public void recompute()

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

public abstract void recompute(PrismContext prismContext)

Specified by:

recompute in interface PrismValue

accept

public void accept(Visitor visitor)

Specified by:

accept in interface PrismValue

Specified by:

accept in interface Visitable

accept

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

Specified by:

accept in interface PathVisitable

Specified by:

accept in interface PrismValue

checkConsistenceInternal

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

Specified by:

checkConsistenceInternal in interface PrismValue

representsSameValue

public boolean representsSameValue(PrismValue other,
 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

public void normalize()

Description copied from interface: PrismValue

Currently doing nothing.

Specified by:

normalize in interface PrismValue

clone

public abstract PrismValue clone()

Literal clone.

Specified by:

clone in interface PrismValue

Overrides:

clone in class Object

createImmutableClone

public PrismValue createImmutableClone()

Specified by:

createImmutableClone in interface PrismValue

cloneComplex

public abstract PrismValue cloneComplex(CloneStrategy strategy)

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface PrismValue

See Also:

• CloneStrategy

copyValues

protected void copyValues(CloneStrategy strategy,
 PrismValueImpl clone)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hashCode

public int hashCode(@NotNull
 @NotNull ParameterizedEquivalenceStrategy equivalenceStrategy)

Specified by:

hashCode in interface PrismValue

hashCode

public int hashCode(@NotNull
 @NotNull EquivalenceStrategy equivalenceStrategy)

Specified by:

hashCode in interface PrismValue

equals

public boolean equals(PrismValue otherValue,
 @NotNull
 @NotNull EquivalenceStrategy equivalenceStrategy)

Specified by:

equals in interface PrismValue

equals

public boolean equals(PrismValue other,
 @NotNull
 @NotNull ParameterizedEquivalenceStrategy strategy)

Specified by:

equals in interface PrismValue

equals

public boolean equals(Object other)

Overrides:

equals in class Object

diff

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

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

diffMatchingRepresentation

public final void diffMatchingRepresentation(PrismValue otherValue,
 Collection<? extends ItemDelta> deltas,
 ParameterizedEquivalenceStrategy strategy)

diffMatchingRepresentation

public boolean diffMatchingRepresentation(PrismValue otherValue,
 Collection<? extends ItemDelta> deltas,
 ParameterizedEquivalenceStrategy strategy,
 boolean exitOnDiff)

appendOriginDump

protected void appendOriginDump(StringBuilder builder)

toHumanReadableString

public abstract String toHumanReadableString()

Specified by:

toHumanReadableString in interface PrismValue

getRealClass

@Nullable
public abstract @Nullable Class<?> getRealClass()

Specified by:

getRealClass in interface PrismValue

getRealValue

@Nullable
public abstract <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

getRootValue

@NotNull
public @NotNull PrismValue getRootValue()

Specified by:

getRootValue in interface PrismValue

getParentContainerValue

public PrismContainerValue<?> getParentContainerValue()

Specified by:

getParentContainerValue in interface PrismValue

getTypeName

public QName getTypeName()

Specified by:

getTypeName in interface PrismValue

getAllValues

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

Description copied from interface: PrismValue

See Item.getAllValues(ItemPath).

Specified by:

getAllValues in interface PrismValue

getAllItems

@NotNull
public @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

getValueMetadata

@NotNull
public @NotNull ValueMetadata getValueMetadata()

Description copied from interface: PrismValue

Maybe it is better to expect empty value metadata if these are absent. Client code would be simpler. HIGHLY EXPERIMENTAL.

Specified by:

getValueMetadata in interface PrismValue

hasValueMetadata

public 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

public void setValueMetadata(ValueMetadata valueMetadata)

Description copied from interface: PrismValue

Sets metadata for this value.

Specified by:

setValueMetadata in interface PrismValue

setValueMetadata

public void setValueMetadata(PrismContainer<?> valueMetadataContainer)

Description copied from interface: PrismValue

Sets metadata for this value.

Specified by:

setValueMetadata in interface PrismValue

setValueMetadata

public 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

performFreeze

protected void performFreeze()

Overrides:

performFreeze in class AbstractFreezable

isTransient

public 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

public void setTransient(boolean value)

Specified by:

setTransient in interface PrismValue