com.ibm.mq.pcf

Class MQCFST

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

All Implemented Interfaces:

com.ibm.mq.headers.internal.CachingHeader, MQData, MQHeader

public class MQCFST
extends PCFParameter

MQCFST (PCF string parameter) header class.

        struct tagMQCFST {
                MQLONG  Type;            // Structure type
                MQLONG  StrucLength;     // Structure length
                MQLONG  Parameter;       // Parameter identifier
                MQLONG  CodedCharSetId;  // Coded character set identifier
                MQLONG  StringLength;    // Length of string
                MQCHAR  String[1];       // String value -- first character
        };
 

Nested Class Summary

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

MQHeader.Field

Field Summary

Fields

Modifier and Type	Field and Description
int	codedCharSetId coded character set identifier
int	parameter parameter identifier
java.lang.String	string string value
int	stringLength length of string
int	strucLength structure length (fixed portion)
static int	type 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 and Description
MQCFST() Constructs an MQCFST instance with default field values.
MQCFST(java.io.DataInput message, int encoding, int characterSet) Constructs an MQCFST instance populated from a DataInput source.
MQCFST(int parameter, java.lang.String string) Initializes an MQCFST with the specified values.
MQCFST(MQMessage message) Constructs an MQCFST instance populated from an MQMessage.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns true when invoked with another MQCFST instance with the same parameter and equivalent value.
int	getCodedCharSetId() gets the coded character set identifier
int	getParameter() gets the parameter identifier
java.lang.String	getString() gets the string value
int	getStringLength() gets the length of the string
java.lang.String	getStringValue() Get the string value of the parameter
int	getStrucLength() Get the length of the structure.
int	getType() gets the structure type
java.lang.Object	getValue() Get the value of the parameter
int	hashCode() Returns a hash code value for the object
void	setCodedCharSetId(int value) sets the coded character set identifier
void	setParameter(int value) sets the parameter identifier
void	setString(java.lang.String value) sets the string value
static int	write(MQMessage message, int parameter, java.lang.String string) A convenience method for writing an MQCFST header structure with the specified values to an MQMessage

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

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

getClass, notify, notifyAll, wait, wait, wait

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

discardCachedContent, readCachedContent, writeCachedContent

Field Detail

type

public static final int type

structure type

See Also:

Constant Field Values

strucLength

public int strucLength

structure length (fixed portion)

parameter

public int parameter

parameter identifier

codedCharSetId

public int codedCharSetId

coded character set identifier

stringLength

public int stringLength

length of string

string

public java.lang.String string

string value

Constructor Detail

MQCFST

public MQCFST()

Constructs an MQCFST instance with default field values.

MQCFST

public MQCFST(MQMessage message)
       throws MQException,
              java.io.IOException

Constructs an MQCFST instance populated from an MQMessage.

Parameters:

message - the message to read

Throws:

MQException - if the message content does not yield a valid MQCFST stucture

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

MQCFST

public MQCFST(java.io.DataInput message,
      int encoding,
      int characterSet)
       throws MQException,
              java.io.IOException

Constructs an MQCFST 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 MQCFST stucture

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

MQCFST

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

Initializes an MQCFST with the specified values.

Parameters:

parameter - the parameter identifier

string - the string parameter value

Method Detail

write

public static int write(MQMessage message,
        int parameter,
        java.lang.String string)
                 throws java.io.IOException

A convenience method for writing an MQCFST header structure with the specified values to an MQMessage

Parameters:

message - the message to write to

parameter - the parameter identifier

string - the string parameter value

Returns:

the number of bytes written

Throws:

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

See Also:

CMQCFC

equals

public boolean equals(java.lang.Object obj)

Returns true when invoked with another MQCFST instance with the same parameter and equivalent value. Comparison of the values is performed using the equals method of String. Note: Two MQCFST instances with null values are not regarded as equal.
It doesn't really matter - such instances are not really interesting - but it's worth commenting on.

Overrides:

equals in class PCFParameter

Parameters:

obj -

Returns:

true if 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 integer type value (MQCFT_*) for this header.

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

getCodedCharSetId

public int getCodedCharSetId()

gets the coded character set identifier

Returns:

the coded character set identifier

setCodedCharSetId

public void setCodedCharSetId(int value)

sets the coded character set identifier

Parameters:

value - the coded character set identifier

getStringLength

public int getStringLength()

gets the length of the string

Returns:

the length of the string

getString

public java.lang.String getString()

gets the string value

Returns:

the string value

setString

public void setString(java.lang.String value)

sets the string value

Parameters:

value -

getValue

public java.lang.Object getValue()

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:

PCFParameter.getValue()

getStringValue

public java.lang.String getStringValue()

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:

PCFParameter.getStringValue()