BooleanPluginProperty (Hop Engine 2.3.0 API)

java.lang.Object
- org.apache.hop.core.util.KeyValue<Boolean>
- - org.apache.hop.core.util.BooleanPluginProperty

All Implemented Interfaces:: Serializable, IPluginProperty

public class BooleanPluginProperty
extends KeyValue<Boolean>
implements IPluginProperty

See Also:: Serialized Form

Field Summary
- Fields inherited from class org.apache.hop.core.util.KeyValue
  DEFAULT_TRUE_VALUES, VALID_KEY_CHARS
- Fields inherited from interface org.apache.hop.core.util.IPluginProperty
  BOOLEAN_STRING_TRUE, DEFAULT_BOOLEAN_VALUE, DEFAULT_DOUBLE_VALUE, DEFAULT_INTEGER_VALUE, DEFAULT_STRING_VALUE

Constructor Summary

Constructors
Constructor Description

BooleanPluginProperty(String key)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`appendXml(StringBuilder builder)`
`boolean`	`evaluate()`
`void`	`loadXml(Node node)`
`void`	`readFromPreferences(Preferences node)`
`void`	`saveToPreferences(Preferences node)`

Methods inherited from class org.apache.hop.core.util.KeyValue
assertKey, booleanValue, booleanValue, booleanValue, booleanValue, booleanValue, doubleValue, doubleValue, floatValue, floatValue, getKey, getValue, integerValue, integerValue, longValue, longValue, setValue, stringValue, stringValue, stringValueDefaultIfBlank, toString, value, value

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

- Constructor Detail
  - BooleanPluginProperty
```
public BooleanPluginProperty(String key)
                      throws IllegalArgumentException
```
    Constructor. Value is null.
    
    Parameters:
    
    key - key to set.
    
    Throws:
    
    IllegalArgumentException - if key is invalid.
- Method Detail
  - evaluate
```
public boolean evaluate()
```
    Specified by:
    
    evaluate in interface IPluginProperty
    
    Returns:
    
    true if value not null or 'false'.
  - appendXml
```
public void appendXml(StringBuilder builder)
```
    Specified by:
    
    appendXml in interface IPluginProperty
    
    Parameters:
    
    builder - builder to append to.
  - loadXml
```
public void loadXml(Node node)
```
    Specified by:
    
    loadXml in interface IPluginProperty
    
    Parameters:
    
    node - the node.
  - saveToPreferences
```
public void saveToPreferences(Preferences node)
```
    Specified by:
    
    saveToPreferences in interface IPluginProperty
    
    Parameters:
    
    node - preferences node
  - readFromPreferences
```
public void readFromPreferences(Preferences node)
```
    Specified by:
    
    readFromPreferences in interface IPluginProperty
    
    Parameters:
    
    node - preferences node.