MacroDef.Text (Apache Ant API)
Description: declaration: package: org.apache.tools.ant.taskdefs, class: MacroDef, class: Text

Package 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
  Description
  `Text()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `equals​(Object obj)`
  equality method
  `String`
  `getDefault()`
  `String`
  `getDescription()`
  `String`
  `getName()`
  `boolean`
  `getOptional()`
  `boolean`
  `getTrim()`
  `int`
  `hashCode()`
  `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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### Text

    public Text()

- ## Method Details

  - ### setName

    public void setName​(String name)
    The name of the attribute.
    Parameters:
      `name` - the name of the attribute

  - ### getName

    public String getName()
    Returns:
      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

  - ### getOptional

    public boolean getOptional()
    Returns:
      true if the text 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.

  - ### getTrim

    public boolean getTrim()
    Returns:
      true if the text is trim

  - ### setDescription

    public void setDescription​(String desc)
    Parameters:
      `desc` - Description of the text.

  - ### getDescription

    public String getDescription()
    Returns:
      the description of the text, or `null` if no description is available.

  - ### setDefault

    public void setDefault​(String defaultString)
    Parameters:
      `defaultString` - default text for the string.

  - ### getDefault

    public String getDefault()
    Returns:
      the default text if set, null otherwise.

  - ### equals

    public boolean equals​(Object obj)
    equality method
    Overrides:
      `equals` in class `Object`
    Parameters:
      `obj` - an `Object` value
    Returns:
      a `boolean` value

  - ### hashCode

    public int hashCode()
    Overrides:
      `hashCode` in class `Object`
    Returns:
      a hash code value for this object.