Class MQCFIN

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.MQCFIN
All Implemented Interfaces:
MQData, MQHeader
public class MQCFIN extends PCFParameter
MQCFIN (PCF integer parameter) header class. 
     struct tagMQCFIN {
                MQLONG  Type;         // Structure type
                MQLONG  StrucLength;  // Structure length
                MQLONG  Parameter;    // Parameter identifier
                MQLONG  Value;        // Parameter value
        };

  • Nested Class Summary

    Nested classes/interfaces inherited from interface 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
    MQCFIN()
    Constructs an MQCFIN instance with default field values.
    MQCFIN(int parameter, int value)
    Initializes an MQCFIN header with the specified values.
    MQCFIN(DataInput message)
    Constructs an MQCFIN instance populated from an MQMessage.
    MQCFIN(DataInput message, int encoding, int characterSet)
    Constructs an MQCFIN instance populated from a DataInput source.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    decodeValue()
     
    boolean
    equals(Object obj)
    Returns true when invoked with another MQCFIN instance with the same parameter and value.
    int
    getIntValue()
    gets the parameter value
    int
    getParameter()
    get the parameter identifier
    String
    getStringValue()
    gets the parameter value as a String
    int
    getStrucLength()
    Get the length of the structure.
    int
    getType()
    gets the structure type
    int
    hashCode()
    Returns a hash code value for the object
    void
    setIntValue(int value)
    sets the parameter value
    void
    setParameter(int value)
    sets the parameter identifier
    static int
    write(Object message, int parameter, int value)
    A convenience method for writing an MQCFIN header structure with the specified values to an MQMessage.

    Methods inherited from class PCFParameter

    getHeaderVersion, getParameterName, getValue, 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 Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MQCFIN

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

    • MQCFIN

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

    • MQCFIN

      public MQCFIN(DataInput message, int encoding, int characterSet) throws MQDataException, IOException
      Constructs an MQCFIN 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 MQCFIN stucture
      IOException - if there is a problem reading the message content

    • MQCFIN

      public MQCFIN(int parameter, int value)
      Initializes an MQCFIN header with the specified values.
      Parameters:
      parameter - the parameter identifier
      value - the integer parameter value

  • Method Details

    • write

      public static int write(Object message, int parameter, int value) throws IOException
      A convenience method for writing an MQCFIN header structure with the specified values to an MQMessage.
      Parameters:
      message - the message to write to
      parameter - the parameter identifier
      value - the integer 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 MQCFIN instance with the same parameter and value.
      Overrides:
      equals in class PCFParameter
      Parameters:
      obj - An object to compare with this instance
      Returns:
      true of 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()
      get 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

    • getIntValue

      public int getIntValue()
      gets the parameter value
      Returns:
      the parameter value

    • setIntValue

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

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

    • decodeValue

      public String decodeValue()
      Returns:
      interpreted version of the value if available