Package com.ibm.mq.headers.pcf

Class MQCFIF

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.PCFFilterParameter
com.ibm.mq.headers.pcf.MQCFIF
All Implemented Interfaces:
MQData, MQHeader
public class MQCFIF extends PCFFilterParameter
MQCFIF (PCF integer filter parameter) header class. 
        struct tagMQCFIF {
                MQLONG  Type;         // Structure type
                MQLONG  StrucLength;  // Structure length
                MQLONG  Parameter;    // Parameter identifier
                MQLONG  Operator;     // Operator identifier
                MQLONG  FilterValue;  // Filter value
        };

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Returns true when invoked with another MQCFIF instance with the same parameter, operator and value.
    int
    getFilterValue()
    gets the filter value
    int
    getOperator()
    gets the operator identifier
    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
    hashCode()
    Returns a hash code value for the object
    void
    setFilterValue(int value)
    sets the filter value
    void
    setOperator(int value)
    sets the operator identifier
    void
    setParameter(int value)
    sets the parameter identifier

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

    getHeaderVersion

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

    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

    • MQCFIF

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

    • MQCFIF

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

    • MQCFIF

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

    • MQCFIF

      public MQCFIF(int parameter, int operator, int value)
      Initializes an MQCFIF header with the specified values.
      Parameters:
      parameter - the parameter identifier
      operator - Identifies the operator that is being used to evaluate whether the parameter satisfies the filter-value
      value - the integer parameter value

  • Method Details

    • equals

      public boolean equals(Object obj)
      Returns true when invoked with another MQCFIF instance with the same parameter, operator and value.
      Overrides:
      equals in class PCFFilterParameter
      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
      Overrides:
      hashCode in class PCFFilterParameter
      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

    • getOperator

      public int getOperator()
      gets the operator identifier
      Specified by:
      getOperator in class PCFFilterParameter
      Returns:
      The operator identifier

    • setOperator

      public void setOperator(int value)
      sets the operator identifier
      Parameters:
      value - the operator identifier

    • getFilterValue

      public int getFilterValue()
      gets the filter value
      Returns:
      the filter value

    • setFilterValue

      public void setFilterValue(int value)
      sets the filter value
      Parameters:
      value - the filter value

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