com.pervasive.datarush.encoding.text

Class CharFormatter

java.lang.Object

com.pervasive.datarush.encoding.text.CharFormatter

All Implemented Interfaces:

TokenFormatter

public class CharFormatter
extends Object

A formatter representing character token values as single-character strings.

Constructor Summary

Constructors

Constructor and Description
CharFormatter() Creates a new formatter.
CharFormatter(String nullIndicator) Creates a new formatter.

Method Summary

Methods

Modifier and Type	Method and Description
String	format() Formats the current value of the source as a text value.
void	setSource(ScalarValued source) Sets the container holding values to be formatted.

Methods inherited from class java.lang.Object

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

Constructor Detail

CharFormatter

public CharFormatter()

Creates a new formatter. Null values are output as the empty string.

CharFormatter

public CharFormatter(String nullIndicator)

Creates a new formatter. Null values are output as the specified string.

Parameters:

nullIndicator - the text value to use for null values

Method Detail

setSource

public final void setSource(ScalarValued source)

Description copied from interface: TokenFormatter

Sets the container holding values to be formatted. A reference to this container is held and accessed only when an formatting is requested.

Specified by:

setSource in interface TokenFormatter

Parameters:

source - the value container to format

format

public final String format()

Description copied from interface: TokenFormatter

Formats the current value of the source as a text value.

Specified by:

format in interface TokenFormatter

Returns:

the value of the source as a string