Package com.ibm.mq.headers.pcf

Class MQCFST

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.headers.internal.Header
com.ibm.mq.headers.pcf.PCFHeader
com.ibm.mq.headers.pcf.PCFParameter
com.ibm.mq.headers.pcf.MQCFST
All Implemented Interfaces:
MQData, MQHeader
public class MQCFST extends PCFParameter
MQCFST (PCF string parameter) header class. 
        struct tagMQCFST {
                MQLONG  Type;            // Structure type
                MQLONG  StrucLength;     // Structure length
                MQLONG  Parameter;       // Parameter identifier
                MQLONG  CodedCharSetId;  // Coded character set identifier
                MQLONG  StringLength;    // Length of string
                MQCHAR  String[1];       // String value -- first character
        };

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.ibm.mq.headers.MQHeader

    MQHeader.Field

  • Field Summary

    Fields inherited from class com.ibm.mq.headers.internal.Header

    DEFAULT_CCSID, DEFAULT_ENCODING, delegate

    Fields inherited from class com.ibm.mq.jmqi.JmqiObject

    COMP_JM, COMP_JN, COMP_JO

  • Constructor Summary

    Constructors
    Constructor
    Description
    MQCFST()
    Constructs an MQCFST instance with default field values.
    MQCFST(int parameter, String string)
    Initializes an MQCFST with the specified values.
    MQCFST(DataInput message)
    Constructs an MQCFST instance populated from an MQMessage.
    MQCFST(DataInput message, int encoding, int characterSet)
    Constructs an MQCFST instance populated from a DataInput source.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Returns true when invoked with another MQCFST instance with the same parameter and equivalent value.
    int
    getCodedCharSetId()
    gets the coded character set identifier
    int
    getParameter()
    gets the parameter identifier
    String
    getString()
    gets the string
    int
    getStringLength()
    gets the length of the string
    String
    getStringValue()
    gets the parameter value as a String
    int
    getStrucLength()
    Get the length of the structure.
    int
    getType()
    gets the structure type
    Object
    getValue()
    gets the parameter value
    int
    hashCode()
    Returns a hash code value for the object
    void
    setCodedCharSetId(int value)
    sets the coded character set identifier
    void
    setParameter(int value)
    sets the parameter identifier
    void
    setString(SecureString value)
    Set a confidential data to store.
    void
    setString(String value)
    sets the string
    static int
    write(DataOutput message, int parameter, String string)
    A convenience method for writing an MQCFST header structure with the specified values to an MQMessage

    Methods inherited from class com.ibm.mq.headers.pcf.PCFParameter

    getHeaderVersion, getParameterName, nextParameter

    Methods inherited from class com.ibm.mq.headers.internal.Header

    characterSet, encoding, fields, getBytesValue, getCharValue, getCharValue, getIntValue, getJmqiEnv, getStringValue, getValue, headerType, read, read, read, setBytesValue, setCharValue, setCharValue, setIntValue, setStringValue, setValue, size, store, store, toString, type, validate, write, write

    Methods inherited from class com.ibm.mq.jmqi.JmqiObject

    getJmqiEnvironment

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MQCFST

      public MQCFST()
      Constructs an MQCFST instance with default field values.

    • MQCFST

      public MQCFST(DataInput message) throws MQDataException, IOException
      Constructs an MQCFST instance populated from an MQMessage.
      Parameters:
      message - the message to read
      Throws:
      MQDataException - if the message content does not yield a valid MQCFST stucture
      IOException - if there is a problem reading the message content

    • MQCFST

      public MQCFST(DataInput message, int encoding, int characterSet) throws MQDataException, IOException
      Constructs an MQCFST instance populated from a DataInput source.
      Parameters:
      message - the MQMessage or other DataInput source to read
      encoding - the initial numeric encoding of the data in the message
      characterSet - the initial CCSID of the data in the message
      Throws:
      MQDataException - if the message content does not yield a valid MQCFST stucture
      IOException - if there is a problem reading the message content

    • MQCFST

      public MQCFST(int parameter, String string)
      Initializes an MQCFST with the specified values.
      Parameters:
      parameter - the parameter identifier
      string - the string parameter value

  • Method Details

    • write

      public static int write(DataOutput message, int parameter, String string) throws IOException
      A convenience method for writing an MQCFST header structure with the specified values to an MQMessage
      Parameters:
      message - the message to write to
      parameter - the parameter identifier
      string - the string parameter value
      Returns:
      the number of bytes written
      Throws:
      IOException - if there is a problem writing the message
      See Also:

    • equals

      public boolean equals(Object obj)
      Returns true when invoked with another MQCFST instance with the same parameter and equivalent value. Comparison of the values is performed using the equals method of String. Note: Two MQCFST instances with null values are not regarded as equal.
      It doesn't really matter - such instances are not really interesting - but it's worth commenting on.
      Overrides:
      equals in class PCFParameter
      Parameters:
      obj - An object to compare with this instance
      Returns:
      true if the object equals this one

    • hashCode

      public int hashCode()
      Description copied from class: PCFParameter
      Returns a hash code value for the object
      Specified by:
      hashCode in class PCFParameter
      Returns:
      a hash code value for this object.
      See Also:

    • getType

      public int getType()
      gets the structure type
      Specified by:
      getType in class PCFHeader
      Returns:
      the structure type

    • getStrucLength

      public int getStrucLength()
      Get the length of the structure.
      Returns:
      the structure length.

    • getParameter

      public int getParameter()
      gets the parameter identifier
      Specified by:
      getParameter in class PCFParameter
      Returns:
      the parameter identifier

    • setParameter

      public void setParameter(int value)
      sets the parameter identifier
      Parameters:
      value - the parameter identifier

    • getCodedCharSetId

      public int getCodedCharSetId()
      gets the coded character set identifier
      Returns:
      the coded character set identifier

    • setCodedCharSetId

      public void setCodedCharSetId(int value)
      sets the coded character set identifier
      Parameters:
      value - the coded character set identifier

    • getStringLength

      public int getStringLength()
      gets the length of the string
      Returns:
      the length of the string

    • getString

      public String getString()
      gets the string
      Returns:
      the string

    • setString

      public void setString(String value)
      sets the string
      Parameters:
      value - the string

    • setString

      public void setString(SecureString value)
      Set a confidential data to store.
      Parameters:
      value - - to be set in store

    • getValue

      public Object getValue()
      Description copied from class: PCFParameter
      gets the parameter value
      Specified by:
      getValue in class PCFParameter
      Returns:
      the parameter value
      See Also:

    • getStringValue

      public String getStringValue()
      Description copied from class: PCFParameter
      gets the parameter value as a String
      Specified by:
      getStringValue in class PCFParameter
      Returns:
      the parameter value as a String
      See Also: