com.ibm.mq.headers.pcf

Class PCFParameter

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

All Implemented Interfaces:

MQData, MQHeader

Direct Known Subclasses:

MQCFBS, MQCFGR, MQCFIL, MQCFIL64, MQCFIN, MQCFIN64, MQCFSL, MQCFST, PCFFilterParameter

public abstract class PCFParameter
extends PCFHeader

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

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns true when invoked with another PCFParameter instance with the same type, parameter, and value.
int	getHeaderVersion() gets the version number of the header format
abstract int	getParameter() gets the parameter identifier
java.lang.String	getParameterName() Get the MQ constant name for the parameter id of this PCFParameter instance.
abstract java.lang.String	getStringValue() gets the parameter value as a String
abstract java.lang.Object	getValue() gets the parameter value
abstract int	hashCode() Returns a hash code value for the object
static PCFParameter	nextParameter(java.io.DataInput message)

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

getType

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

Method Detail

nextParameter

public static PCFParameter nextParameter(java.io.DataInput message)
                                  throws MQDataException,
                                         java.io.IOException

Parameters:

message -

Returns:

the next parameter!

Throws:

MQDataException

java.io.IOException

getParameter

public abstract int getParameter()

gets the parameter identifier

Returns:

the parameter identifier

getValue

public abstract java.lang.Object getValue()

gets the parameter value

Returns:

the parameter value

getStringValue

public abstract java.lang.String getStringValue()

gets the parameter value as a String

Returns:

the parameter value as a String

getHeaderVersion

public int getHeaderVersion()

gets the version number of the header format

Returns:

the version number of the header format

equals

public boolean equals(java.lang.Object obj)

Returns true when invoked with another PCFParameter instance with the same type, parameter, and value.

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

true of the object equals this one

hashCode

public abstract int hashCode()

Returns a hash code value for the object

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

getParameterName

public final java.lang.String getParameterName()

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.