Package com.ibm.cics.server

Class TWAHolder

java.lang.Object
com.ibm.cics.server.TWAHolder
All Implemented Interfaces:
IHolder
public class TWAHolder extends Object implements IHolder

This class holds an array of bytes that is a copy of the contents of the TWA. The actual data is an instance variable of type byte[] with the name value. This instance variable can be accessed using getters getValue() and getStringValue() and setter setValue(byte[])

Since CICS TS version:
1.3

  • Constructor Summary

    Constructors
    Constructor
    Description
    TWAHolder()
    Constructs a TWAHolder without a value.
    TWAHolder(byte[] initialValue)
    Constructs a TWAHolder.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getStringValue()
    Returns a String derived from the data in the IHolder, assuming that the data is encoded in the LOCALCCSID.
    byte[]
    getValue()
    Returns the raw byte array from the IHolder
    void
    setStringValue(String valueToSet)
    Set a value into the TWAHolder
    void
    setValue(byte[] newValue)
    Allows the value inside the holder to be set.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • TWAHolder

      public TWAHolder()
      Constructs a TWAHolder without a value.
      Since CICS TS version:
      1.3

    • TWAHolder

      public TWAHolder(byte[] initialValue)
      Constructs a TWAHolder.
      Parameters:
      initialValue - the intial value
      Since CICS TS version:
      1.3

  • Method Details

    • getValue

      public byte[] getValue()
      Description copied from interface: IHolder
      Returns the raw byte array from the IHolder
      Specified by:
      getValue in interface IHolder
      Returns:
      - the raw byte value stored in the IHolder
      See Also:
      Since CICS TS version:
      5.1

    • getStringValue

      public String getStringValue()
      Description copied from interface: IHolder
      Returns a String derived from the data in the IHolder, assuming that the data is encoded in the LOCALCCSID. The behavior of this method when the bytes are not valid in the LOCALCCSID encoding is unspecified.
      Specified by:
      getStringValue in interface IHolder
      Returns:
      - a String representation of the byte-array in the CICS LOCALCCSID.
      See Also:
      Since CICS TS version:
      5.1

    • setValue

      public void setValue(byte[] newValue)
      Allows the value inside the holder to be set. CICS applications are not expected to set this value outside of any unit testing they may be performing.
      Parameters:
      newValue - The new value which will be set. This just sets the reference. No deep copying of the data is performed.
      Since CICS TS version:
      6.1

    • setStringValue

      public void setStringValue(String valueToSet)
      Set a value into the TWAHolder
      Parameters:
      valueToSet - the value to set. The text is converted into the LOCALCCSID encoding.
      Since CICS TS version:
      6.3