Class MQCFIL

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.MQCFIL
All Implemented Interfaces:
MQData, MQHeader
public class MQCFIL extends PCFParameter
MQCFIL (PCF integer list parameter) header class. 
        struct tagMQCFIL {
                MQLONG  Type;         // Structure type
                MQLONG  StrucLength;  // Structure length
                MQLONG  Parameter;    // Parameter identifier
                MQLONG  Count;        // Count of parameter values
                MQLONG  Values[1];    // Parameter values -- first element
        };

  • 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
    MQCFIL()
    Constructs an MQCFIL instance with default field values.
    MQCFIL(int parameter, int[] values)
    Initializes an MQCFIL with the specified values.
    MQCFIL(DataInput message)
    Constructs an MQCFIL instance populated from an MQMessage.
    MQCFIL(DataInput message, int encoding, int characterSet)
    Constructs an MQCFIL instance populated from a DataInput source.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Returns true when invoked with another MQCFIL instance with the same parameter and equivalent set of values in the same order.
    int
    getCount()
    gets the count of parameter values
    int
    getParameter()
    gets 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
    Object
    getValue()
    gets the parameter value
    int[]
    getValues()
    gets the parameter values
    int
    hashCode()
    Returns a hash code value for the object
    void
    setParameter(int value)
    sets the parameter identifier
    void
    setValues(int[] values)
    sets the parameter values
    static int
    write(DataOutput message, int parameter, int[] values)
    A convenience method for writing an MQCFIL header with the specified values to a message.

    Methods inherited from class 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 Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MQCFIL

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

    • MQCFIL

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

    • MQCFIL

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

    • MQCFIL

      public MQCFIL(int parameter, int[] values)
      Initializes an MQCFIL with the specified values.
      Parameters:
      parameter - the parameter identifier
      values - the set of integer parameter values

  • Method Details

    • write

      public static int write(DataOutput message, int parameter, int[] values) throws IOException
      A convenience method for writing an MQCFIL header with the specified values to a message.
      Parameters:
      message - the message to write to
      parameter - the parameter identifier
      values - the set of integer values
      Returns:
      the number of bytes written
      Throws:
      IOException - if there is a problem writing the message content

    • equals

      public boolean equals(Object obj)
      Returns true when invoked with another MQCFIL instance with the same parameter and equivalent set of values in the same order.
      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()
      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

    • getCount

      public int getCount()
      gets the count of parameter values
      Returns:
      the count of parameter values

    • getValues

      public int[] getValues()
      gets the parameter values
      Returns:
      an array of the parameter values

    • setValues

      public void setValues(int[] values)
      sets the parameter values
      Parameters:
      values - an array of the parameter values

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