org.rendersnake.internal

Interface ContextMap

All Known Implementing Classes:

LoggingPageContext, PageContext, RequestHeadersMap, RequestParametersMap, SessionAttributesMap, SimpleContextMap

public interface ContextMap

Method Summary

Modifier and Type	Method and Description
Object	clear(String key) Remove all entries from the Map.
Boolean	getBoolean(String key, Boolean... optional) Return the Boolean value stored a the key, or the value of optional if absent.
Float	getFloat(String key, Float... optional) Return the Float value stored a the key, or the value of optional if absent.
Integer	getInteger(String key, Integer... optional) Return the Integer value stored a the key, or the value of optional if absent.
Long	getLong(String key, Long... optional) Return the Float value stored a the key, or the value of optional if absent.
Object	getObject(String key, Object... optional) Return the Object value stored a the key, or the value of optional if absent.
String	getString(String key, String... optional) Return the String value stored a the key, or the value of optional if absent.
Map<Object,Object>	toMap() Return a new Map containing all the context key,value pairs.
ContextMap	withBoolean(String key, Boolean trueOrFalse) Add (or overwrite) a key,Boolean pair to the Map.
ContextMap	withFloat(String key, Float aFloat) Add (or overwrite) a key,Float pair to the Map.
ContextMap	withInteger(String key, Integer anInteger) Add (or overwrite) a key,Integer pair to the Map.
ContextMap	withLong(String key, Long aLong) Add (or overwrite) a key,Long pair to the Map.
ContextMap	withObject(String key, Object value) Add (or overwrite) a key,Object pair to the Map.
ContextMap	withString(String key, String value) Add (or overwrite) a key,String pair to the Map.

Method Detail

getBoolean

Boolean getBoolean(String key,
                   Boolean... optional)

Return the Boolean value stored a the key, or the value of optional if absent.

Parameters:

key -

optional -

Returns:

withBoolean

ContextMap withBoolean(String key,
                       Boolean trueOrFalse)

Add (or overwrite) a key,Boolean pair to the Map. Return the Map.

Parameters:

key -

value -

Returns:

getLong

Long getLong(String key,
             Long... optional)

Return the Float value stored a the key, or the value of optional if absent.

Parameters:

key -

optional -

Returns:

withLong

ContextMap withLong(String key,
                    Long aLong)

Add (or overwrite) a key,Long pair to the Map. Return the Map.

Parameters:

key -

value -

Returns:

getFloat

Float getFloat(String key,
               Float... optional)

Return the Float value stored a the key, or the value of optional if absent.

Parameters:

key -

optional -

Returns:

withFloat

ContextMap withFloat(String key,
                     Float aFloat)

Add (or overwrite) a key,Float pair to the Map. Return the Map.

Parameters:

key -

value -

Returns:

getInteger

Integer getInteger(String key,
                   Integer... optional)

Return the Integer value stored a the key, or the value of optional if absent.

Parameters:

key -

optional -

Returns:

withInteger

ContextMap withInteger(String key,
                       Integer anInteger)

Add (or overwrite) a key,Integer pair to the Map. Return the Map.

Parameters:

key -

value -

Returns:

getObject

Object getObject(String key,
                 Object... optional)

Return the Object value stored a the key, or the value of optional if absent.

Parameters:

key -

optional -

Returns:

withObject

ContextMap withObject(String key,
                      Object value)

Add (or overwrite) a key,Object pair to the Map. Return the Map.

Parameters:

key -

value -

Returns:

getString

String getString(String key,
                 String... optional)

Return the String value stored a the key, or the value of optional if absent.

Parameters:

key -

optional -

Returns:

withString

ContextMap withString(String key,
                      String value)

Add (or overwrite) a key,String pair to the Map. Return the Map.

Parameters:

key -

value -

Returns:

clear

Object clear(String key)

Remove all entries from the Map.

Parameters:

key -

Returns:

toMap

Map<Object,Object> toMap()

Return a new Map containing all the context key,value pairs.

Returns: