org.maverickdbms.basic.text
Class NullFormatter

java.lang.Object
  extended byorg.maverickdbms.basic.text.Formatter
      extended byorg.maverickdbms.basic.text.NullFormatter
All Implemented Interfaces:
Formatter

public class NullFormatter
extends org.maverickdbms.basic.text.Formatter

This is a null formatter that performs no processing on the input


Field Summary
protected  boolean convNull
           
protected  Factory factory
           
protected  java.lang.Object[] patterns
           
protected  int type
           
 
Fields inherited from interface org.maverickdbms.basic.Formatter
STATUS_INVALID_CONVERSION, STATUS_INVALID_DATE, STATUS_INVALID_EXPRESSION, STATUS_SUCCESS, TYPE_FMT, TYPE_ICONV, TYPE_OCONV, TYPE_PRINT
 
Constructor Summary
NullFormatter(Factory factory, int type, java.lang.Object[] patterns, boolean convNull)
           
 
Method Summary
 mvString format(mvString result, mvString status, ConstantString input)
          Format the specified input string
 ConstantString getPattern()
          Return the formatter conversion pattern
 int getType()
          Return the type of the formatter
 boolean isNullOnError()
          On error whether null or the input string is returned
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

factory

protected Factory factory

type

protected int type

patterns

protected java.lang.Object[] patterns

convNull

protected boolean convNull
Constructor Detail

NullFormatter

public NullFormatter(Factory factory,
                     int type,
                     java.lang.Object[] patterns,
                     boolean convNull)
Method Detail

format

public mvString format(mvString result,
                       mvString status,
                       ConstantString input)
Description copied from interface: Formatter
Format the specified input string

Parameters:
result - string to store the result
status - errorcode if the foramt failed
input - string to format
Returns:
the resulting string

isNullOnError

public boolean isNullOnError()
Description copied from interface: Formatter
On error whether null or the input string is returned

Specified by:
isNullOnError in interface Formatter
Returns:
if null is returned

getPattern

public ConstantString getPattern()
Description copied from interface: Formatter
Return the formatter conversion pattern

Specified by:
getPattern in interface Formatter
Returns:
the formatters pattern

getType

public int getType()
Description copied from interface: Formatter
Return the type of the formatter

Specified by:
getType in interface Formatter
Returns:
the formatters type