com.ibm.cics.server

Class SymbolList

  • java.lang.Object
    • com.ibm.cics.server.SymbolList


  • 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.

    Since CICS TS version:
    2.3
    Since package version:
    1.0
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int NOTSET
      Constant - NOT SET
    • Constructor Summary

      Constructors 
      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.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • NOTSET

        public static final int NOTSET
        Constant - NOT SET
        See Also:
        Constant Field Values
        Since CICS TS version:
        2.3
        Since package version:
        1.0
    • Constructor Detail

      • SymbolList

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

        Parameters:
        sList - contains the symbol list
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • SymbolList

        public SymbolList(byte[] sList)
        Usage:
        Public constructor which accepts a SYMBOLLIST byte array.

        Parameters:
        sList - contains the symbol list
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • 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
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • SymbolList

        public SymbolList(byte[] sList,
                          char delim,
                          boolean unesc)
        Usage:
        Public constructor which accepts a SYMBOLLIST byte array, a DELIMITER character and a UNESCAPED indicator.

        Parameters:
        sList - contains the symbol list
        delim - contains the delimiter value
        unesc - contains the unescaped indicator
        Since CICS TS version:
        3.1
        Since package version:
        1.0
    • Method Detail

      • getSymbolList

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

        Returns:
        The symbol list as a String
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • getSymbolListAsByteArray

        public byte[] getSymbolListAsByteArray()
        Usage:
        Returns the symbol list.

        Returns:
        The symbol list as a byte array
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • getLength

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

        Returns:
        Symbol list length
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • getDelimiter

        public char getDelimiter()
        Usage:
        Returns delimiter value.

        Returns:
        Delimiter value
        Since CICS TS version:
        2.
        Since package version:
        1.0
      • getUnescaped

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

        Returns:
        Unescaped indicator
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • setSymbolList

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

        Parameters:
        sList - contains the symbol list
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • setSymbolList

        public void setSymbolList(byte[] sList)
        Usage:
        Store the symbol list.

        Parameters:
        sList - contains the symbol list
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • setDelimiter

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

        Parameters:
        delim - contains the delimiter value
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • setUnescaped

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

        Parameters:
        unesc - contains the unescaped indicator
        Since CICS TS version:
        2.3
        Since package version:
        1.0