org.apache.geronimo.messaging
Class MsgHeader

java.lang.Object
  org.apache.geronimo.messaging.MsgHeader

All Implemented Interfaces:

Externalizable, Serializable

public class MsgHeader

extends Object

implements Externalizable

Msg header.

Version:

$Revision: 1.2 $ $Date: 2004/07/20 00:08:13 $

See Also:

Serialized Form

Constructor Summary

MsgHeader()

MsgHeader(MsgHeader aHeader)
Prototype.

Method Summary

void	addHeader(Object aKey, Object aValue) Adds an header.
Object	getHeader(Object aKey) Gets a required header.
Object	getOptionalHeader(Object aKey) Gets an optional header.
void	readExternal(ObjectInput in)
Object	resetHeader(Object aKey) Returns the header value and resets it.
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MsgHeader

public MsgHeader()

MsgHeader

public MsgHeader(MsgHeader aHeader)

Prototype.

Parameters:

aHeader - Header to be duplicated.

Method Detail

resetHeader

public Object resetHeader(Object aKey)

Returns the header value and resets it.

Parameters:

aKey - Header key.

Returns:

Header value.

addHeader

public void addHeader(Object aKey,
                      Object aValue)

Adds an header.

Parameters:

aKey - Header key.

aValue - Header value.

getHeader

public Object getHeader(Object aKey)

Gets a required header.

Parameters:

aKey - Header key.

Returns:

Header value.

Throws:

IllegalArgumentException - Indicates that the specified header does not exist.

getOptionalHeader

public Object getOptionalHeader(Object aKey)

Gets an optional header.

Parameters:

aKey - Header key.

Returns:

Header value. If the header is not defined, then null is\ returned.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

toString

public String toString()