org.apache.tools.ant.taskdefs

Class MacroDef.TemplateElement

public static class MacroDef.TemplateElement extends Object

A nested element for the MacroDef task.
Method Summary
booleanequals(Object obj)
equality method.
StringgetDescription()
Gets the description of this element.
StringgetName()
Gets the name of this element.
inthashCode()
booleanisImplicit()
Gets whether this element is implicit.
booleanisOptional()
Gets whether this element is optional.
voidsetDescription(String desc)
Sets a textual description of this element, for build documentation purposes only.
voidsetImplicit(boolean implicit)
Sets whether this element is implicit.
voidsetName(String name)
Sets the name of this element.
voidsetOptional(boolean optional)
Sets whether this element is optional.

Method Detail

equals

public boolean equals(Object obj)
equality method.

Parameters: obj an Object value

Returns: a boolean value

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()

Returns: a hash code value for this 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.