Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.opensymphony.module.propertyset.map
Class MapPropertySet

java.lang.Object
  extended bycom.opensymphony.module.propertyset.AbstractPropertySet
      extended bycom.opensymphony.module.propertyset.map.MapPropertySet
All Implemented Interfaces:
PropertySet
public class MapPropertySet
extends AbstractPropertySet

The MapPropertySet is an UNTYPED PropertySet implementation that acts as a wrapper around a standard Map .

Because Map's will only store the value but not the type, this is untyped. See PropertySet for explanation.

Optional Args
  • map - the map that will back this PropertySet

Version:
$Revision: 1.3 $
Author:
Joe Walnes
See Also:
PropertySet

Field Summary
protected  java.util.Map map
          Underlying Map storing properties.
 
Fields inherited from class com.opensymphony.module.propertyset.AbstractPropertySet
schema
 
Fields inherited from interface com.opensymphony.module.propertyset.PropertySet
BOOLEAN, DATA, DATE, DOUBLE, INT, LONG, OBJECT, PROPERTIES, STRING, TEXT, XML
 
Constructor Summary
MapPropertySet()
           
 
Method Summary
 boolean exists(java.lang.String key)
          Determine if property exists.
protected  java.lang.Object get(int type, java.lang.String key)
          The type parameter is ignored.
 java.util.Collection getKeys(java.lang.String prefix, int type)
          The type parameter is ignored.
 java.util.Map getMap()
          Retrieve underlying map.
 int getType(java.lang.String key)
          This is an untyped PropertySet implementation so this method will always throw UnsupportedOperationException .
 void init(java.util.Map config, java.util.Map args)
           
 void remove()
          Remove the propertyset and all it associated keys.
 void remove(java.lang.String key)
          Removes property.
protected  void setImpl(int type, java.lang.String key, java.lang.Object value)
          The type parameter is ignored.
 void setMap(java.util.Map map)
          Set underlying map.
 boolean supportsType(int type)
          Returns false.
 boolean supportsTypes()
          Returns false.
 
Methods inherited from class com.opensymphony.module.propertyset.AbstractPropertySet
getAsActualType, getBoolean, getData, getDate, getDouble, getInt, getKeys, getKeys, getKeys, getLong, getObject, getProperties, getSchema, getString, getText, getXML, isSettable, setAsActualType, setBoolean, setData, setDate, setDouble, setInt, setLong, setObject, setProperties, setSchema, setString, setText, setXML, toString, type, type
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

map

protected java.util.Map map
Underlying Map storing properties.

Constructor Detail

MapPropertySet

public MapPropertySet()
Method Detail

getKeys

public java.util.Collection getKeys(java.lang.String prefix,
                                    int type)
The type parameter is ignored.

Parameters:
prefix - String that keys must start with. If null, than all keys shall be returned.
type - Type to list. See static class variables. If null, then all types shall be returned.
Returns:
Unmodifiable Collection of Strings.

setMap

public void setMap(java.util.Map map)
Set underlying map.

getMap

public java.util.Map getMap()
Retrieve underlying map.

getType

public int getType(java.lang.String key)
            throws java.lang.UnsupportedOperationException
This is an untyped PropertySet implementation so this method will always throw UnsupportedOperationException .

Returns:
Type of value. See static class variables.
Throws:
java.lang.UnsupportedOperationException

exists

public boolean exists(java.lang.String key)
Description copied from interface: PropertySet
Determine if property exists.

init

public void init(java.util.Map config,
                 java.util.Map args)
Specified by:
init in interface PropertySet
Overrides:
init in class AbstractPropertySet

remove

public void remove(java.lang.String key)
Description copied from interface: PropertySet
Removes property.

remove

public void remove()
            throws PropertyException
Description copied from interface: PropertySet
Remove the propertyset and all it associated keys.

Throws:
PropertyException - if there is an error removing the propertyset.

supportsType

public boolean supportsType(int type)
Returns false.

Specified by:
supportsType in interface PropertySet
Overrides:
supportsType in class AbstractPropertySet

supportsTypes

public boolean supportsTypes()
Returns false.

Specified by:
supportsTypes in interface PropertySet
Overrides:
supportsTypes in class AbstractPropertySet

setImpl

protected void setImpl(int type,
                       java.lang.String key,
                       java.lang.Object value)
The type parameter is ignored.

Specified by:
setImpl in class AbstractPropertySet

get

protected java.lang.Object get(int type,
                               java.lang.String key)
The type parameter is ignored.

Specified by:
get in class AbstractPropertySet
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
See www.opensymphony.com for more information.
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2000-2005 - OpenSymphony