Package cimerant.context.java.util.impl

Class MapEntryListIteratorContextImpl<K,V>

java.lang.Object

org.apache.velocity.context.AbstractContext

org.apache.velocity.VelocityContext

cimerant.context.impl.ContextRootImpl<ListIterator<Map.Entry<K,V>>>

cimerant.context.java.util.impl.MapEntryListIteratorContextImpl<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Implemented Interfaces:

ContextRoot<ListIterator<Map.Entry<K,V>>>, MapEntryListIteratorContext<K,V>, Serializable, Cloneable, Iterator<Map.Entry<ContextRoot<K>,ContextRoot<V>>>, ListIterator<Map.Entry<ContextRoot<K>,ContextRoot<V>>>, Context, InternalEventContext

public final class MapEntryListIteratorContextImpl<K,V>
extends ContextRootImpl<ListIterator<Map.Entry<K,V>>>
implements MapEntryListIteratorContext<K,V>

Wrapper interface bridging the gap between Context and ListIterator Map.Entry describing the template data context. This set of routines is used by the template to set and get 'named' data object to pass them to the template engine to use when rendering a template.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
void	add(Map.Entry<ContextRoot<K>,ContextRoot<V>> e)	Unsupported Operation.
EventCartridge	attachEventCartridge(EventCartridge arg0)
int	getCurrentMacroCallDepth()
String	getCurrentMacroName()
Resource	getCurrentResource()
String	getCurrentTemplateName()
EventCartridge	getEventCartridge()
static <K, V> MapEntryListIteratorContext<K,V>	getInstance(ListIterator<Map.Entry<K,V>> contextObject)	Global access point to get a instance of the context, ensuring that only one instance of the context exists.
List<Template>	getMacroLibraries()
String[]	getMacroNameStack()
String[]	getTemplateNameStack()
boolean	hasNext()	Returns true if this context has more elements when traversing the context in the forward direction.
boolean	hasPrevious()	Returns true if this context has more elements when traversing the context in the reverse direction.
IntrospectionCacheData	icacheGet(Object arg0)
void	icachePut(Object arg0, IntrospectionCacheData arg1)
Map.Entry<ContextRoot<K>,ContextRoot<V>>	next()	Returns the next element in the context and advances the cursor position.
int	nextIndex()	Returns the index of the element that would be returned by a subsequent call to next().
void	popCurrentMacroName()
void	popCurrentTemplateName()
Map.Entry<ContextRoot<K>,ContextRoot<V>>	previous()	Returns the previous element in the context and moves the cursor position backwards.
int	previousIndex()	Returns the index of the element that would be returned by a subsequent call to previous().
void	pushCurrentMacroName(String arg0)
void	pushCurrentTemplateName(String arg0)
void	remove()	Unsupported Operation.
void	set(Map.Entry<ContextRoot<K>,ContextRoot<V>> e)	Unsupported Operation.
void	setCurrentResource(Resource arg0)
void	setMacroLibraries(List<Template> arg0)

Methods inherited from class cimerant.context.impl.ContextRootImpl

backSlashLowerCase, backSlashLowerCase, backSlashTitleCase, backSlashTitleCase, backSlashUpperCase, backSlashUpperCase, camelCase, camelCase, clearInstances, contextContainsKey, contextGet, contextGetKeys, contextPut, contextRemove, dotLowerCase, dotLowerCase, dotTitleCase, dotTitleCase, dotUpperCase, dotUpperCase, forwardSlashLowerCase, forwardSlashLowerCase, forwardSlashTitleCase, forwardSlashTitleCase, forwardSlashUpperCase, forwardSlashUpperCase, getContextClass, getContextObject, getFileExtension, getFileName, getFilePath, getGrouping, getInstance, getObjectName, isCollectionContext, isMapContext, isMapEntryContext, isNumericClass, isSetContext, isStringContext, kebabLowerCase, kebabLowerCase, kebabTitleCase, kebabTitleCase, kebabUpperCase, kebabUpperCase, lowerCase, lowerCase, lowerFirst, lowerFirst, pascalCase, pascalCase, pluralBackSlashLowerCase, pluralBackSlashLowerCase, pluralBackSlashTitleCase, pluralBackSlashTitleCase, pluralBackSlashUpperCase, pluralBackSlashUpperCase, pluralCamelCase, pluralCamelCase, pluralDotLowerCase, pluralDotLowerCase, pluralDotTitleCase, pluralDotTitleCase, pluralDotUpperCase, pluralDotUpperCase, pluralForwardSlashLowerCase, pluralForwardSlashLowerCase, pluralForwardSlashTitleCase, pluralForwardSlashTitleCase, pluralForwardSlashUpperCase, pluralForwardSlashUpperCase, pluralKebabLowerCase, pluralKebabLowerCase, pluralKebabTitleCase, pluralKebabTitleCase, pluralKebabUpperCase, pluralKebabUpperCase, pluralLowerCase, pluralLowerCase, pluralLowerFirst, pluralLowerFirst, pluralPascalCase, pluralPascalCase, pluralSnakeLowerCase, pluralSnakeLowerCase, pluralSnakeTitleCase, pluralSnakeTitleCase, pluralSnakeUpperCase, pluralSnakeUpperCase, pluralTitleCase, pluralTitleCase, pluralUpperCase, pluralUpperCase, pluralUpperFirst, pluralUpperFirst, registerInstance, setFileExtension, setFileName, setFilePath, setGrouping, setObjectName, singularBackSlashLowerCase, singularBackSlashLowerCase, singularBackSlashTitleCase, singularBackSlashTitleCase, singularBackSlashUpperCase, singularBackSlashUpperCase, singularCamelCase, singularCamelCase, singularDotLowerCase, singularDotLowerCase, singularDotTitleCase, singularDotTitleCase, singularDotUpperCase, singularDotUpperCase, singularForwardSlashLowerCase, singularForwardSlashLowerCase, singularForwardSlashTitleCase, singularForwardSlashTitleCase, singularForwardSlashUpperCase, singularForwardSlashUpperCase, singularKebabLowerCase, singularKebabLowerCase, singularKebabTitleCase, singularKebabTitleCase, singularKebabUpperCase, singularKebabUpperCase, singularLowerCase, singularLowerCase, singularLowerFirst, singularLowerFirst, singularPascalCase, singularPascalCase, singularSnakeLowerCase, singularSnakeLowerCase, singularSnakeTitleCase, singularSnakeTitleCase, singularSnakeUpperCase, singularSnakeUpperCase, singularTitleCase, singularTitleCase, singularUpperCase, singularUpperCase, singularUpperFirst, singularUpperFirst, snakeLowerCase, snakeLowerCase, snakeTitleCase, snakeTitleCase, snakeUpperCase, snakeUpperCase, titleCase, titleCase, toJson, upperCase, upperCase, upperFirst, upperFirst

Methods inherited from class org.apache.velocity.VelocityContext

clone, internalContainsKey, internalGet, internalGetKeys, internalPut, internalRemove

Methods inherited from class org.apache.velocity.context.AbstractContext

containsKey, get, getChainedContext, getKeys, put, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.velocity.context.Context

containsKey, get, getKeys, put, remove

Methods inherited from interface cimerant.context.ContextRoot

backSlashLowerCase, backSlashLowerCase, backSlashTitleCase, backSlashTitleCase, backSlashUpperCase, backSlashUpperCase, camelCase, camelCase, contextContainsKey, contextGet, contextGetKeys, contextPut, contextRemove, dotLowerCase, dotLowerCase, dotTitleCase, dotTitleCase, dotUpperCase, dotUpperCase, forwardSlashLowerCase, forwardSlashLowerCase, forwardSlashTitleCase, forwardSlashTitleCase, forwardSlashUpperCase, forwardSlashUpperCase, getContextClass, getFileExtension, getFileName, getFilePath, getGrouping, getObjectName, isNumericClass, kebabLowerCase, kebabLowerCase, kebabTitleCase, kebabTitleCase, kebabUpperCase, kebabUpperCase, lowerCase, lowerCase, lowerFirst, lowerFirst, pascalCase, pascalCase, pluralBackSlashLowerCase, pluralBackSlashLowerCase, pluralBackSlashTitleCase, pluralBackSlashTitleCase, pluralBackSlashUpperCase, pluralBackSlashUpperCase, pluralCamelCase, pluralCamelCase, pluralDotLowerCase, pluralDotLowerCase, pluralDotTitleCase, pluralDotTitleCase, pluralDotUpperCase, pluralDotUpperCase, pluralForwardSlashLowerCase, pluralForwardSlashLowerCase, pluralForwardSlashTitleCase, pluralForwardSlashTitleCase, pluralForwardSlashUpperCase, pluralForwardSlashUpperCase, pluralKebabLowerCase, pluralKebabLowerCase, pluralKebabTitleCase, pluralKebabTitleCase, pluralKebabUpperCase, pluralKebabUpperCase, pluralLowerCase, pluralLowerCase, pluralLowerFirst, pluralLowerFirst, pluralPascalCase, pluralPascalCase, pluralSnakeLowerCase, pluralSnakeLowerCase, pluralSnakeTitleCase, pluralSnakeTitleCase, pluralSnakeUpperCase, pluralSnakeUpperCase, pluralTitleCase, pluralTitleCase, pluralUpperCase, pluralUpperCase, pluralUpperFirst, pluralUpperFirst, setFileExtension, setFileName, setFilePath, setGrouping, setObjectName, singularBackSlashLowerCase, singularBackSlashLowerCase, singularBackSlashTitleCase, singularBackSlashTitleCase, singularBackSlashUpperCase, singularBackSlashUpperCase, singularCamelCase, singularCamelCase, singularDotLowerCase, singularDotLowerCase, singularDotTitleCase, singularDotTitleCase, singularDotUpperCase, singularDotUpperCase, singularForwardSlashLowerCase, singularForwardSlashLowerCase, singularForwardSlashTitleCase, singularForwardSlashTitleCase, singularForwardSlashUpperCase, singularForwardSlashUpperCase, singularKebabLowerCase, singularKebabLowerCase, singularKebabTitleCase, singularKebabTitleCase, singularKebabUpperCase, singularKebabUpperCase, singularLowerCase, singularLowerCase, singularLowerFirst, singularLowerFirst, singularPascalCase, singularPascalCase, singularSnakeLowerCase, singularSnakeLowerCase, singularSnakeTitleCase, singularSnakeTitleCase, singularSnakeUpperCase, singularSnakeUpperCase, singularTitleCase, singularTitleCase, singularUpperCase, singularUpperCase, singularUpperFirst, singularUpperFirst, snakeLowerCase, snakeLowerCase, snakeTitleCase, snakeTitleCase, snakeUpperCase, snakeUpperCase, titleCase, titleCase, upperCase, upperCase, upperFirst, upperFirst

Methods inherited from interface java.util.Iterator

forEachRemaining

Method Details

getInstance

public static <K,
V>
MapEntryListIteratorContext<K,V> getInstance(ListIterator<Map.Entry<K,V>> contextObject)

Global access point to get a instance of the context, ensuring that only one instance of the context exists.

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

Parameters:

contextObject - The base context object.

Returns:

a instance of the context.

add

public void add(Map.Entry<ContextRoot<K>,ContextRoot<V>> e)

Unsupported Operation.

Specified by:

add in interface ListIterator<K>

hasNext

public boolean hasNext()

Returns true if this context has more elements when traversing the context in the forward direction.

Specified by:

hasNext in interface Iterator<K>

Specified by:

hasNext in interface ListIterator<K>

hasPrevious

public boolean hasPrevious()

Returns true if this context has more elements when traversing the context in the reverse direction.

Specified by:

hasPrevious in interface ListIterator<K>

next

public Map.Entry<ContextRoot<K>,ContextRoot<V>> next()

Returns the next element in the context and advances the cursor position.

Specified by:

next in interface Iterator<K>

Specified by:

next in interface ListIterator<K>

nextIndex

public int nextIndex()

Returns the index of the element that would be returned by a subsequent call to next().

Specified by:

nextIndex in interface ListIterator<K>

previous

public Map.Entry<ContextRoot<K>,ContextRoot<V>> previous()

Returns the previous element in the context and moves the cursor position backwards.

Specified by:

previous in interface ListIterator<K>

previousIndex

public int previousIndex()

Returns the index of the element that would be returned by a subsequent call to previous().

Specified by:

previousIndex in interface ListIterator<K>

remove

public void remove()

Unsupported Operation.

Specified by:

remove in interface Iterator<K>

Specified by:

remove in interface ListIterator<K>

set

public void set(Map.Entry<ContextRoot<K>,ContextRoot<V>> e)

Unsupported Operation.

Specified by:

set in interface ListIterator<K>

pushCurrentTemplateName

public void pushCurrentTemplateName(String arg0)

popCurrentTemplateName

public void popCurrentTemplateName()

getCurrentTemplateName

public String getCurrentTemplateName()

getTemplateNameStack

public String[] getTemplateNameStack()

pushCurrentMacroName

public void pushCurrentMacroName(String arg0)

popCurrentMacroName

public void popCurrentMacroName()

getCurrentMacroName

public String getCurrentMacroName()

getCurrentMacroCallDepth

public int getCurrentMacroCallDepth()

getMacroNameStack

public String[] getMacroNameStack()

icacheGet

public IntrospectionCacheData icacheGet(Object arg0)

icachePut

public void icachePut(Object arg0,
 IntrospectionCacheData arg1)

setCurrentResource

public void setCurrentResource(Resource arg0)

getCurrentResource

public Resource getCurrentResource()

setMacroLibraries

public void setMacroLibraries(List<Template> arg0)

getMacroLibraries

public List<Template> getMacroLibraries()

attachEventCartridge

public EventCartridge attachEventCartridge(EventCartridge arg0)

Specified by:

attachEventCartridge in interface InternalEventContext

getEventCartridge

public EventCartridge getEventCartridge()

Specified by:

getEventCartridge in interface InternalEventContext