org.apache.tools.ant.taskdefs

Class MacroDef.TemplateElement

java.lang.Object

org.apache.tools.ant.taskdefs.MacroDef.TemplateElement

Enclosing class:

MacroDef

public static class MacroDef.TemplateElement
extends Object

A nested element for the MacroDef task.

Constructor Summary

Constructors

Constructor and Description
TemplateElement()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) equality method.
String	getDescription() Gets the description of this element.
String	getName() Gets the name of this element.
int	hashCode() Returns a hash code value for the object.
boolean	isImplicit() Gets whether this element is implicit.
boolean	isOptional() Gets whether this element is optional.
void	setDescription(String desc) Sets a textual description of this element, for build documentation purposes only.
void	setImplicit(boolean implicit) Sets whether this element is implicit.
void	setName(String name) Sets the name of this element.
void	setOptional(boolean optional) Sets whether this element is optional.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateElement

public TemplateElement()

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

getDescription

public String getDescription()

Gets the description of this element.

Returns:

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

Since:

ant 1.6.1

getName

public String getName()

Gets the name of this element.

Returns:

the name of the element.

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)

isImplicit

public boolean isImplicit()

Gets whether this element is implicit.

Returns:

the implicit attribute

isOptional

public boolean isOptional()

Gets whether this element is optional.

Returns:

the optional attribute

setDescription

public void setDescription(String desc)

Sets a textual description of this element, for build documentation purposes only.

Parameters:

desc - Description of the element.

Since:

ant 1.6.1

setImplicit

public void setImplicit(boolean implicit)

Sets whether this element is implicit.

Parameters:

implicit - if true this element may be left out, default is false.

setName

public void setName(String name)

Sets the name of this element.

Parameters:

name - the name of the element

setOptional

public void setOptional(boolean optional)

Sets whether this element is optional.

Parameters:

optional - if true this element may be left out, default is false.