Package org.springframework.shell.component.context

Class BaseComponentContext<C extends ComponentContext<C>>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<Object,Object>

org.springframework.shell.component.context.BaseComponentContext<C>

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>, ComponentContext<C>

Direct Known Subclasses:

AbstractSelectorComponent.BaseSelectorComponentContext, AbstractTextComponent.BaseTextComponentContext

public class BaseComponentContext<C extends ComponentContext<C>>
extends LinkedHashMap<Object,Object>
implements ComponentContext<C>

Base implementation of a ComponentContext.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
BaseComponentContext()

Method Summary

Modifier and Type	Method	Description
Object	get(Object key)	Gets a value from a context.
<T> T	get(Object key, Class<T> type)	Gets a value from a context with a given type to get cast to.
Integer	getTerminalWidth()	Get terminal width.
ComponentContext<C>	put(Object key, Object value)	Put an entry into a context.
void	setTerminalWidth(Integer terminalWidth)	Set terminal width.
Stream<Map.Entry<Object,Object>>	stream()	Stream key/value pairs from this ComponentContext
String	toString()
Map<String,Object>	toTemplateModel()	Gets context values as a map.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.shell.component.context.ComponentContext

containsKey

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Details

BaseComponentContext

public BaseComponentContext()

Method Details

get

public Object get(Object key)

Description copied from interface: ComponentContext

Gets a value from a context.

Specified by:

get in interface ComponentContext<C extends ComponentContext<C>>

Specified by:

get in interface Map<Object,Object>

Overrides:

get in class LinkedHashMap<Object,Object>

Parameters:

key - the key

Returns:

a value

get

public <T> T get(Object key,
 Class<T> type)

Description copied from interface: ComponentContext

Gets a value from a context with a given type to get cast to.

Specified by:

get in interface ComponentContext<C extends ComponentContext<C>>

Type Parameters:

T - the type of context

Parameters:

key - the key

type - the class type

Returns:

a value

put

public ComponentContext<C> put(Object key,
 Object value)

Description copied from interface: ComponentContext

Put an entry into a context.

Specified by:

put in interface ComponentContext<C extends ComponentContext<C>>

Specified by:

put in interface Map<Object,Object>

Overrides:

put in class HashMap<Object,Object>

Parameters:

key - the entry key

value - the entry value

Returns:

a context

stream

public Stream<Map.Entry<Object,Object>> stream()

Description copied from interface: ComponentContext

Stream key/value pairs from this ComponentContext

Specified by:

stream in interface ComponentContext<C extends ComponentContext<C>>

Returns:

a Stream of key/value pairs held by this context

getTerminalWidth

public Integer getTerminalWidth()

Description copied from interface: ComponentContext

Get terminal width.

Specified by:

getTerminalWidth in interface ComponentContext<C extends ComponentContext<C>>

Returns:

a terminal width

setTerminalWidth

public void setTerminalWidth(Integer terminalWidth)

Description copied from interface: ComponentContext

Set terminal width.

Specified by:

setTerminalWidth in interface ComponentContext<C extends ComponentContext<C>>

Parameters:

terminalWidth - the width

toTemplateModel

public Map<String,Object> toTemplateModel()

Description copied from interface: ComponentContext

Gets context values as a map. Every context implementation can do their own model as essentially what matter is a one coming out from a last child which is one most likely to feed into a template engine.

Specified by:

toTemplateModel in interface ComponentContext<C extends ComponentContext<C>>

Returns:

map of context values

toString

public String toString()

Overrides:

toString in class AbstractMap<Object,Object>