sirius.kernel.commons

Class Context

java.lang.Object

sirius.kernel.commons.Context

All Implemented Interfaces:

Map<String,Object>

public class Context
extends Object
implements Map<String,Object>

Provides an execution context to scripts etc.

This is basically a wrapper for Map<String, Object>

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	data

Constructor Summary

Constructors

Constructor and Description
Context()

Method Summary

Modifier and Type	Method and Description
void	applyTo(ScriptContext ctx) Writes all parameters into the given ScriptContext
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
static Context	create() Creates a new context
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
Value	getValue(Object key) Provides the value associated with the given key as Value
boolean	isEmpty()
Set<String>	keySet()
Object	put(String key, Object value)
void	putAll(Map<? extends String,?> m)
void	putLimited(String key, Object value, int limit) Sets the given value (its string representation), mit limits this to limit characters.
Object	remove(Object key)
Context	set(String key, Object value) Associates the given value to the given key, while returning this to permit fluent method chains
Context	setAll(Map<String,Object> data) Puts all name-value-pairs stored in the given map.
int	size()
String	toString()
Collection<Object>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

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

Field Detail

data

protected Map<String,Object> data

Constructor Detail

Context

public Context()

Method Detail

size

public int size()

Specified by:

size in interface Map<String,Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

getValue

@Nonnull
public Value getValue(Object key)

Provides the value associated with the given key as Value

Parameters:

key - the key for which the value should ne returned

Returns:

a value wrapping the internally associated value for the given key

put

public Object put(String key,
                  Object value)

Specified by:

put in interface Map<String,Object>

putLimited

public void putLimited(String key,
                       Object value,
                       int limit)

Sets the given value (its string representation), mit limits this to limit characters.

Parameters:

key - the key to which the value should be associated

value - the value which string representation should be put into the context

limit - the maximal number of characters to put into the map. Everything after that will be discarded

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

putAll

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

Specified by:

putAll in interface Map<String,Object>

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

values

public Collection<Object> values()

Specified by:

values in interface Map<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

create

public static Context create()

Creates a new context

Returns:

a newly created and empty context

set

public Context set(String key,
                   Object value)

Associates the given value to the given key, while returning this to permit fluent method chains

Parameters:

key - the key to which the value will be bound

value - the value to be associated with the given key

Returns:

this to permit fluent method calls

setAll

public Context setAll(Map<String,Object> data)

Puts all name-value-pairs stored in the given map.

Parameters:

data - the name value pairs to be put into the context

Returns:

this to permit fluent method calls

applyTo

public void applyTo(ScriptContext ctx)

Writes all parameters into the given ScriptContext

Parameters:

ctx - the context to be filled with the internally stored name value pairs

toString

public String toString()

Overrides:

toString in class Object