Replace.Replacefilter (Apache Ant API)
Date: 2012-02-26

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.tools.ant.taskdefs
Class Replace.Replacefilter

    java.lang.Object
      org.apache.tools.ant.taskdefs.Replace.Replacefilter

Enclosing class:
  Replace

    public class Replace.Replacefilter

extends java.lang.Object

A filter to apply.

Constructor Summary
`Replace.Replacefilter()`

Method Summary
`Replace.NestedString` | `createReplaceToken()` Create a token to filter as the text of a nested element.
`Replace.NestedString` | `createReplaceValue()` Create a string to replace the token as the text of a nested element.
`java.lang.String` | `getProperty()` Get the name of the property whose value is to serve as the replacement value.
`java.lang.String` | `getReplaceValue()` Get the replacement value for this filter token.
`java.lang.String` | `getToken()` Get the string to search for.
`java.lang.String` | `getValue()` Get replacement `String`.
`void` | `setProperty(java.lang.String property)` Set the name of the property whose value is to serve as the replacement value; required if `value` is not set.
`void` | `setToken(java.lang.String t)` Set the token to replace.
`void` | `setValue(java.lang.String value)` The replacement string; required if `property`is not set.``
`void` | `validate()` Validate the filter's configuration.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### Replace.Replacefilter

    public Replace.Replacefilter()

Method Detail

### validate

    public void validate()
                  throws BuildException

  Validate the filter's configuration.

  Throws:
    `BuildException` - if any part is invalid.

### getReplaceValue

    public java.lang.String getReplaceValue()

  Get the replacement value for this filter token.

  Returns:
    the replacement value

### setToken

    public void setToken(java.lang.String t)

  Set the token to replace.

  Parameters:
    `t` - `String` token.

### getToken

    public java.lang.String getToken()

  Get the string to search for.

  Returns:
    current `String` token.

### setValue

    public void setValue(java.lang.String value)

  The replacement string; required if `property`is not set.

  ``
  Parameters:
    `value` - `String` value to replace.

### getValue

    public java.lang.String getValue()

  Get replacement `String`.

  Returns:
    replacement or null.

### setProperty

    public void setProperty(java.lang.String property)

  Set the name of the property whose value is to serve as the replacement value; required if `value` is not set.

  Parameters:
    `property` - property name.

### getProperty

    public java.lang.String getProperty()

  Get the name of the property whose value is to serve as the replacement value.

  Returns:
    property or null.

### createReplaceToken

    public Replace.NestedString createReplaceToken()

  Create a token to filter as the text of a nested element.

  Returns:
    nested token `NestedString` to configure.
  Since:
    Ant 1.8.0

### createReplaceValue

    public Replace.NestedString createReplaceValue()

  Create a string to replace the token as the text of a nested element.

  Returns:
    replacement value `NestedString` to configure.
  Since:
    Ant 1.8.0

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD