Package com.evolveum.midpoint.prism

Interface PrismProperty<T>

All Superinterfaces:

DebugDumpable, Freezable, Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>, Itemable, ParentVisitable, PathVisitable, PrismContextSensitive, Revivable, Serializable, Visitable

All Known Subinterfaces:

ResourceAttribute<T>

All Known Implementing Classes:

com.evolveum.midpoint.prism.impl.PrismPropertyImpl, ResourceAttributeImpl

public interface PrismProperty<T>
extends Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Property is a specific characteristic of an object. It may be considered object "attribute" or "field". For example User has fullName property that contains string value of user's full name.

Properties may be single-valued or multi-valued

Properties may contain primitive types or complex types (defined by XSD schema)

Property values are unordered, implementation may change the order of values

Duplicate values of properties should be silently removed by implementations, but clients must be able tolerate presence of duplicate values.

Operations that modify the objects work with the granularity of properties. They add/remove/replace the values of properties, but do not "see" inside the property.

Property is mutable.

Author:

Radovan Semancik

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
void	addRealValue(T valueToAdd)
default void	addRealValues(T... valuesToAdd)
void	addRealValueSkipUniquenessCheck(T valueToAdd)
void	addValue(PrismPropertyValue<T> pValueToAdd)
void	addValues(Collection<PrismPropertyValue<T>> pValuesToAdd)
PrismProperty<T>	clone()	Literal clone.
PrismProperty<T>	cloneComplex(CloneStrategy strategy)	Complex clone with different cloning strategies.
PropertyDelta<T>	createDelta()	Creates specific subclass of ItemDelta appropriate for type of item that this definition represents (e.g.
PropertyDelta<T>	createDelta(ItemPath path)
PrismProperty<T>	createImmutableClone()
boolean	deleteValue(PrismPropertyValue<T> pValueToDelete)
boolean	deleteValues(Collection<PrismPropertyValue<T>> pValuesToDelete)
PropertyDelta<T>	diff(PrismProperty<T> other)
PropertyDelta<T>	diff(PrismProperty<T> other, ParameterizedEquivalenceStrategy strategy)
<IV extends PrismValue,ID extends ItemDefinition<?>> PartiallyResolvedItem<IV,ID>	findPartial(ItemPath path)
T	getAnyRealValue()
T	getRealValue()	Returns the "real value" (content) of this item: - value contained in PrismPropertyValue - Referencable in PrismReferenceValue - Containerable in PrismContainerValue - Objectable in PrismObjectValue Note that the real value can contain operational items.
static <T> T	getRealValue(PrismProperty<T> property)
@NotNull Collection<T>	getRealValues()	Returns (potentially empty) collection of "real values".
<X> Collection<X>	getRealValues(Class<X> type)	Type override, also for compatibility.
<X> PrismPropertyValue<X>	getValue(Class<X> type)	Type override, also for compatibility.
Class<T>	getValueClass()
<X> List<PrismPropertyValue<X>>	getValues(Class<X> type)	Type override, also for compatibility.
boolean	hasRealValue(PrismPropertyValue<T> value)
void	replaceValues(Collection<PrismPropertyValue<T>> valuesToReplace)
void	setRealValue(T realValue)
void	setRealValues(T... realValues)
void	setValue(PrismPropertyValue<T> value)	Means as a short-hand for setting just a value for single-valued attributes.
String	toHumanReadableString()

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

acceptParentVisitor, add, add, addAll, addAll, addIgnoringEquivalents, addRespectingMetadataAndCloning, applyDefinition, applyDefinition, assertDefinitions, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistenceInternal, clear, contains, contains, copy, diff, diff, equals, equals, equals, filterValues, filterYields, find, findValue, findValue, getAllItems, getAllValues, getAnyValue, getAnyValue, getClonedValues, getDefinition, getDisplayName, getElementName, getHelp, getHighestId, getParent, getPath, getPrismContextLocal, getRealValue, getRealValuesArray, getRealValuesOrRawTypes, getUserData, getUserData, getValue, getValues, hasAnyValue, hasCompleteDefinition, hashCode, hashCode, hashCode, hasNoValues, hasRaw, isEmpty, isIncomplete, isOperational, isRaw, isSingleValue, isSingleValueByDefinition, merge, normalize, recomputeAllValues, remove, remove, removeAll, removeIf, removeRespectingMetadata, replace, replaceAll, setDefinition, setElementName, setIncomplete, setParent, setPrismContext, setUserData, size, valuesStream

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

accept

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

getPrismContext

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

revive

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

accept

Method Detail

getValues

<X> List<PrismPropertyValue<X>> getValues(Class<X> type)

Type override, also for compatibility.

getRealValues

@NotNull
@NotNull Collection<T> getRealValues()

Description copied from interface: Item

Returns (potentially empty) collection of "real values".

Specified by:

getRealValues in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

getRealValues

<X> Collection<X> getRealValues(Class<X> type)

Type override, also for compatibility.

getAnyRealValue

T getAnyRealValue()

getRealValue

T getRealValue()

Description copied from interface: Item

Returns the "real value" (content) of this item: - value contained in PrismPropertyValue - Referencable in PrismReferenceValue - Containerable in PrismContainerValue - Objectable in PrismObjectValue Note that the real value can contain operational items. It can also contain container IDs (although they are not considered to be part of the real value). It does not contain information about item element name nor other metadata like origin, definition, etc. (Although e.g. Containerable can be converted back into PrismContainerValue that can be used to retrieve this information.)

Specified by:

getRealValue in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

getValue

<X> PrismPropertyValue<X> getValue(Class<X> type)

Type override, also for compatibility.

setValue

void setValue(PrismPropertyValue<T> value)

Means as a short-hand for setting just a value for single-valued attributes. Will remove all existing values.

setRealValue

void setRealValue(T realValue)

setRealValues

void setRealValues(T... realValues)

addValues

void addValues(Collection<PrismPropertyValue<T>> pValuesToAdd)

addValue

void addValue(PrismPropertyValue<T> pValueToAdd)

addRealValue

void addRealValue(T valueToAdd)

addRealValueSkipUniquenessCheck

void addRealValueSkipUniquenessCheck(T valueToAdd)

addRealValues

default void addRealValues(T... valuesToAdd)

deleteValues

boolean deleteValues(Collection<PrismPropertyValue<T>> pValuesToDelete)

deleteValue

boolean deleteValue(PrismPropertyValue<T> pValueToDelete)

replaceValues

void replaceValues(Collection<PrismPropertyValue<T>> valuesToReplace)

hasRealValue

boolean hasRealValue(PrismPropertyValue<T> value)

getValueClass

Class<T> getValueClass()

createDelta

PropertyDelta<T> createDelta()

Description copied from interface: Item

Creates specific subclass of ItemDelta appropriate for type of item that this definition represents (e.g. PropertyDelta, ContainerDelta, ...)

Specified by:

createDelta in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

createDelta

PropertyDelta<T> createDelta(ItemPath path)

Specified by:

createDelta in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

findPartial

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

Specified by:

findPartial in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

diff

PropertyDelta<T> diff(PrismProperty<T> other)

diff

PropertyDelta<T> diff(PrismProperty<T> other,
                      ParameterizedEquivalenceStrategy strategy)

clone

PrismProperty<T> clone()

Description copied from interface: Item

Literal clone.

Specified by:

clone in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

createImmutableClone

PrismProperty<T> createImmutableClone()

Specified by:

createImmutableClone in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

cloneComplex

PrismProperty<T> cloneComplex(CloneStrategy strategy)

Description copied from interface: Item

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

See Also:

CloneStrategy

toHumanReadableString

String toHumanReadableString()

getRealValue

static <T> T getRealValue(PrismProperty<T> property)