org.apache.commons.jelly.tags.ant
Interface PropsHandler

All Known Implementing Classes:

DefaultPropsHandler, JellyPropsHandler

public interface PropsHandler

Interface for delegates supporting property management for aGrantProject.

Author:

Bob McWhirter, Stephen Haberman

See Also:

GrantProject.setProperty(java.lang.String, java.lang.String), GrantProject.setNewProperty(java.lang.String, java.lang.String), GrantProject.setUserProperty(java.lang.String, java.lang.String), GrantProject.setInheritedProperty(java.lang.String, java.lang.String), GrantProject.getProperty(java.lang.String), GrantProject.getUserProperty(java.lang.String), GrantProject.getProperties(), GrantProject.getUserProperties(), GrantProject.copyUserProperties(org.apache.tools.ant.Project), GrantProject.copyInheritedProperties(org.apache.tools.ant.Project), GrantProject.setSystemProperties(), GrantProject.setJavaVersionProperty()

Method Summary

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	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.

Method Detail

setProperty

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

Set a property.

Parameters:

key - The property key.

value - The value.

setUserProperty

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

Set a user property.

Parameters:

key - The user property key.

value - The value.

setNewProperty

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

Set a new property.

Parameters:

key - The property key.

value - The value.

setInheritedProperty

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

Sets an inherited property.

Parameters:

key - The user property key.

value - The value.

setPropertyIfUndefinedByUser

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

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

Parameters:

key - The property key.

value - The value.

getProperty

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

Retrieve a property.

Parameters:

key - The property key.

Returns:

The value.

getUserProperty

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

Retrieve a user property.

Parameters:

key - The user property key.

Returns:

The value.

getProperties

java.util.Hashtable getProperties()

Retrieve a Hashtable of all properties.

Returns:

A Hashtable of all properties.

getUserProperties

java.util.Hashtable getUserProperties()

Retrieve a Hashtable of all user properties.

Returns:

A Hashtable of all user properties.

copyUserProperties

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

Copy all of the user properties to the other Project.

Parameters:

other - The Project to copy the properties to.

copyInheritedProperties

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

Copy all of the inherited properties to the other Project.

Parameters:

other - The Project to copy the properties to.

setSystemProperties

void setSystemProperties()

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

setJavaVersionProperty

void setJavaVersionProperty()

Set the ant.java.version property.