com.ibm.cics.server
Class SymbolList

java.lang.Object
  extended bycom.ibm.cics.server.SymbolList

public class SymbolList
extends java.lang.Object

Usage:
This Class provides a wrapper for the symbol list keywords SYMBOLLIST, DELIMITER and UNESCAPED of the CICS DOCUMENT API.

The symbol list, delimiter and unescaped values are stored in the SymbolList object. The constructors accept a symbol list, or a symbol list, a delimiter value and a unescaped indicator. Setters and getters are provided to store the values and retrieve the stored values.

Version:
02/12/07
Author:
Ian Shore, Adrian Bull

Field Summary
static int NOTSET
           
 
Constructor Summary
SymbolList(byte[] sList)
           
SymbolList(byte[] sList, char delim, boolean unesc)
           
SymbolList(java.lang.String sList)
          Usage:
Public constructor which accepts a SYMBOLLIST string
SymbolList(java.lang.String sList, char delim, boolean unesc)
          Usage:
Public constructor which accepts a SYMBOLLIST string, a DELIMITER character and a UNESCAPED indicator.
 
Method Summary
 char getDelimiter()
          Usage:
Returns delimiter value.
 int getLength()
          Usage:
Returns the length of the symbol list.
 java.lang.String getSymbolList()
          Usage:
Returns the symbol list as a String
 byte[] getSymbolListAsByteArray()
           
 boolean getUnescaped()
          Usage:
Returns the unescaped indicator.
 void setDelimiter(char delim)
          Usage:
Store the delimiter value.
 void setSymbolList(byte[] sList)
           
 void setSymbolList(java.lang.String sList)
          Usage:
Store the symbol list.
 void setUnescaped(boolean unesc)
          Usage:
Store the unescaped indicator.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NOTSET

public static final int NOTSET
See Also:
Constant Field Values
Constructor Detail

SymbolList

public SymbolList(java.lang.String sList)
Usage:
Public constructor which accepts a SYMBOLLIST string

Parameters:
sList - contains the symbol list
Throws:
None

SymbolList

public SymbolList(byte[] sList)
Parameters:
sList - contains the symbol list

SymbolList

public SymbolList(java.lang.String sList,
                  char delim,
                  boolean unesc)
Usage:
Public constructor which accepts a SYMBOLLIST string, a DELIMITER character and a UNESCAPED indicator.

Parameters:
sList - contains the symbol list
delim - contains the delimiter value
unesc - contains the unescaped indicator
Throws:
None

SymbolList

public SymbolList(byte[] sList,
                  char delim,
                  boolean unesc)
Parameters:
sList - contains the symbol list
delim - contains the delimiter value
unesc - contains the unescaped indicator
Method Detail

getSymbolList

public java.lang.String getSymbolList()
Usage:
Returns the symbol list as a String

Returns:
The symbol list String
Throws:
None

getSymbolListAsByteArray

public byte[] getSymbolListAsByteArray()
Returns:
The symbol list byte array

getLength

public int getLength()
Usage:
Returns the length of the symbol list.

Returns:
Symbol list length
Throws:
None

getDelimiter

public char getDelimiter()
Usage:
Returns delimiter value.

Returns:
Delimiter value
Throws:
None

getUnescaped

public boolean getUnescaped()
Usage:
Returns the unescaped indicator.

Returns:
Unescaped indicator
Throws:
None

setSymbolList

public void setSymbolList(java.lang.String sList)
Usage:
Store the symbol list.

Parameters:
sList - contains the symbol list
Returns:
None
Throws:
None

setSymbolList

public void setSymbolList(byte[] sList)
Parameters:
sList - contains the symbol list

setDelimiter

public void setDelimiter(char delim)
Usage:
Store the delimiter value.

Parameters:
delim - contains the delimiter value
Returns:
None
Throws:
None

setUnescaped

public void setUnescaped(boolean unesc)
Usage:
Store the unescaped indicator.

Parameters:
unesc - contains the unescaped indicator
Returns:
None
Throws:
None