Package com.evolveum.midpoint.prism.impl

Class PrismObjectDefinitionImpl<O extends Objectable>

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.DefinitionImpl

com.evolveum.midpoint.prism.impl.ItemDefinitionImpl<PrismContainer<C>>

com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl<O>

com.evolveum.midpoint.prism.impl.PrismObjectDefinitionImpl<O>

All Implemented Interfaces:

Definition, Freezable, ItemDefinition<PrismContainer<O>>, ItemDefinitionTestAccess, LocalItemDefinitionStore, MutableDefinition, MutableItemDefinition<PrismContainer<O>>, MutablePrismContainerDefinition<O>, MutablePrismObjectDefinition<O>, PrismContainerDefinition<O>, PrismContextSensitive, PrismItemAccessDefinition, PrismObjectDefinition<O>, Revivable, SmartVisitable<Definition>, Visitable<Definition>, DebugDumpable, Serializable, Cloneable

public class PrismObjectDefinitionImpl<O extends Objectable>
extends PrismContainerDefinitionImpl<O>
implements MutablePrismObjectDefinition<O>

MidPoint Object Definition. Objects are storable entities in midPoint. This is mostly just a marker class to identify object boundaries in schema. This class represents schema definition for objects. See Definition for more details. "Instance" class of this class is MidPointObject, not Object - to avoid confusion with java.lang.Object.

Author:

Radovan Semancik

See Also:

• Serialized Form

Nested Class Summary

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

PrismItemAccessDefinition.Mutable

Field Summary

Fields inherited from class com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl

compileTimeClass, complexTypeDefinition

Fields inherited from class com.evolveum.midpoint.prism.impl.ItemDefinitionImpl

heterogeneousListItem, itemName, substitutionHead

Fields inherited from class com.evolveum.midpoint.prism.impl.DefinitionImpl

deprecated, deprecatedSince, displayName, displayOrder, documentation, elaborate, emphasized, experimental, help, isAbstract, isRuntimeSchema, plannedRemoval, processing, removed, removedSince, typeName

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
PrismObjectDefinitionImpl(QName elementName, ComplexTypeDefinition complexTypeDefinition, Class<O> compileTimeClass)

Method Summary

Modifier and Type	Method	Description
@NotNull PrismObjectDefinitionImpl<O>	clone()	Shallow clone
@NotNull PrismObjectDefinition<O>	cloneWithReplacedDefinition(QName itemName, ItemDefinition<?> newDefinition)	TODO
PrismObjectValue<O>	createValue()	TODO
PrismObjectDefinition<O>	deepClone(@NotNull DeepCloneOperation operation)	Make a deep clone, cloning all the sub-items and definitions.
String	getDebugDumpClassName()	Return a human readable name of this class suitable for logs.
String	getDocClassName()	Returns human-readable name of this class suitable for documentation.
PrismContainerDefinition<?>	getExtensionDefinition()
@NotNull PrismObject<O>	instantiate()	Create an item instance.
@NotNull PrismObject<O>	instantiate(QName name)	Create an item instance.
MutablePrismObjectDefinition<O>	toMutable()	Returns an interface to mutate this definition.

Methods inherited from class com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl

accept, canBeDefinitionOf, canRepresent, checkMutable, copyDefinitionDataFrom, createContainerDefinition, createContainerDefinition, createContainerDefinition, createEmptyDelta, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, debugDump, debugDump, findItemDefinition, getAlwaysUseForEquals, getCompileTimeClass, getComplexTypeDefinition, getDefinitions, getDiagrams, getPropertyDefinitions, getSchemaNamespace, getTypeClass, isAbstract, isEmpty, performFreeze, replaceDefinition, revive, setAlwaysUseForEquals, setCompileTimeClass, setComplexTypeDefinition

Methods inherited from class com.evolveum.midpoint.prism.impl.ItemDefinitionImpl

adoptElementDefinitionFrom, canAdd, canBeDefinitionOf, canModify, canRead, copyDefinitionDataFrom, debugDumpShortToString, debugFlags, debugMultiplicity, equals, extendToString, getItemName, getMaxOccurs, getMinOccurs, getSubstitutionHead, getValueEnumerationRef, hashCode, isDynamic, isHeterogeneousListItem, isIndexOnly, isInherited, isOperational, isSearchable, isValidFor, replaceName, setCanAdd, setCanModify, setCanRead, setDynamic, setHeterogeneousListItem, setIndexOnly, setInherited, setItemName, setMaxOccurs, setMinOccurs, setOperational, setReadOnly, setSearchable, setSubstitutionHead, setValueEnumerationRef, toString, useSerializationProxy, writeReplace

Methods inherited from class com.evolveum.midpoint.prism.impl.DefinitionImpl

accept, addDiagram, addSchemaMigration, checkMutableOnExposing, copyDefinitionDataFrom, extendDumpHeader, getAnnotation, getAnnotations, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getPlannedRemoval, getPrismContext, getProcessing, getRemovedSince, getSchemaMigrations, getTypeName, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRemoved, isRuntimeSchema, setAbstract, setAnnotation, setDeprecated, setDeprecatedSince, setDisplayName, setDisplayOrder, setDocumentation, setElaborate, setEmphasized, setExperimental, setHelp, setPlannedRemoval, setProcessing, setRemoved, setRemovedSince, setRuntimeSchema, setTypeName

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

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

debugDump, getAnnotation, getAnnotations, getDeprecatedSince, getDiagrams, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getProcessing, getRemovedSince, getSchemaMigrations, getSchemaRegistry, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRemoved, isRuntimeSchema, setAnnotation

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

checkImmutable, checkMutable, freeze, isImmutable

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

adoptElementDefinitionFrom, canBeDefinitionOf, canBeDefinitionOf, debugDumpShortToString, findItemDefinition, getItemName, getMaxOccurs, getMinOccurs, getSubstitutionHead, getValueEnumerationRef, isDynamic, isHeterogeneousListItem, isIndexOnly, isInherited, isMandatory, isMultiValue, isOperational, isOptional, isSearchable, isSingleValue, isValidFor

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

containsItemDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition, findReferenceDefinition

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

addDiagram, addSchemaMigration, setDeprecated, setDisplayName, setDisplayOrder, setDocumentation, setEmphasized, setExperimental, setHelp, setProcessing, setRemoved, setRemovedSince, setRuntimeSchema, setTypeName

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

setCanAdd, setCanModify, setCanRead, setDeprecatedSince, setDynamic, setElaborate, setHeterogeneousListItem, setIndexOnly, setInherited, setItemName, setMaxOccurs, setMinOccurs, setOperational, setPlannedRemoval, setReadOnly, setSearchable, setSubstitutionHead, setValueEnumerationRef

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

createContainerDefinition, createContainerDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, setAlwaysUseForEquals, setCompileTimeClass, setComplexTypeDefinition

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

canRepresent, createEmptyDelta, getAlwaysUseForEquals, getCompileTimeClass, getComplexTypeDefinition, getDefinitions, getItemNames, getPropertyDefinitions, getTypeClass, isAlwaysUseForEquals, isCompletelyDefined, isEmpty, replaceDefinition, structuredType

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

getPrismContext

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

canAdd, canModify, canRead

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

revive

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

accept

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

accept

Constructor Details

PrismObjectDefinitionImpl

public PrismObjectDefinitionImpl(QName elementName,
 ComplexTypeDefinition complexTypeDefinition,
 Class<O> compileTimeClass)

Method Details

instantiate

@NotNull
public @NotNull PrismObject<O> instantiate()
                                    throws SchemaException

Description copied from interface: ItemDefinition

Create an item instance. Definition name or default name will be used as an element name for the instance. The instance will otherwise be empty.

Specified by:

instantiate in interface ItemDefinition<O extends Objectable>

Specified by:

instantiate in interface PrismObjectDefinition<O extends Objectable>

Overrides:

instantiate in class PrismContainerDefinitionImpl<O extends Objectable>

Throws:

SchemaException

instantiate

@NotNull
public @NotNull PrismObject<O> instantiate(QName name)
                                    throws SchemaException

Description copied from interface: ItemDefinition

Create an item instance. Definition name will use provided name. for the instance. The instance will otherwise be empty.

Specified by:

instantiate in interface ItemDefinition<O extends Objectable>

Specified by:

instantiate in interface PrismObjectDefinition<O extends Objectable>

Overrides:

instantiate in class PrismContainerDefinitionImpl<O extends Objectable>

Throws:

SchemaException

clone

@NotNull
public @NotNull PrismObjectDefinitionImpl<O> clone()

Description copied from class: PrismContainerDefinitionImpl

Shallow clone

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<O extends Objectable>

Specified by:

clone in interface PrismContainerDefinition<O extends Objectable>

Specified by:

clone in interface PrismObjectDefinition<O extends Objectable>

Overrides:

clone in class PrismContainerDefinitionImpl<O extends Objectable>

deepClone

public PrismObjectDefinition<O> deepClone(@NotNull
 @NotNull DeepCloneOperation operation)

Description copied from class: ItemDefinitionImpl

Make a deep clone, cloning all the sub-items and definitions.

Specified by:

deepClone in interface ItemDefinition<O extends Objectable>

Specified by:

deepClone in interface PrismObjectDefinition<O extends Objectable>

Overrides:

deepClone in class PrismContainerDefinitionImpl<O extends Objectable>

cloneWithReplacedDefinition

@NotNull
public @NotNull PrismObjectDefinition<O> cloneWithReplacedDefinition(QName itemName,
 ItemDefinition<?> newDefinition)

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

cloneWithReplacedDefinition in interface PrismContainerDefinition<O extends Objectable>

Specified by:

cloneWithReplacedDefinition in interface PrismObjectDefinition<O extends Objectable>

Overrides:

cloneWithReplacedDefinition in class PrismContainerDefinitionImpl<O extends Objectable>

getExtensionDefinition

public PrismContainerDefinition<?> getExtensionDefinition()

Specified by:

getExtensionDefinition in interface PrismObjectDefinition<O extends Objectable>

createValue

public PrismObjectValue<O> createValue()

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

createValue in interface PrismContainerDefinition<O extends Objectable>

Specified by:

createValue in interface PrismObjectDefinition<O extends Objectable>

Overrides:

createValue in class PrismContainerDefinitionImpl<O extends Objectable>

getDebugDumpClassName

public String getDebugDumpClassName()

Description copied from class: PrismContainerDefinitionImpl

Return a human readable name of this class suitable for logs.

Overrides:

getDebugDumpClassName in class PrismContainerDefinitionImpl<O extends Objectable>

getDocClassName

public String getDocClassName()

Description copied from class: DefinitionImpl

Returns human-readable name of this class suitable for documentation. (e.g. "property")

Overrides:

getDocClassName in class PrismContainerDefinitionImpl<O extends Objectable>

toMutable

public MutablePrismObjectDefinition<O> toMutable()

Description copied from interface: Definition

Returns an interface to mutate this definition.

Specified by:

toMutable in interface Definition

Specified by:

toMutable in interface ItemDefinition<O extends Objectable>

Specified by:

toMutable in interface PrismContainerDefinition<O extends Objectable>

Specified by:

toMutable in interface PrismObjectDefinition<O extends Objectable>

Overrides:

toMutable in class PrismContainerDefinitionImpl<O extends Objectable>