com.ibm.mq.pcf

Class MQCFIN

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

All Implemented Interfaces:

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

public class MQCFIN
extends PCFParameter

MQCFIN (PCF integer parameter) header class.

      struct tagMQCFIN {
                MQLONG  Type;         // Structure type
                MQLONG  StrucLength;  // Structure length
                MQLONG  Parameter;    // Parameter identifier
                MQLONG  Value;        // Parameter value
        };
 

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	parameter parameter identifier
static int	strucLength structure length
static int	type Structure type
int	value parameter value

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
MQCFIN() Constructs an MQCFIN instance with default field values.
MQCFIN(java.io.DataInput message, int encoding, int characterSet) Constructs an MQCFIN instance populated from a DataInput source.
MQCFIN(int parameter, int value) Initializes an MQCFIN header with the specified values.
MQCFIN(MQMessage message) Constructs an MQCFIN 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 MQCFIN instance with the same parameter and value.
int	getIntValue() gets the parameter value
int	getParameter() gets the parameter identifier
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	setIntValue(int value) sets the parameter value
void	setParameter(int value) sets the parameter identifier
static int	write(MQMessage message, int parameter, int value) A convenience method for writing an MQCFIN 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 static final int strucLength

structure length

See Also:

Constant Field Values

parameter

public int parameter

parameter identifier

value

public int value

parameter value

Constructor Detail

MQCFIN

public MQCFIN()

Constructs an MQCFIN instance with default field values.

MQCFIN

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

Constructs an MQCFIN instance populated from an MQMessage.

Parameters:

message - the message to read

Throws:

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

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

MQCFIN

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

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

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

MQCFIN

public MQCFIN(int parameter,
      int value)

Initializes an MQCFIN header with the specified values.

Parameters:

parameter - the parameter identifier

value - the integer parameter value

Method Detail

write

public static int write(MQMessage message,
        int parameter,
        int value)
                 throws java.io.IOException

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

Parameters:

message - the message to write to

parameter - the parameter identifier

value - the integer 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 MQCFIN instance with the same parameter and value.

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()

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

getIntValue

public int getIntValue()

gets the parameter value

Returns:

the parameter value

setIntValue

public void setIntValue(int value)

sets the parameter value

Parameters:

value - the parameter 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()