com.ibm.mq.pcf
Class PCFHeader

java.lang.Object
  |
  +--com.ibm.mq.pcf.PCFHeader
Direct Known Subclasses:
MQCFH, PCFMessage, PCFParameter

public abstract class PCFHeader
extends java.lang.Object

Abstract superclass for PCF header types. This class declares methods for reading and writing PCF structures from an MQMessage, and determining their size in bytes as message headers.

Version:
2.2
Author:
Chris Markes

Field Summary
static java.lang.String copyright
           
 
Constructor Summary
PCFHeader()
           
 
Method Summary
abstract  void initialize(com.ibm.mq.MQMessage message)
          Initializes the contents of a PCFHeader by reading from an MQMessage.
abstract  int size()
          Returns the size in bytes of a PCFHeader
abstract  int write(com.ibm.mq.MQMessage message)
          Writes the contents of a PCFHeader to an MQMessage.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final java.lang.String copyright
Constructor Detail

PCFHeader

public PCFHeader()
Method Detail

initialize

public abstract void initialize(com.ibm.mq.MQMessage message)
                         throws com.ibm.mq.MQException,
                                java.io.IOException
Initializes the contents of a PCFHeader by reading from an MQMessage.
Parameters:
message - the message to read from
Throws:
com.ibm.mq.MQException - if the message does contain appropriate data for the header
java.io.IOException - if there is a problem reading the message

write

public abstract int write(com.ibm.mq.MQMessage message)
                   throws java.io.IOException
Writes the contents of a PCFHeader to an MQMessage.
Parameters:
message - the message to write to
Throws:
java.io.IOException - if there is a problem writing the message

size

public abstract int size()
Returns the size in bytes of a PCFHeader