Module datarush.commons

Package com.pervasive.datarush.io.configuration

Class TextField

java.lang.Object

com.pervasive.datarush.io.configuration.ConfigurationField

com.pervasive.datarush.io.configuration.TextField

public final class TextField
extends ConfigurationField

A ConfigurationField that consists of clear text information.

See Also:

• ConfigurationField

Constructor Summary

Constructors

Constructor	Description
TextField(String fieldName)	Creates a new field with an empty value
TextField(String fieldName, String fieldValue)	Create a new field with the specified value

Method Summary

Modifier and Type	Method	Description
String	getFieldValue()	Returns the value of the field
TextField	withValue(String fieldValue)	Creates a new field, equivalent to this, but with the value set to the specified value.

Methods inherited from class com.pervasive.datarush.io.configuration.ConfigurationField

getFieldName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TextField

public TextField(String fieldName)

Creates a new field with an empty value

Parameters:

fieldName - the name of the field

Throws:

IllegalArgumentException - if fieldName is null or empty

TextField

public TextField(String fieldName,
 String fieldValue)

Create a new field with the specified value

Parameters:

fieldName - the unique identifier for this field

fieldValue - the field value

Throws:

IllegalArgumentException - if fieldName is null or empty or if fieldValue is null (fieldValue may be empty though)

Method Details

getFieldValue

public String getFieldValue()

Returns the value of the field

Returns:

the value of the field

withValue

public TextField withValue(String fieldValue)
                    throws IllegalArgumentException

Creates a new field, equivalent to this, but with the value set to the specified value.

Parameters:

fieldValue - the new value

Returns:

a new field with its settings modified

Throws:

IllegalArgumentException - if value is null (may be empty though)