LocalAttributeMap

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.webflow.core.collection
Class LocalAttributeMap

java.lang.Object
  org.springframework.webflow.core.collection.LocalAttributeMap

All Implemented Interfaces:: Serializable, MapAdaptable, AttributeMap, MutableAttributeMap

Direct Known Subclasses:: LocalSharedAttributeMap

public class LocalAttributeMap
extends Object
implements MutableAttributeMap, Serializable
extends Object
implements MutableAttributeMap, Serializable

A generic, mutable attribute map with string keys.

Author:: Keith Donald
See Also:: Serialized Form

Constructor Summary
`LocalAttributeMap()` Creates a new attribute map, initially empty.
`LocalAttributeMap(int size, int loadFactor)` Creates a new attribute map, initially empty.
`LocalAttributeMap(Map map)` Creates a new attribute map wrapping the specified map.
`LocalAttributeMap(String attributeName, Object attributeValue)` Creates a new attribute map with a single entry.

Method Summary
`Map`	`asMap()` Returns this object's contents as a `Map`.
`MutableAttributeMap`	`clear()` Remove all attributes in this map.
`boolean`	`contains(String attributeName)` Does the attribute with the provided name exist in this map?
`boolean`	`contains(String attributeName, Class requiredType)` Does the attribute with the provided name exist in this map and is its value of the specified required type?
`boolean`	`equals(Object o)`
`Object`	`extract(String attributeName)` Extract an attribute from this map, getting it and removing it in a single operation.
`Object`	`get(String attributeName)` Get an attribute value out of this map, returning `null` if not found.
`Object`	`get(String attributeName, Class requiredType)` Get an attribute value, asserting the value is of the required type.
`Object`	`get(String attributeName, Class requiredType, Object defaultValue)` Get an attribute value, asserting the value is of the required type and returning the default value if not found.
`Object`	`get(String attributeName, Object defaultValue)` Get an attribute value, returning the default value if no value is found.
`Object[]`	`getArray(String attributeName, Class requiredType)` Returns an array attribute value in the map and makes sure it is of the required type.
`Boolean`	`getBoolean(String attributeName)` Returns a boolean attribute value in the map, returning `null` if no value was found.
`Boolean`	`getBoolean(String attributeName, Boolean defaultValue)` Returns a boolean attribute value in the map, returning the default value if no value was found.
`Collection`	`getCollection(String attributeName)` Returns a collection attribute value in the map.
`Collection`	`getCollection(String attributeName, Class requiredType)` Returns a collection attribute value in the map and make sure it is of the required type.
`Integer`	`getInteger(String attributeName)` Returns an integer attribute value in the map, returning `null` if no value was found.
`Integer`	`getInteger(String attributeName, Integer defaultValue)` Returns an integer attribute value in the map, returning the default value if no value was found.
`Long`	`getLong(String attributeName)` Returns a long attribute value in the map, returning `null` if no value was found.
`Long`	`getLong(String attributeName, Long defaultValue)` Returns a long attribute value in the map, returning the default value if no value was found.
`Number`	`getNumber(String attributeName, Class requiredType)` Returns a number attribute value in the map that is of the specified type, returning `null` if no value was found.
`Number`	`getNumber(String attributeName, Class requiredType, Number defaultValue)` Returns a number attribute value in the map of the specified type, returning the default value if no value was found.
`Object`	`getRequired(String attributeName)` Get the value of a required attribute, throwing an exception of no attribute is found.
`Object`	`getRequired(String attributeName, Class requiredType)` Get the value of a required attribute and make sure it is of the required type.
`Object[]`	`getRequiredArray(String attributeName, Class requiredType)` Returns an array attribute value in the map, throwing an exception if the attribute is not present or not an array of the required type.
`Boolean`	`getRequiredBoolean(String attributeName)` Returns a boolean attribute value in the map, throwing an exception if the attribute is not present and of the correct type.
`Collection`	`getRequiredCollection(String attributeName)` Returns a collection attribute value in the map, throwing an exception if the attribute is not present or not a collection.
`Collection`	`getRequiredCollection(String attributeName, Class requiredType)` Returns a collection attribute value in the map, throwing an exception if the attribute is not present or not a collection of the required type.
`Integer`	`getRequiredInteger(String attributeName)` Returns an integer attribute value in the map, throwing an exception if the attribute is not present and of the correct type.
`Long`	`getRequiredLong(String attributeName)` Returns a long attribute value in the map, throwing an exception if the attribute is not present and of the correct type.
`Number`	`getRequiredNumber(String attributeName, Class requiredType)` Returns a number attribute value in the map, throwing an exception if the attribute is not present and of the correct type.
`String`	`getRequiredString(String attributeName)` Returns a string attribute value in the map, throwing an exception if the attribute is not present and of the correct type.
`String`	`getString(String attributeName)` Returns a string attribute value in the map, returning `null` if no value was found.
`String`	`getString(String attributeName, String defaultValue)` Returns a string attribute value in the map, returning the default value if no value was found.
`int`	`hashCode()`
`boolean`	`isEmpty()` Is this attribute map empty with a size of 0?
`Object`	`put(String attributeName, Object attributeValue)` Put the attribute into this map.
`MutableAttributeMap`	`putAll(AttributeMap attributes)` Put all the attributes into this map.
`Object`	`remove(String attributeName)` Remove an attribute from this map.
`MutableAttributeMap`	`removeAll(MutableAttributeMap attributes)` Remove all attributes in the map provided from this map.
`MutableAttributeMap`	`replaceWith(AttributeMap attributes)` Replace the contents of this attribute map with the contents of the provided collection.
`int`	`size()` Returns the size of this map.
`String`	`toString()`
`AttributeMap`	`union(AttributeMap attributes)` Returns a new attribute map containing the union of this map with the provided map.

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

LocalAttributeMap

public LocalAttributeMap()

Creates a new attribute map, initially empty.

LocalAttributeMap

public LocalAttributeMap(int size,
                         int loadFactor)

Creates a new attribute map, initially empty.

Parameters:: size - the initial size; loadFactor - the load factor

LocalAttributeMap

public LocalAttributeMap(String attributeName,
                         Object attributeValue)

Creates a new attribute map with a single entry.

LocalAttributeMap

public LocalAttributeMap(Map map)

Creates a new attribute map wrapping the specified map.

Method Detail

asMap

public Map asMap()

Description copied from interface: MapAdaptable

Returns this object's contents as a Map. The returned map may or may not be modifiable depending on this implementation.

Warning: this operation may be called frequently; if so care should be taken so that the map contents (if calculated) be cached as appropriate.

Specified by:: asMap in interface MapAdaptable

Returns:: the object's contents as a map