com.ibm.mq.pcf

Class PCFHeader

  1. java.lang.Object
  2. extended bycom.ibm.mq.jmqi.JmqiObject
  3. extended bycom.ibm.mq.headers.internal.Header
  4. extended bycom.ibm.mq.pcf.PCFHeader
All implemented interfaces:
com.ibm.mq.headers.internal.CachingHeader, MQData, MQHeader
Direct known subclasses:
MQCFH, PCFMessage, PCFParameter
  1. public abstract class PCFHeader
  2. extends com.ibm.mq.headers.internal.Header
  3. 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
Fields inherited from interface com.ibm.mq.headers.internal.CachingHeader
copyright_notice

Method Summary

Modifier and Type Method and Description
  1. abstract
  2. int
 getType()
Returns the integer type value (MQCFT_*) for this header.
  1. void
 initialize(MQMessage message)
Compatability method matching the MS0B implementation of PCFHeader.
  1. int
 size()
  1. java.lang.String
 toString()
return a string representing this header
  1. int
 write(java.io.DataOutput message,int encoding,int characterSet)
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

  1. public abstract int getType()
Returns the integer type value (MQCFT_*) for this header.

initialize

  1. public void initialize(MQMessage message)
  2. throws MQException
  3. 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

  1. public int write(java.io.DataOutput message,
  2. int encoding,
  3. int characterSet)
  4. throws java.io.IOException
Description copied from interface: MQData
Writes the content of this data element to a message or byte stream and returns the number of bytes written. 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.
Throws:
java.io.IOException

toString

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

  1. public int size()
Description copied from interface: MQData
Returns the size in bytes occupied by this data element in a message.
Specified by:
size in interface MQData
Overrides:
size in class com.ibm.mq.headers.internal.Header