OptionalTextType (dev.hcf.ball:ball-util API 6.4.11.20231224 API)

java.lang.Object
- ball.util.ant.types.OptionalTextType

Direct Known Subclasses:

StringValueType
```
public class OptionalTextType
extends Object
```
Class to provide a String base text type for Ant Task implementations. Support "if" and "unless" property predicates.
Bean Property Summary
Name Mode Type isHidden isBound isConstrained
if RW String false false false
unless RW String false false false

Author:

Allen D. Ball

Constructor Summary

Constructors
Constructor Description

OptionalTextType()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addText(String text)`
`String`	`getIf()`
`String`	`getUnless()`
`boolean`	`isActive(Project project)`	Method to determine if the "if" and "unless" tests have been satisfied.
`void`	`setIf(String ifP)`	Sets the "if" condition to test on execution.
`void`	`setUnless(String unlessP)`	Sets the "unless" condition to test on execution.

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

- Constructor Detail
  - OptionalTextType
```
public OptionalTextType()
```
- Method Detail
  - addText
```
public void addText(String text)
```
  - setIf
```
public void setIf(String ifP)
```
    Sets the "if" condition to test on execution. If the named property is set, the OptionalTextType should be included.
    
    Parameters:
    
    ifP - The property condition to test on execution. If the value is null no "if" test will not be performed.
  - getIf
```
public String getIf()
```
  - setUnless
```
public void setUnless(String unlessP)
```
    Sets the "unless" condition to test on execution. If the named property is set, the OptionalTextType should not be included.
    
    Parameters:
    
    unlessP - The property condition to test on execution. If the value is null no "unlessP" test will not be performed.
  - getUnless
```
public String getUnless()
```
  - isActive
```
public boolean isActive(Project project)
```
    Method to determine if the "if" and "unless" tests have been satisfied.
    
    Parameters:
    
    project - The Project.
    
    Returns:
    
    true if the "if" and "unless" tests have been satisfied; false otherwise.