org.rhq.bundle.ant.type

Class InputPropertyType

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.types.DataType

org.rhq.bundle.ant.type.AbstractBundleType

org.rhq.bundle.ant.type.InputPropertyType

All Implemented Interfaces:

Cloneable

public class InputPropertyType
extends AbstractBundleType

An Ant type that defines a basic property that the user provides as input for deployment of a bundle. Typically, the property will be substituted into configuration files from the bundle during deployment - see ReplaceTask. If the deployment script is invoked from the GUI, the user will be prompted for values for any input properties that are defined via this type. If the script is invoked from the command line, the properties must be passed using the -D and/or -propertyfile options.

Author:

Ian Springer

Field Summary

Fields inherited from class org.apache.tools.ant.types.DataType

checked, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

location, project

Constructor Summary

Constructors

Constructor and Description
InputPropertyType()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultValue()
String	getDescription()
String	getName()
Boolean	getRequired()
String	getType()
void	init()
void	setDefaultValue(String defaultValue)
void	setDescription(String description)
void	setName(String name)
void	setRequired(Boolean required)
void	setType(String type)
protected void	validateAttributes() Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.

Methods inherited from class org.rhq.bundle.ant.type.AbstractBundleType

buildIncludePatternRegex, getPattern, getProject

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString

Methods inherited from class org.apache.tools.ant.ProjectComponent

getLocation, log, log, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

InputPropertyType

public InputPropertyType()

Method Detail

init

public void init()
          throws org.apache.tools.ant.BuildException

Throws:

org.apache.tools.ant.BuildException

getDescription

public String getDescription()

Overrides:

getDescription in class org.apache.tools.ant.ProjectComponent

setDescription

public void setDescription(String description)

Overrides:

setDescription in class org.apache.tools.ant.ProjectComponent

getName

public String getName()

setName

public void setName(String name)

getDefaultValue

public String getDefaultValue()

setDefaultValue

public void setDefaultValue(String defaultValue)

getRequired

public Boolean getRequired()

setRequired

public void setRequired(Boolean required)

getType

public String getType()

setType

public void setType(String type)

validateAttributes

protected void validateAttributes()
                           throws org.apache.tools.ant.BuildException

Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.

Throws:

org.apache.tools.ant.BuildException - if an error occurs