IBM Bank Transformation Toolkit Javadoc

com.ibm.btt.format.impl
Class StringFormat

java.lang.Object
  extended by com.ibm.btt.format.AbstractFormatElement
      extended by com.ibm.btt.format.FieldFormat
          extended by com.ibm.btt.format.impl.StringFormat
All Implemented Interfaces:
FormatElement, JSONString

public class StringFormat
extends FieldFormat
implements JSONString


Field Summary
 
Fields inherited from class com.ibm.btt.format.AbstractFormatElement
dataName, tagName, TOSTRINGS_MARGIN
 
Constructor Summary
StringFormat()
           
 
Method Summary
protected  java.util.Map<java.lang.String,java.lang.String> attributes()
          Generic attributes method.
 Message format(ReadAdapter dataAdapter)
          This method is attended to be called by client code of FormatElement
 java.lang.String getEncoding()
           
 int getFormatAs()
           
 int getUnformatAs()
           
 boolean isEscape()
           
 void setEncoding(java.lang.String encoding)
           
 void setEscape(java.lang.String escape)
           
 void setFormatAs(java.lang.String formatas)
           
 void setUnformatAs(java.lang.String unformatas)
           
 void unformat(Message message, WriteAdapter dataAdapter)
          This method is attended to be called by client code of FormatElement
 
Methods inherited from class com.ibm.btt.format.FieldFormat
isContainer
 
Methods inherited from class com.ibm.btt.format.AbstractFormatElement
extract, getDataName, rootDecorated, setDataName, toString, toStrings
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.btt.format.FormatElement
extract, getDataName, rootDecorated, toStrings
 

Constructor Detail

StringFormat

public StringFormat()
Method Detail

getFormatAs

public int getFormatAs()

setFormatAs

public void setFormatAs(java.lang.String formatas)

getUnformatAs

public int getUnformatAs()

setUnformatAs

public void setUnformatAs(java.lang.String unformatas)

format

public Message format(ReadAdapter dataAdapter)
               throws FormatException
Description copied from interface: FormatElement
This method is attended to be called by client code of FormatElement

Specified by:
format in interface FormatElement
Returns:
Throws:
FormatException

unformat

public void unformat(Message message,
                     WriteAdapter dataAdapter)
              throws UnformatException
Description copied from interface: FormatElement
This method is attended to be called by client code of FormatElement

Specified by:
unformat in interface FormatElement
Throws:
UnformatException

attributes

protected java.util.Map<java.lang.String,java.lang.String> attributes()
Description copied from class: AbstractFormatElement
Generic attributes method. This method parse throw the 'get' methods of the class, and finds out all the attributes of the bean. It is a simple implementation. Customers are recommended to override this method.

Overrides:
attributes in class AbstractFormatElement
Returns:

getEncoding

public java.lang.String getEncoding()

setEncoding

public void setEncoding(java.lang.String encoding)

isEscape

public boolean isEscape()
Specified by:
isEscape in interface JSONString

setEscape

public void setEscape(java.lang.String escape)

IBM Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2008