org.apache.tools.ant.taskdefs

Class MacroDef.Text

java.lang.Object

org.apache.tools.ant.taskdefs.MacroDef.Text

Enclosing class:

MacroDef

public static class MacroDef.Text
extends Object

A nested text element for the MacroDef task.

Since:

ant 1.6.1

Constructor Summary

Constructors

Constructor and Description
Text()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) equality method
String	getDefault()
String	getDescription()
String	getName()
boolean	getOptional()
boolean	getTrim()
int	hashCode() Returns a hash code value for the object.
void	setDefault(String defaultString)
void	setDescription(String desc)
void	setName(String name) The name of the attribute.
void	setOptional(boolean optional) The optional attribute of the text element.
void	setTrim(boolean trim) The trim attribute of the text element.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Text

public Text()

Method Detail

equals

public boolean equals(Object obj)

equality method

Overrides:

equals in class Object

Parameters:

obj - an Object value

Returns:

a boolean value

See Also:

Object.hashCode(), HashMap

getDefault

public String getDefault()

Returns:

the default text if set, null otherwise.

getDescription

public String getDescription()

Returns:

the description of the text, or null if no description is available.

getName

public String getName()

Returns:

the name of the attribute

getOptional

public boolean getOptional()

Returns:

true if the text is optional

getTrim

public boolean getTrim()

Returns:

true if the text is trim

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

setDefault

public void setDefault(String defaultString)

Parameters:

defaultString - default text for the string.

setDescription

public void setDescription(String desc)

Parameters:

desc - Description of the text.

setName

public void setName(String name)

The name of the attribute.

Parameters:

name - the name of the attribute

setOptional

public void setOptional(boolean optional)

The optional attribute of the text element.

Parameters:

optional - if true this is optional

setTrim

public void setTrim(boolean trim)

The trim attribute of the text element.

Parameters:

trim - if true this String.trim() is called on the contents of the text element.