freemarker.template

Class SimpleHash

Implemented Interfaces:
Serializable, TemplateHashModel, TemplateHashModelEx, TemplateModel
Known Direct Subclasses:
AllHttpScopesHashModel, Environment.Namespace

public class SimpleHash
extends WrappingTemplateModel
implements TemplateHashModelEx, Serializable

A simple implementation of the TemplateHashModelEx interface, using an underlying Map or SortedMap.

This class is thread-safe if you don't call the put or remove methods after you have made the object available for multiple threads.

Note:
As of 2.0, this class is unsynchronized by default. To obtain a synchronized wrapper, call the synchronizedWrapper() method.

Version:
$Id: SimpleHash.java,v 1.72.2.2 2006/02/26 18:26:18 revusky Exp $
See Also:
SimpleSequence, SimpleScalar

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

SimpleHash()
Constructs an empty hash that uses the default wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper).
SimpleHash(Map map)
Creates a new simple hash with the copy of the underlying map and the default wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper).
SimpleHash(Map map, ObjectWrapper wrapper)
Creates a new simple hash with the copy of the underlying map and either the default wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper), or the JavaBeans wrapper.
SimpleHash(ObjectWrapper wrapper)
Creates an empty simple hash using the specified object wrapper.

Method Summary

protected Map
copyMap(Map map)
TemplateModel
get(String key)
boolean
isEmpty()
TemplateCollectionModel
keys()
void
put(String key, Object obj)
Adds a key-value entry to the map.
void
put(String key, boolean b)
Puts a boolean in the map
void
putAll(Map m)
Adds all the key/value entries in the map
void
remove(String key)
Removes the given key from the underlying map.
int
size()
SimpleHash
synchronizedWrapper()
Map
toMap()
Note that this method creates and returns a deep-copy of the underlying hash used internally.
String
toString()
Convenience method for returning the String value of the underlying map.
TemplateCollectionModel
values()

Methods inherited from class freemarker.template.WrappingTemplateModel

getDefaultObjectWrapper, getObjectWrapper, setDefaultObjectWrapper, setObjectWrapper, wrap

Constructor Details

SimpleHash

public SimpleHash()

SimpleHash

public SimpleHash(Map map)
Parameters:
map - The Map to use for the key/value pairs. It makes a copy for internal use. If the map implements the SortedMap interface, the internal copy will be a TreeMap, otherwise it will be a HashMap.

SimpleHash

public SimpleHash(Map map,
                  ObjectWrapper wrapper)
Creates a new simple hash with the copy of the underlying map and either the default wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper), or the JavaBeans wrapper.
Parameters:
map - The Map to use for the key/value pairs. It makes a copy for internal use. If the map implements the SortedMap interface, the internal copy will be a TreeMap, otherwise it will be a
wrapper - The object wrapper to use to wrap objects into TemplateModel instances. If null, the default wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper) is used.

SimpleHash

public SimpleHash(ObjectWrapper wrapper)
Creates an empty simple hash using the specified object wrapper.
Parameters:
wrapper - The object wrapper to use to wrap objects into TemplateModel instances. If null, the default wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper) is used.

Method Details

copyMap

protected Map copyMap(Map map)

get

public TemplateModel get(String key)
            throws TemplateModelException
Specified by:
get in interface TemplateHashModel

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface TemplateHashModel

keys

public TemplateCollectionModel keys()
Specified by:
keys in interface TemplateHashModelEx
Returns:
a collection containing the keys in the hash. Every element of the returned collection must implement the TemplateScalarModel (as the keys of hashes are always strings).

put

public void put(String key,
                Object obj)
Adds a key-value entry to the map.
Parameters:
key - the name by which the object is identified in the template.
obj - the object to store.

put

public void put(String key,
                boolean b)
Puts a boolean in the map
Parameters:
key - the name by which the resulting TemplateModel is identified in the template.
b - the boolean to store.

putAll

public void putAll(Map m)
Adds all the key/value entries in the map
Parameters:
m - the map with the entries to add, the keys are assumed to be strings.

remove

public void remove(String key)
Removes the given key from the underlying map.
Parameters:
key - the key to be removed

size

public int size()
Specified by:
size in interface TemplateHashModelEx
Returns:
the number of key/value mappings in the hash.

synchronizedWrapper

public SimpleHash synchronizedWrapper()

toMap

public Map toMap()
            throws TemplateModelException
Note that this method creates and returns a deep-copy of the underlying hash used internally. This could be a gotcha for some people at some point who want to alter something in the data model, but we should maintain our immutability semantics (at least using default SimpleXXX wrappers) for the data model. It will recursively unwrap the stuff in the underlying container.

toString

public String toString()
Convenience method for returning the String value of the underlying map.

values

public TemplateCollectionModel values()
Specified by:
values in interface TemplateHashModelEx
Returns:
a collection containing the values in the hash.