Package com.ibm.mq.pcf

Class PCFParameter

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.headers.internal.Header
com.ibm.mq.pcf.PCFHeader
com.ibm.mq.pcf.PCFParameter
All Implemented Interfaces:
com.ibm.mq.headers.internal.CachingHeader, MQData, MQHeader
Direct Known Subclasses:
MQCFBS, MQCFGR, MQCFIL, MQCFIL64, MQCFIN, MQCFIN64, MQCFSL, MQCFST, PCFFilterParameter
public abstract class PCFParameter extends PCFHeader
Deprecated.
use PCFParameter instead.
Abstract superclass of PCF parameter headers. All PCF parameter headers know their PCF parameter id and 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

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

    COMP_JM, COMP_JN, COMP_JO

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Deprecated.
    Returns true when invoked with another PCFParameter instance with the same type, parameter, and value.
    int
    getHeaderVersion()
    Deprecated.
    Get the header version
    abstract int
    getParameter()
    Deprecated.
    Get the parameter
    final String
    getParameterName()
    Deprecated.
    Get the MQ constant name for the parameter id of this PCFParameter instance.
    abstract String
    getStringValue()
    Deprecated.
    Get the string value of the parameter
    abstract Object
    getValue()
    Deprecated.
    Get the value of the parameter
    abstract int
    hashCode()
    Deprecated.
    Returns a hash code value for the object
    static PCFParameter
    nextParameter(MQMessage message)
    Deprecated.
    The next parameter in the header

    Methods inherited from class com.ibm.mq.pcf.PCFHeader

    getType, initialize, size, toString, write

    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, store, store, type, validate, write

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

    getJmqiEnvironment

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.ibm.mq.headers.internal.CachingHeader

    discardCachedContent, readCachedContent, writeCachedContent

  • Method Details

    • nextParameter

      public static PCFParameter nextParameter(MQMessage message) throws MQException, IOException
      Deprecated.
      The next parameter in the header
      Parameters:
      message - The associated MQMessage
      Returns:
      The next parameter in the header
      Throws:
      MQException - If the call fails
      IOException - If there is an IO error

    • getParameter

      public abstract int getParameter()
      Deprecated.
      Get the parameter
      Returns:
      Return the parameter

    • getValue

      public abstract Object getValue()
      Deprecated.
      Get the value of the parameter
      Returns:
      Return the value of the parameter

    • getStringValue

      public abstract String getStringValue()
      Deprecated.
      Get the string value of the parameter
      Returns:
      Returns the string value of the parameter

    • getHeaderVersion

      public int getHeaderVersion()
      Deprecated.
      Get the header version
      Returns:
      Return the header version

    • equals

      public boolean equals(Object obj)
      Deprecated.
      Returns true when invoked with another PCFParameter instance with the same type, parameter, and value.
      Overrides:
      equals in class Object
      Parameters:
      obj - The object to compare against
      Returns:
      true of the object equals this one

    • hashCode

      public abstract int hashCode()
      Deprecated.
      Returns a hash code value for the object
      Overrides:
      hashCode in class Object
      Returns:
      a hash code value for this object.

    • getParameterName

      public final String getParameterName()
      Deprecated.
      Get the MQ constant name for the parameter id of this PCFParameter instance.
      Returns:
      the MQ constant name for the parameter identifier of this PCFParameter instance, or null if the PCFParameter instance represents a parameter that is not recognised.