|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--freemarker.template.SimpleHash
A simple implementation of the TemplateHashModel
and
TemplateModelRoot
interfaces, using an underlying
Map
.
All the public methods in this implementation are synchronized.
SimpleList
,
SimpleScalar
,
SimpleNumber
, Serialized FormField Summary | |
protected java.util.Map |
hash
The contents of this SimpleHash are stored in this
Map object. |
Constructor Summary | |
SimpleHash()
Constructs an empty SimpleHash . |
|
SimpleHash(java.util.Map hash)
Constructs a SimpleHash given the backing Map . |
Method Summary | |
boolean |
equals(java.lang.Object o)
Tests this object for equality with the given object. |
TemplateModel |
get(java.lang.String key)
Gets a TemplateModel from the underlying hash. |
java.lang.Object |
getAsObject()
Return an unmodifiable copy of the underlying Map object
for manipulation by the freemarker.ext.beans package. |
int |
hashCode()
Return the hash value for this object. |
boolean |
isEmpty()
Is the underlying Map empty? |
void |
put(java.lang.String key,
boolean value)
Puts a boolean in the hash, by first wrapping the boolean in a FastBoolean . |
void |
put(java.lang.String key,
long value)
Puts a number in the hash, by first wrapping the string in a FastNumber . |
void |
put(java.lang.String key,
java.lang.Number value)
Puts a number in the hash, by first wrapping the string in a FastNumber . |
void |
put(java.lang.String key,
java.lang.String value)
Puts a string in the hash, by first wrapping the string in a FastScalar . |
void |
put(java.lang.String key,
TemplateModel model)
Puts a TemplateModel in the hash. |
void |
remove(java.lang.String key)
Removes the given key from the underlying Map . |
java.lang.String |
toString()
Convenience method for returning the String value of the
underlying hash. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
protected java.util.Map hash
SimpleHash
are stored in this
Map
object.Constructor Detail |
public SimpleHash()
SimpleHash
.public SimpleHash(java.util.Map hash)
SimpleHash
given the backing Map
.hash
- The Map
to use as the backing for this
SimpleHash
.NullPointerException
- the map value is nullMethod Detail |
public boolean isEmpty() throws TemplateModelException
Map
empty?isEmpty
in interface TemplateModel
true
if the Map
is empty, otherwise
false
public void put(java.lang.String key, TemplateModel model)
TemplateModel
in the hash.put
in interface TemplateModelRoot
key
- the name by which the TemplateModel
is
identified in the template.model
- the TemplateModel
to store.public void put(java.lang.String key, java.lang.String value)
FastScalar
.key
- the name by which the resulting TemplateModel
is identified in the template.value
- the string to store.public void put(java.lang.String key, java.lang.Number value)
FastNumber
.key
- the name by which the resulting TemplateModel
is identified in the template.value
- the number to store.public void put(java.lang.String key, long value)
FastNumber
.key
- the name by which the resulting TemplateModel
is identified in the template.value
- the number to store.public void put(java.lang.String key, boolean value)
FastBoolean
.key
- the name by which the resulting TemplateModel
is identified in the template.value
- the boolean to store.public TemplateModel get(java.lang.String key) throws TemplateModelException
TemplateModel
from the underlying hash.get
in interface TemplateHashModel
key
- the name by which the TemplateModel
is identified in the template.TemplateModel
referred to by the key,
or null
if not found.public void remove(java.lang.String key)
Map
.remove
in interface TemplateModelRoot
key
- the key to be removedpublic java.lang.Object getAsObject() throws TemplateModelException
Map
object
for manipulation by the freemarker.ext.beans
package.getAsObject
in interface TemplateObjectModel
Map
objectpublic java.lang.String toString()
String
value of the
underlying hash.toString
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- the object to be compared againsttrue
if the objects are equal, otherwise
false
public int hashCode()
hashCode
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |