com.ibm.mq.headers.pcf

Class MQCFBS

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.MQCFBS

All Implemented Interfaces:

MQData, MQHeader

public class MQCFBS
extends PCFParameter

MQCFBS (PCF byte string parameter) header class.

      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
        };
 

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns true when invoked with another MQCFBS instance with the same parameter and equivalent value.
int	getHeaderVersion() gets the version number of the header format
int	getParameter() gets the parameter identifier
byte[]	getString() gets the string
int	getStringLength() gets the length of the string
java.lang.String	getStringValue() gets the parameter value as a String
int	getStrucLength() Gets the length of the structure.
int	getType() gets the structure type
java.lang.Object	getValue() gets the parameter value
int	hashCode() Returns a hash code value for the object
void	setParameter(int value) sets the parameter identifier
void	setString(byte[] value) sets the string

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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MQCFBS

public MQCFBS()

Constructs an MQCFBS instance with default field values.

MQCFBS

public MQCFBS(java.io.DataInput message)
       throws MQDataException,
              java.io.IOException

Constructs an MQCFBS instance populated from an MQMessage.

Parameters:

message - the message to read

Throws:

MQDataException - if the message content does not yield a valid MQCFBS stucture

java.io.IOException - if there is a problem reading the message content

MQCFBS

public MQCFBS(java.io.DataInput message,
      int encoding,
      int characterSet)
       throws MQDataException,
              java.io.IOException

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:

MQDataException - if the message content does not yield a valid MQCFBS stucture

java.io.IOException - if there is a problem reading the message content

MQCFBS

public MQCFBS(int parameter,
      java.lang.String string)

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)

Initializes an MQCFBS with the specified values.

Parameters:

parameter - the parameter identifier

bytes - the binary parameter value

Method Detail

equals

public boolean equals(java.lang.Object obj)

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 -

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:

PCFParameter.hashCode()

getType

public int getType()

gets the structure type

Specified by:

getType in class PCFHeader

Returns:

the structure type

getStrucLength

public int getStrucLength()

Gets 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

getStringLength

public int getStringLength()

gets the length of the string

Returns:

the parameter identifier

getString

public byte[] getString()

gets the string

Returns:

the string

setString

public void setString(byte[] value)

sets the string

Parameters:

value - the string

getValue

public java.lang.Object getValue()

Description copied from class: PCFParameter

gets the parameter value

Specified by:

getValue in class PCFParameter

Returns:

the parameter value

See Also:

PCFParameter.getValue()

getStringValue

public java.lang.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:

PCFParameter.getStringValue()

getHeaderVersion

public int getHeaderVersion()

Description copied from class: PCFParameter

gets the version number of the header format

Overrides:

getHeaderVersion in class PCFParameter

Returns:

the version number of the header format

See Also:

PCFParameter.getHeaderVersion()