org.apache.commons.grant

Class DefaultPropsHandler

java.lang.Object

org.apache.commons.grant.DefaultPropsHandler

All Implemented Interfaces:

PropsHandler

public class DefaultPropsHandler
extends java.lang.Object
implements PropsHandler

Implements the basic PropsHandler functionality against an existing map.

If extending DefaultPropsHandler, you can implement setProperty, getProperty, and getProperties to provide a complete implementation of PropsHandler.

Version:

$Revision: 1.2 $

Author:

Stephen Haberman

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map	inheritedProperties A history of the properties makred as inherited properties.
protected java.util.Map	properties A map of all of the properties.
protected java.util.Map	userProperties A history of the properties marked as user properties.

Constructor Summary

Constructors

Constructor and Description
DefaultPropsHandler() Initializes hte object with a blank set of properties.
DefaultPropsHandler(java.util.Map properties) Initializes the object with a given Map implementation.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyInheritedProperties(org.apache.tools.ant.Project other) Copy all of the inherited properties to the other Project.
void	copyUserProperties(org.apache.tools.ant.Project other) Copy all of the user properties to the other Project.
java.util.Hashtable	getInheritedProperties()
java.util.Hashtable	getProperties() Retrieve a Hashtable of all properties.
java.lang.String	getProperty(java.lang.String key) Retrieve a property.
java.util.Hashtable	getUserProperties() Retrieve a Hashtable of all user properties.
java.lang.String	getUserProperty(java.lang.String key) Retrieve a user property.
void	setInheritedProperty(java.lang.String key, java.lang.String value) Sets an inherited property.
void	setJavaVersionProperty() Set the ant.java.version property.
void	setNewProperty(java.lang.String key, java.lang.String value) Set a new property.
void	setProperty(java.lang.String key, java.lang.String value) Set a property.
void	setPropertyIfUndefinedByUser(java.lang.String key, java.lang.String value) Sets a property that is not a user property.
void	setSystemProperties() Set the system variables for a Project that have not already been assigned as user properties.
void	setUserProperty(java.lang.String key, java.lang.String value) Set a user property.

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected java.util.Map properties

A map of all of the properties.

userProperties

protected java.util.Map userProperties

A history of the properties marked as user properties.

inheritedProperties

protected java.util.Map inheritedProperties

A history of the properties makred as inherited properties.

Constructor Detail

DefaultPropsHandler

public DefaultPropsHandler()

Initializes hte object with a blank set of properties.

DefaultPropsHandler

public DefaultPropsHandler(java.util.Map properties)

Initializes the object with a given Map implementation.

Parameters:

properties - The Map to use to store and retrieve properties.

Method Detail

setProperty

public void setProperty(java.lang.String key,
               java.lang.String value)

Description copied from interface: PropsHandler

Set a property.

Specified by:

setProperty in interface PropsHandler

Parameters:

key - The property key.

value - The value.

See Also:

PropsHandler.setProperty(String, String)

setUserProperty

public void setUserProperty(java.lang.String key,
                   java.lang.String value)

Description copied from interface: PropsHandler

Set a user property.

Specified by:

setUserProperty in interface PropsHandler

Parameters:

key - The user property key.

value - The value.

See Also:

PropsHandler.setUserProperty(String, String)

setNewProperty

public void setNewProperty(java.lang.String key,
                  java.lang.String value)

Description copied from interface: PropsHandler

Set a new property.

Specified by:

setNewProperty in interface PropsHandler

Parameters:

key - The property key.

value - The value.

See Also:

PropsHandler.setNewProperty(String, String)

setInheritedProperty

public void setInheritedProperty(java.lang.String key,
                        java.lang.String value)

Description copied from interface: PropsHandler

Sets an inherited property.

Specified by:

setInheritedProperty in interface PropsHandler

Parameters:

key - The user property key.

value - The value.

See Also:

PropsHandler.setInheritedProperty(String, String)

setPropertyIfUndefinedByUser

public void setPropertyIfUndefinedByUser(java.lang.String key,
                                java.lang.String value)

Description copied from interface: PropsHandler

Sets a property that is not a user property. Acts as the replacement for ant's private setPropertyInternal method.

Specified by:

setPropertyIfUndefinedByUser in interface PropsHandler

Parameters:

key - The property key.

value - The value.

See Also:

PropsHandler.setPropertyIfUndefinedByUser(String, String)

getProperty

public java.lang.String getProperty(java.lang.String key)

Description copied from interface: PropsHandler

Retrieve a property.

Specified by:

getProperty in interface PropsHandler

Parameters:

key - The property key.

Returns:

The value.

See Also:

PropsHandler.getProperty(String)

getUserProperty

public java.lang.String getUserProperty(java.lang.String key)

Description copied from interface: PropsHandler

Retrieve a user property.

Specified by:

getUserProperty in interface PropsHandler

Parameters:

key - The user property key.

Returns:

The value.

See Also:

PropsHandler.getUserProperty(String)

getProperties

public java.util.Hashtable getProperties()

Description copied from interface: PropsHandler

Retrieve a Hashtable of all properties.

Specified by:

getProperties in interface PropsHandler

Returns:

A Hashtable of all properties.

See Also:

PropsHandler.getProperties()

getUserProperties

public java.util.Hashtable getUserProperties()

Description copied from interface: PropsHandler

Retrieve a Hashtable of all user properties.

Specified by:

getUserProperties in interface PropsHandler

Returns:

A Hashtable of all user properties.

See Also:

PropsHandler.getUserProperties()

getInheritedProperties

public java.util.Hashtable getInheritedProperties()

copyUserProperties

public void copyUserProperties(org.apache.tools.ant.Project other)

Description copied from interface: PropsHandler

Copy all of the user properties to the other Project.

Specified by:

copyUserProperties in interface PropsHandler

Parameters:

other - The Project to copy the properties to.

See Also:

PropsHandler.copyUserProperties(Project)

copyInheritedProperties

public void copyInheritedProperties(org.apache.tools.ant.Project other)

Description copied from interface: PropsHandler

Copy all of the inherited properties to the other Project.

Specified by:

copyInheritedProperties in interface PropsHandler

Parameters:

other - The Project to copy the properties to.

See Also:

PropsHandler.copyInheritedProperties(Project)

setSystemProperties

public void setSystemProperties()

Description copied from interface: PropsHandler

Set the system variables for a Project that have not already been assigned as user properties.

Specified by:

setSystemProperties in interface PropsHandler

See Also:

PropsHandler.setSystemProperties()

setJavaVersionProperty

public void setJavaVersionProperty()

Description copied from interface: PropsHandler

Set the ant.java.version property.

Specified by:

setJavaVersionProperty in interface PropsHandler

See Also:

PropsHandler.setJavaVersionProperty()