Package com.evolveum.midpoint.schema.expression

Class VariablesMap

java.lang.Object

com.evolveum.midpoint.schema.expression.VariablesMap

All Implemented Interfaces:

DebugDumpable, Map<String,TypedValue<?>>

public class VariablesMap
extends Object
implements Map<String,TypedValue<?>>, DebugDumpable

Author:

semancik

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
VariablesMap()

Method Summary

Modifier and Type	Method	Description
<D extends ItemDefinition<?>> void	addVariableDefinition(String name, Object value, D definition)
void	addVariableDefinitions(VariablesMap extraVariables)	Adds map of extra variables to the expression.
void	addVariableDefinitions(VariablesMap extraVariables, @NotNull Collection<String> exceptFor)
void	addVariableDefinitionsNew(VariablesMap extraVariables)	Adds map of extra variables to the expression.
void	addVariableDefinitionsOld(VariablesMap extraVariables)	Adds map of extra variables to the expression.
void	addVariableWithDeterminedDefinition(@NotNull String name, @NotNull ObjectType value)	Tries to determine the definition of the variable value.
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
static VariablesMap	create(PrismContext prismContext, Object... parameters)	Expects name-value-definition triplets.
String	debugDump(int indent)
String	dumpSingleLine()
static VariablesMap	emptyMap()
@NotNull Set<Map.Entry<String,TypedValue<?>>>	entrySet()
boolean	equals(Object o)
String	formatVariables()
TypedValue<?>	get(Object key)
@NotNull Collection<String>	getAliases(String key)
String	getAliasResolution(String key)
Object	getValue(String name)
<T> T	getValue(String name, Class<T> type)
<O extends ObjectType> PrismObject<O>	getValueNew(String name)
int	hashCode()
boolean	haveDeltas()
boolean	isAlias(String key)
boolean	isEmpty()
@NotNull Set<String>	keySet()
TypedValue<?>	put(String key, TypedValue<?> typedValue)
<D extends ItemDefinition> TypedValue	put(String key, Object value, D definition)
<T> TypedValue<?>	put(String key, Object value, Class<T> typeClass)	Note: Type of the value should really be Object and not T.
void	putAll(@NotNull Map<? extends String,? extends TypedValue<?>> m)
void	putAll(VariablesMap m)
<T> TypedValue<List<T>>	putList(String key, List<T> list)	Convenience method to put multivalue variables (lists).
<O extends ObjectType> TypedValue<O>	putObject(String key, PrismObject<O> object, Class<O> expectedClass)	Convenience method to put objects with definition.
<O extends ObjectType> TypedValue<O>	putObject(String key, O objectType, Class<O> expectedClass)	Convenience method to put objects with definition.
void	registerAlias(String alias, @Nullable String realName)
void	registerAliasesFrom(VariablesMap map)	Use only if you previously register all variables from this map!
TypedValue<?>	remove(Object key)
<D extends ItemDefinition<?>> void	replaceVariableDefinition(String name, Object value, D definition)
void	setRootNode(ObjectReferenceType objectRef, PrismReferenceDefinition def)
@NotNull VariablesMap	shallowClone()
int	size()
String	toString()
void	unregisterAlias(String alias)
@NotNull Collection<TypedValue<?>>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Details

VariablesMap

public VariablesMap()

Method Details

size

public int size()

Specified by:

size in interface Map<String,TypedValue<?>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,TypedValue<?>>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,TypedValue<?>>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,TypedValue<?>>

get

public TypedValue<?> get(Object key)

Specified by:

get in interface Map<String,TypedValue<?>>

put

public TypedValue<?> put(String key,
 TypedValue<?> typedValue)

Specified by:

put in interface Map<String,TypedValue<?>>

registerAlias

public void registerAlias(String alias,
 @Nullable
 @Nullable String realName)

registerAliasesFrom

public void registerAliasesFrom(VariablesMap map)

Use only if you previously register all variables from this map!

unregisterAlias

public void unregisterAlias(String alias)

put

public <D extends ItemDefinition> TypedValue put(String key,
 Object value,
 D definition)

put

public <T> TypedValue<?> put(String key,
 Object value,
 Class<T> typeClass)

Note: Type of the value should really be Object and not T. The value may be quite complicated, e.g. it may be ItemDeltaItem of the actual real value. However, the class defines the real type of the value precisely.

putObject

public <O extends ObjectType> TypedValue<O> putObject(String key,
 O objectType,
 Class<O> expectedClass)

Convenience method to put objects with definition. Maybe later improve by looking up full definition.

putObject

public <O extends ObjectType> TypedValue<O> putObject(String key,
 PrismObject<O> object,
 Class<O> expectedClass)

Convenience method to put objects with definition. Maybe later improve by looking up full definition.

putList

public <T> TypedValue<List<T>> putList(String key,
 List<T> list)

Convenience method to put multivalue variables (lists). This is very simple now. But later on we may need to declare generics. Therefore dedicated method would be easier to find all usages and fix them.

remove

public TypedValue<?> remove(Object key)

Specified by:

remove in interface Map<String,TypedValue<?>>

putAll

public void putAll(@NotNull
 @NotNull Map<? extends String,? extends TypedValue<?>> m)

Specified by:

putAll in interface Map<String,TypedValue<?>>

putAll

public void putAll(VariablesMap m)

clear

public void clear()

Specified by:

clear in interface Map<String,TypedValue<?>>

keySet

@NotNull
public @NotNull Set<String> keySet()

Specified by:

keySet in interface Map<String,TypedValue<?>>

values

@NotNull
public @NotNull Collection<TypedValue<?>> values()

Specified by:

values in interface Map<String,TypedValue<?>>

entrySet

@NotNull
public @NotNull Set<Map.Entry<String,TypedValue<?>>> entrySet()

Specified by:

entrySet in interface Map<String,TypedValue<?>>

create

@VisibleForTesting
public static VariablesMap create(PrismContext prismContext,
 Object... parameters)

Expects name-value-definition triplets. Definition can be just a type QName. E.g. create(var1name, var1value, var1type, var2name, var2value, var2type, ...) Mostly for testing. Use at your own risk.

emptyMap

public static VariablesMap emptyMap()

formatVariables

public String formatVariables()

getAliases

@NotNull
public @NotNull Collection<String> getAliases(String key)

isAlias

public boolean isAlias(String key)

getAliasResolution

public String getAliasResolution(String key)

dumpSingleLine

public String dumpSingleLine()

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

addVariableDefinitions

public void addVariableDefinitions(VariablesMap extraVariables)

Adds map of extra variables to the expression. If there are variables with deltas (ObjectDeltaObject) the operation fail because it cannot decide which version to use.

addVariableDefinitions

public void addVariableDefinitions(VariablesMap extraVariables,
 @NotNull
 @NotNull Collection<String> exceptFor)

addVariableDefinitionsOld

public void addVariableDefinitionsOld(VariablesMap extraVariables)

Adds map of extra variables to the expression. If there are variables with deltas (ObjectDeltaObject) it takes the "old" version of the object.

addVariableDefinitionsNew

public void addVariableDefinitionsNew(VariablesMap extraVariables)

Adds map of extra variables to the expression. If there are variables with deltas (ObjectDeltaObject) it takes the "new" version of the object.

setRootNode

public void setRootNode(ObjectReferenceType objectRef,
 PrismReferenceDefinition def)

addVariableWithDeterminedDefinition

public void addVariableWithDeterminedDefinition(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull ObjectType value)

Tries to determine the definition of the variable value.

addVariableDefinition

public <D extends ItemDefinition<?>> void addVariableDefinition(String name,
 Object value,
 D definition)

replaceVariableDefinition

public <D extends ItemDefinition<?>> void replaceVariableDefinition(String name,
 Object value,
 D definition)

getValue

public Object getValue(String name)

getValue

public <T> T getValue(String name,
 Class<T> type)
               throws SchemaException

Throws:

SchemaException

getValueNew

public <O extends ObjectType> PrismObject<O> getValueNew(String name)
                                                  throws SchemaException

Throws:

SchemaException

haveDeltas

public boolean haveDeltas()

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,TypedValue<?>>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,TypedValue<?>>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

shallowClone

@NotNull
public @NotNull VariablesMap shallowClone()