com.ibm.mq.pcf

Class PCFHeader

java.lang.Object

com.ibm.mq.jmqi.JmqiObject

com.ibm.mq.headers.internal.Header

com.ibm.mq.pcf.PCFHeader

All Implemented Interfaces:

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

Direct Known Subclasses:

MQCFH, PCFMessage, PCFParameter

public abstract class PCFHeader
extends com.ibm.mq.headers.internal.Header
implements com.ibm.mq.headers.internal.CachingHeader

Abstract superclass of PCF header classes. All PCF headers have a type 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
abstract int	getType()
void	initialize(MQMessage message) Compatability method matching the MS0B implementation of PCFHeader.
int	size()
java.lang.String	toString() return a string representing this header
int	write(java.io.DataOutput message, int encoding, int characterSet) Writes the content of this data element to a message or byte stream.

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

discardCachedContent, readCachedContent, writeCachedContent

Method Detail

getType

public abstract int getType()

Returns:

the integer type value (MQCFT_*) for this header.

initialize

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

Compatability method matching the MS0B implementation of PCFHeader. This method invokes read(MQMessage) and readCachedContent to populate instance fields.

Parameters:

message - the message.

Throws:

MQException

java.io.IOException

write

public int write(java.io.DataOutput message,
        int encoding,
        int characterSet)
          throws java.io.IOException

Description copied from interface: MQData

Writes the content of this data element to a message or byte stream. The content is encoded (if applicable) using the specified encoding and CCSID.

Specified by:

write in interface MQData

Overrides:

write in class com.ibm.mq.headers.internal.Header

Parameters:

message - the message.

encoding - the numeric encoding. see (CMQC.MQENC_* for values)._

characterSet - the Coded Character Set Identifier.

Returns:

the number of bytes written

Throws:

java.io.IOException

See Also:

Header.write(java.io.DataOutput, int, int)

toString

public java.lang.String toString()

return a string representing this header

Overrides:

toString in class com.ibm.mq.headers.internal.Header

Returns:

the string

See Also:

Object.toString()

size

public int size()

Specified by:

size in interface MQData

Overrides:

size in class com.ibm.mq.headers.internal.Header

Returns:

the size in bytes occupied by this data element in a message.

See Also:

Header.size()