org.jcon.util

Class PropMap

java.lang.Object

org.jcon.util.PropMap

All Implemented Interfaces:

java.io.Serializable

public class PropMap
extends java.lang.Object
implements java.io.Serializable

A reusable set of key value pairs, aka properties. Each property is mapped to a key. This class is designed to make parameter driven designs easier to implement. It's similar to a HashMap. An instance of this class contains zero or more key value pairs. The key must be a String. The value may be any Object. Convenience methods are provided for common and primative values. Unlike HashMap, null values are supported. This is because null is a meaningful value for a property.

Author:

Jack Harich (was KeyValues)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap	properties

Constructor Summary

Constructors

Constructor and Description
PropMap()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Performs a shallow copy.
java.lang.Object	get(java.lang.String key) Returns a named property.
int	getInt(java.lang.String name)
java.awt.Point	getPoint(java.lang.String name)
java.lang.String	getString(java.lang.String name)
boolean	has(java.lang.String name) Returns true if the set has the property, false if not.
boolean	isFalse(java.lang.String name)
boolean	isTrue(java.lang.String name)
java.util.Iterator	keys()
java.lang.Object	remove(java.lang.String name) This should be used carefully since collaborators may be relying on property structure.
void	set(java.lang.String key, java.lang.Object value) Sets a named property.
void	setBoolean(java.lang.String name, boolean value)
void	setFalse(java.lang.String name)
void	setInt(java.lang.String name, int value)
void	setPoint(java.lang.String name, java.awt.Point value)
void	setString(java.lang.String name, java.lang.String value)
void	setTrue(java.lang.String name)
java.lang.String	toString() Returns a comma delimited string of key/values, for example: "[Name=Pantajeli, Age=11]" This is designed to be easily readable.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

properties

protected java.util.HashMap properties

Constructor Detail

PropMap

public PropMap()

Method Detail

toString

public java.lang.String toString()

Returns a comma delimited string of key/values, for example: "[Name=Pantajeli, Age=11]" This is designed to be easily readable.

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Performs a shallow copy.

Overrides:

clone in class java.lang.Object

set

public void set(java.lang.String key,
       java.lang.Object value)

Sets a named property. Null values are supported.

get

public java.lang.Object get(java.lang.String key)

Returns a named property. Returns null if not found or the value is null.

remove

public java.lang.Object remove(java.lang.String name)

This should be used carefully since collaborators may be relying on property structure.

has

public boolean has(java.lang.String name)

Returns true if the set has the property, false if not. If getObject() returns null then has() can be used to determine if this means the PropMap has the property or the value is really null.

keys

public java.util.Iterator keys()

getString

public java.lang.String getString(java.lang.String name)

setString

public void setString(java.lang.String name,
             java.lang.String value)

isTrue

public boolean isTrue(java.lang.String name)

isFalse

public boolean isFalse(java.lang.String name)

setBoolean

public void setBoolean(java.lang.String name,
              boolean value)

setTrue

public void setTrue(java.lang.String name)

setFalse

public void setFalse(java.lang.String name)

getInt

public int getInt(java.lang.String name)

setInt

public void setInt(java.lang.String name,
          int value)

getPoint

public java.awt.Point getPoint(java.lang.String name)

setPoint

public void setPoint(java.lang.String name,
            java.awt.Point value)