org.columba.ristretto.message

Class Header

java.lang.Object

org.columba.ristretto.message.Header

All Implemented Interfaces:

java.io.Serializable, Streamable

public class Header
extends java.lang.Object
implements Streamable, java.io.Serializable

Datastructure that stores headers. This is basically comparable to a java.util.Map structure.

Author:

tstich

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Header() Constructs the Header.

Method Summary

Modifier and Type	Method and Description
void	append(java.lang.String key, java.lang.String value) Append the value to the header with the specified key.
java.lang.Object	clone()
int	count()
java.lang.String	get(java.lang.String key) Get the header with the specified key.
java.util.Map<java.lang.String,java.lang.String>	getHeader()
java.io.InputStream	getInputStream()
java.util.Enumeration<java.lang.String>	getKeys() Gets the keys that are stored in the header.
int	length()
void	merge(Header arg) Merge the given header with this header.
void	set(java.lang.String key, java.lang.Object value) Set the header with the specified key.
void	setHeader(java.util.Map<java.lang.String,java.lang.String> header)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Header

public Header()

Constructs the Header.

Method Detail

set

public void set(java.lang.String key,
                java.lang.Object value)

Set the header with the specified key.

Parameters:

key -

value -

append

public void append(java.lang.String key,
                   java.lang.String value)

Append the value to the header with the specified key.

Parameters:

key -

value -

get

public java.lang.String get(java.lang.String key)

Get the header with the specified key.

Parameters:

key -

Returns:

the header

length

public int length()

Returns:

the number of headers

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

count

public int count()

Returns:

the number of headers

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

merge

public void merge(Header arg)

Merge the given header with this header.

Parameters:

arg -

getInputStream

public java.io.InputStream getInputStream()

Specified by:

getInputStream in interface Streamable

Returns:

returns the InputStream of the data structure.

See Also:

Streamable.getInputStream()

getKeys

public java.util.Enumeration<java.lang.String> getKeys()

Gets the keys that are stored in the header.

Returns:

the Enumeration of keys

getHeader

public java.util.Map<java.lang.String,java.lang.String> getHeader()

Returns:

Returns the header.

setHeader

public void setHeader(java.util.Map<java.lang.String,java.lang.String> header)

Parameters:

header - The header to set.