IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.base
Class Delimiter

java.lang.Object
  extended bycom.ibm.btt.base.FormatElement
      extended bycom.ibm.btt.base.FormatDecorator
          extended bycom.ibm.btt.base.Delimiter
All Implemented Interfaces:
Cacheable, Externalizable, java.io.Externalizable, java.io.Serializable

public class Delimiter
extends FormatDecorator

The Delimiter class adds an delimiter character to its decorated String in order to provide a mechanism to separate the different data formats.

See Also:
Serialized Form

Field Summary
 char delimiterChar
           
 
Fields inherited from class com.ibm.btt.base.FormatDecorator
decorated
 
Fields inherited from class com.ibm.btt.base.FormatElement
dataElementName, externalizer, name
 
Constructor Summary
Delimiter()
          This constructor creates a Delimiter object.
Delimiter(java.lang.String aName)
          This constructor creates the Delimiter object with the id aName
 
Method Summary
 java.lang.String addDecoration(java.lang.String aString)
          Appends the delimiter character to the end of the string.
 java.lang.String[] extract(java.lang.String aString)
          Extracts the string up to the first occurrence of the delimiter.
 char getDelimiterChar()
          Returns the value of the delimiterChar.
 java.lang.Object initializeFrom(Tag aTag)
          Initializes a Delimiter with the Tag attributes.
 java.lang.String removeDecoration(java.lang.String aString)
          Remove the delimiter character from the end of the string.
 void setDelimiterChar(char aChar)
          Sets the value of the delimiterChar.
 Vector toStrings()
          Returns a visual representation of this decorator.
 
Methods inherited from class com.ibm.btt.base.FormatDecorator
format, format, getDataElementName, getDecorated, getName, isConstant, isItConstant, reinitialize, rootDecorated, rootDecorator, setDecorated, toString, unformat, unformat
 
Methods inherited from class com.ibm.btt.base.FormatElement
exceptionInfo, externalizer, getExternalizer, getTagName, isCacheable, readExternal, readExternal, readObject, removeExternal, setDataElementName, setExternalizer, setName, setSize, toTags, writeExternal, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

delimiterChar

public char delimiterChar
Constructor Detail

Delimiter

public Delimiter()
This constructor creates a Delimiter object.


Delimiter

public Delimiter(java.lang.String aName)
          throws java.io.IOException
This constructor creates the Delimiter object with the id aName

Parameters:
aName - java.lang.String
Method Detail

addDecoration

public java.lang.String addDecoration(java.lang.String aString)
Appends the delimiter character to the end of the string.

Specified by:
addDecoration in class FormatDecorator

extract

public java.lang.String[] extract(java.lang.String aString)
                           throws DSEInvalidArgumentException
Extracts the string up to the first occurrence of the delimiter.

Overrides:
extract in class FormatDecorator
Parameters:
aString - String
Returns:
java.lang.String[]
Throws:
DSEInvalidArgumentException

getDelimiterChar

public char getDelimiterChar()
Returns the value of the delimiterChar.

Returns:
char

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
Initializes a Delimiter with the Tag attributes.

Specified by:
initializeFrom in interface Externalizable
Specified by:
initializeFrom in class FormatElement
Parameters:
aTag - com.ibm.btt.base.Tag
Returns:
java.lang.Object

removeDecoration

public java.lang.String removeDecoration(java.lang.String aString)
                                  throws DSEInvalidArgumentException
Remove the delimiter character from the end of the string.

Specified by:
removeDecoration in class FormatDecorator
Parameters:
aString - String
Returns:
java.lang.String
Throws:
DSEInvalidArgumentException

setDelimiterChar

public void setDelimiterChar(char aChar)
Sets the value of the delimiterChar.

Parameters:
aChar - char

toStrings

public Vector toStrings()
Returns a visual representation of this decorator.

Specified by:
toStrings in interface Externalizable
Specified by:
toStrings in class FormatDecorator
Returns:
java.lang.String

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005