Package org.springframework.shell.component.support

Class AbstractSelectorComponent.BaseSelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,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>

org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext<T,I,C>

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>, ComponentContext<C>, AbstractSelectorComponent.SelectorComponentContext<T,I,C>

Enclosing class:

AbstractSelectorComponent<T,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>,I extends Nameable & Matchable & Enableable & Selectable & Itemable<T>>

protected static class AbstractSelectorComponent.BaseSelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>
extends BaseComponentContext<C>
implements AbstractSelectorComponent.SelectorComponentContext<T,I,C>

Base implementation of a AbstractSelectorComponent.SelectorComponentContext.

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

Modifier	Constructor	Description
protected	BaseSelectorComponentContext()

Method Summary

Modifier and Type	Method	Description
Integer	getCursorRow()	Gets a cursor row.
String	getInput()	Gets an input.
List<I>	getItems()	Gets an items.
List<AbstractSelectorComponent.ItemState<I>>	getItemStates()	Gets an item states
List<AbstractSelectorComponent.ItemState<I>>	getItemStateView()	Gets an item state view.
String	getName()	Gets a name.
List<I>	getResultItems()	Gets a result items.
boolean	isResult()	Return if there is a result.
void	setCursorRow(Integer cursorRow)	Sets a cursor row.
void	setInput(String input)	Sets an input.
void	setItems(List<I> items)	Sets an items.
void	setItemStates(List<AbstractSelectorComponent.ItemState<I>> itemStates)	Sets an item states.
void	setItemStateView(List<AbstractSelectorComponent.ItemState<I>> itemStateView)	Sets an item state view
void	setName(String name)	Sets a name
void	setResultItems(List<I> resultItems)	Sets a result items.
String	toString()
Map<String,Object>	toTemplateModel()	Gets context values as a map.

Methods inherited from class org.springframework.shell.component.context.BaseComponentContext

get, get, getTerminalWidth, put, setTerminalWidth, stream

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, get, get, getTerminalWidth, put, setTerminalWidth, stream

Methods inherited from interface java.util.Map

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

Constructor Details

BaseSelectorComponentContext

protected BaseSelectorComponentContext()

Method Details

getName

public String getName()

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Gets a name.

Specified by:

getName in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Returns:

a name

setName

public void setName(String name)

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Sets a name

Specified by:

setName in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Parameters:

name - the name

getInput

public String getInput()

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Gets an input.

Specified by:

getInput in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Returns:

an input

setInput

public void setInput(String input)

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Sets an input.

Specified by:

setInput in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Parameters:

input - the input

getItemStates

public List<AbstractSelectorComponent.ItemState<I>> getItemStates()

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Gets an item states

Specified by:

getItemStates in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Returns:

an item states

setItemStates

public void setItemStates(List<AbstractSelectorComponent.ItemState<I>> itemStates)

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Sets an item states.

Specified by:

setItemStates in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Parameters:

itemStates - the input state

getItemStateView

public List<AbstractSelectorComponent.ItemState<I>> getItemStateView()

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Gets an item state view.

Specified by:

getItemStateView in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Returns:

an item state view

setItemStateView

public void setItemStateView(List<AbstractSelectorComponent.ItemState<I>> itemStateView)

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Sets an item state view

Specified by:

setItemStateView in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Parameters:

itemStateView - the item state view

isResult

public boolean isResult()

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Return if there is a result.

Specified by:

isResult in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Returns:

true if context represents result

getCursorRow

public Integer getCursorRow()

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Gets a cursor row.

Specified by:

getCursorRow in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Returns:

a cursor row.

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<T>

Overrides:

toTemplateModel in class BaseComponentContext<C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Returns:

map of context values

setCursorRow

public void setCursorRow(Integer cursorRow)

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Sets a cursor row.

Specified by:

setCursorRow in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Parameters:

cursorRow - the cursor row

getItems

public List<I> getItems()

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Gets an items.

Specified by:

getItems in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Returns:

an items

setItems

public void setItems(List<I> items)

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Sets an items.

Specified by:

setItems in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Parameters:

items - the items

getResultItems

public List<I> getResultItems()

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Gets a result items.

Specified by:

getResultItems in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Returns:

a result items

setResultItems

public void setResultItems(List<I> resultItems)

Description copied from interface: AbstractSelectorComponent.SelectorComponentContext

Sets a result items.

Specified by:

setResultItems in interface AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Parameters:

resultItems - the result items

toString

public String toString()

Overrides:

toString in class BaseComponentContext<C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>