public class SymbolList
extends java.lang.Object
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.
Modifier and Type | Field and Description |
---|---|
static int |
NOTSET
Constant - NOT SET
|
Constructor and Description |
---|
SymbolList(byte[] sList)
Usage:
Public constructor which accepts a SYMBOLLIST byte array. |
SymbolList(byte[] sList,
char delim,
boolean unesc)
Usage:
Public constructor which accepts a SYMBOLLIST byte array, a DELIMITER character and a UNESCAPED indicator. |
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. |
Modifier and Type | Method and Description |
---|---|
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. |
byte[] |
getSymbolListAsByteArray()
Usage:
Returns the symbol list. |
boolean |
getUnescaped()
Usage:
Returns the unescaped indicator. |
void |
setDelimiter(char delim)
Usage:
Store the delimiter value. |
void |
setSymbolList(byte[] sList)
Usage:
Store the symbol list. |
void |
setSymbolList(java.lang.String sList)
Usage:
Store the symbol list. |
void |
setUnescaped(boolean unesc)
Usage:
Store the unescaped indicator. |
public static final int NOTSET
public SymbolList(java.lang.String sList)
sList
- contains the symbol listpublic SymbolList(byte[] sList)
sList
- contains the symbol listpublic SymbolList(java.lang.String sList, char delim, boolean unesc)
sList
- contains the symbol listdelim
- contains the delimiter valueunesc
- contains the unescaped indicatorpublic SymbolList(byte[] sList, char delim, boolean unesc)
sList
- contains the symbol listdelim
- contains the delimiter valueunesc
- contains the unescaped indicatorpublic java.lang.String getSymbolList()
public byte[] getSymbolListAsByteArray()
public int getLength()
public char getDelimiter()
public boolean getUnescaped()
public void setSymbolList(java.lang.String sList)
sList
- contains the symbol listpublic void setSymbolList(byte[] sList)
sList
- contains the symbol listpublic void setDelimiter(char delim)
delim
- contains the delimiter valuepublic void setUnescaped(boolean unesc)
unesc
- contains the unescaped indicator