Package com.ibm.mq.pcf

Class MQCFBS

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.headers.internal.Header
com.ibm.mq.pcf.PCFHeader
com.ibm.mq.pcf.PCFParameter
com.ibm.mq.pcf.MQCFBS
All Implemented Interfaces:
com.ibm.mq.headers.internal.CachingHeader, MQData, MQHeader
public class MQCFBS extends PCFParameter
Deprecated.
use MQCFBS instead. 
      struct tagMQCFBS {
                MQLONG  Type;          // Structure type
                MQLONG  StrucLength;   // Structure length
                MQLONG  Parameter;     // Parameter identifier
                MQLONG  StringLength;  // Length of string
                MQBYTE  String[1];     // String value -- first byte
        };
MQCFBS (PCF byte string parameter) header class.

  • Nested Class Summary

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

    MQHeader.Field

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    parameter
    Deprecated.
    parameter identifier
    byte[]
    string
    Deprecated.
    string
    int
    stringLength
    Deprecated.
    string length
    int
    strucLength
    Deprecated.
    structure length
    static final int
    type
    Deprecated.
    structure type

    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

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static final String
    asHexString(byte[] bytes)
    Deprecated.
    Utility method for producing a hexadecimal string representation of a byte array.
    boolean
    equals(Object obj)
    Deprecated.
    Returns true when invoked with another MQCFBS instance with the same parameter and equivalent value.
    int
    getHeaderVersion()
    Deprecated.
    Get the header version
    int
    getParameter()
    Deprecated.
    gets the parameter identifier
    byte[]
    getString()
    Deprecated.
    gets the string
    int
    getStringLength()
    Deprecated.
    gets the parameter identifier
    String
    getStringValue()
    Deprecated.
    Get the string value of the parameter
    int
    getStrucLength()
    Deprecated.
    Get the length of the structure.
    int
    getType()
    Deprecated.
    gets the structure type
    Object
    getValue()
    Deprecated.
    Get the value of the parameter
    int
    hashCode()
    Deprecated.
    Returns a hash code value for the object
    void
    setParameter(int value)
    Deprecated.
    sets the parameter identifier
    void
    setString(byte[] value)
    Deprecated.
    sets the string

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

    getParameterName, nextParameter

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

    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

  • Field Details

    • type

      public static final int type
      Deprecated.
      structure type
      See Also:

    • strucLength

      public int strucLength
      Deprecated.
      structure length

    • parameter

      public int parameter
      Deprecated.
      parameter identifier

    • stringLength

      public int stringLength
      Deprecated.
      string length

    • string

      public byte[] string
      Deprecated.
      string

  • Constructor Details

    • MQCFBS

      public MQCFBS()
      Deprecated.
      Constructs an MQCFBS instance with default field values.

    • MQCFBS

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

    • MQCFBS

      public MQCFBS(DataInput message, int encoding, int characterSet) throws MQException, IOException
      Deprecated.
      Constructs an MQCFBS 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:
      MQException - if the message content does not yield a valid MQCFBS stucture
      IOException - if there is a problem reading the message content

    • MQCFBS

      public MQCFBS(int parameter, String string)
      Deprecated.
      Initializes an MQCFBS with the specified values. The string is converted into a byte array value using the platform's default string-to-bytes conversion.
      Parameters:
      parameter - the parameter identifier
      string - the string parameter value

    • MQCFBS

      public MQCFBS(int parameter, byte[] bytes)
      Deprecated.
      Initializes an MQCFBS with the specified values.
      Parameters:
      parameter - the parameter identifier
      bytes - the binary parameter value

  • Method Details

    • asHexString

      public static final String asHexString(byte[] bytes)
      Deprecated.
      Utility method for producing a hexadecimal string representation of a byte array.
      Parameters:
      bytes - the byte array.
      Returns:
      the hexadecimal string.

    • equals

      public boolean equals(Object obj)
      Deprecated.
      Returns true when invoked with another MQCFBS instance with the same parameter and equivalent value. Comparison of the values is performed using the java.util.Arrays.equals method.
      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()
      Deprecated.
      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()
      Deprecated.
      gets the structure type
      Specified by:
      getType in class PCFHeader
      Returns:
      the structure type

    • getStrucLength

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

    • getParameter

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

    • setParameter

      public void setParameter(int value)
      Deprecated.
      sets the parameter identifier
      Parameters:
      value - A value of the parameter identifier

    • getStringLength

      public int getStringLength()
      Deprecated.
      gets the parameter identifier
      Returns:
      the parameter identifier

    • getString

      public byte[] getString()
      Deprecated.
      gets the string
      Returns:
      the string

    • setString

      public void setString(byte[] value)
      Deprecated.
      sets the string
      Parameters:
      value - the string

    • getValue

      public Object getValue()
      Deprecated.
      Description copied from class: PCFParameter
      Get the value of the parameter
      Specified by:
      getValue in class PCFParameter
      Returns:
      Return the value of the parameter
      See Also:

    • getStringValue

      public String getStringValue()
      Deprecated.
      Description copied from class: PCFParameter
      Get the string value of the parameter
      Specified by:
      getStringValue in class PCFParameter
      Returns:
      Returns the string value of the parameter
      See Also:

    • getHeaderVersion

      public int getHeaderVersion()
      Deprecated.
      Description copied from class: PCFParameter
      Get the header version
      Overrides:
      getHeaderVersion in class PCFParameter
      Returns:
      Return the header version
      See Also: