com.ibm.mq.pcf

Class PCFParameter

java.lang.Object

com.ibm.mq.jmqi.JmqiObject

com.ibm.mq.headers.internal.Header

com.ibm.mq.pcf.PCFHeader

com.ibm.mq.pcf.PCFParameter

All Implemented Interfaces:

com.ibm.mq.headers.internal.CachingHeader, 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() Get the header version
abstract int	getParameter() Get the parameter
java.lang.String	getParameterName() Get the MQ constant name for the parameter id of this PCFParameter instance.
abstract java.lang.String	getStringValue() Get the string value of the parameter
abstract java.lang.Object	getValue() Get the value of the parameter
abstract int	hashCode() Returns a hash code value for the object
static PCFParameter	nextParameter(MQMessage message) The next parameter in the header

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

getType, 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

Method Detail

nextParameter

public static PCFParameter nextParameter(MQMessage message)
                                  throws MQException,
                                         java.io.IOException

The next parameter in the header

Parameters:

message - The associated MQMessage

Returns:

The next parameter in the header

Throws:

MQException - If the call fails

java.io.IOException - If there is an IO error

getParameter

public abstract int getParameter()

Get the parameter

Returns:

Return the parameter

getValue

public abstract java.lang.Object getValue()

Get the value of the parameter

Returns:

Return the value of the parameter

getStringValue

public abstract java.lang.String getStringValue()

Get the string value of the parameter

Returns:

Returns the string value of the parameter

getHeaderVersion

public int getHeaderVersion()

Get the header version

Returns:

Return the header version

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 - The object to compare against

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.