rabbit.http
Class GeneralHeader

java.lang.Object
  rabbit.http.GeneralHeader

All Implemented Interfaces:

Storable

Direct Known Subclasses:

HttpHeader, MultipartHeader

public class GeneralHeader
extends java.lang.Object
implements Storable

A class to handle general headers.

Author:

Robert Olofsson

Field Summary

protected java.util.ArrayList<Header>

headers The headers of this Header in order.

Constructor Summary

GeneralHeader()
Create a new HTTPHeader from scratch

Method Summary

void	addHeader(Header h) Add a new header.
void	addHeader(java.lang.String type, java.lang.String value) Add a new header.
void	copyHeader(GeneralHeader to) Copy all headers in this header to the given header.
protected void	fillBuffer(java.lang.StringBuilder sb) Fill the given StringBuilder with text from this header.
java.lang.String	getHeader(java.lang.String type) get the value of header type
java.util.List<java.lang.String>	getHeaders(java.lang.String type) Get all headers of a specified type...
void	read(java.io.DataInput in) Fill in this object with data from the given input.
void	removeHeader(java.lang.String type) removes a headerline from this header
void	removeValue(java.lang.String value) removes a header with the specified value
void	setExistingValue(java.lang.String current, java.lang.String newValue) Set a specified header
void	setHeader(java.lang.String type, java.lang.String value) Set or replaces a value for given type.
int	size() Get the number of headers set in this header.
java.lang.String	toString() Get the text value of this header
void	write(java.io.DataOutput out) Write this object to the given output.

Methods inherited from class java.lang.Object

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

Field Detail

headers

protected final java.util.ArrayList<Header> headers

The headers of this Header in order.

Constructor Detail

GeneralHeader

public GeneralHeader()

Create a new HTTPHeader from scratch

Method Detail

size

public int size()

Get the number of headers set in this header.

Returns:

the number of header lines

toString

public java.lang.String toString()

Get the text value of this header

Overrides:

toString in class java.lang.Object

Returns:

a String describing this GeneralHeader.

fillBuffer

protected void fillBuffer(java.lang.StringBuilder sb)

Fill the given StringBuilder with text from this header.

Parameters:

sb - the StringBuilder this header is written to

getHeader

public java.lang.String getHeader(java.lang.String type)

get the value of header type

Parameters:

type - the Header were intrested in.

Returns:

the value of type or null if no value is set.

setHeader

public void setHeader(java.lang.String type,
                      java.lang.String value)

Set or replaces a value for given type.

Parameters:

type - the type or category that we want to set.

value - the value we want to set

setExistingValue

public void setExistingValue(java.lang.String current,
                             java.lang.String newValue)

Set a specified header

Parameters:

current - the type or category that we want to set.

newValue - the value we want to set

addHeader

public void addHeader(java.lang.String type,
                      java.lang.String value)

Add a new header. Old headers of the same type remain. The new header is placed last.

Parameters:

type - the type or category that we want to set.

value - the value we want to set

addHeader

public void addHeader(Header h)

Add a new header. Old headers of the same type remain. The new header is placed last.

Parameters:

h - the Header to add

removeHeader

public void removeHeader(java.lang.String type)

removes a headerline from this header

Parameters:

type - the type we want to remove

removeValue

public void removeValue(java.lang.String value)

removes a header with the specified value

Parameters:

value - the value of the header we want to remove

getHeaders

public java.util.List<java.lang.String> getHeaders(java.lang.String type)

Get all headers of a specified type...

Parameters:

type - the type of the headers to get, eg. "Cache-Control".

Returns:

all the headers lines of this header

copyHeader

public void copyHeader(GeneralHeader to)

Copy all headers in this header to the given header.

Parameters:

to - the GeneralHeader to add headers to.

read

public void read(java.io.DataInput in)
          throws java.io.IOException

Description copied from interface: Storable

Fill in this object with data from the given input.

Specified by:

read in interface Storable

Parameters:

in - the input to read from

Throws:

java.io.IOException - if reading fails

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Description copied from interface: Storable

Write this object to the given output.

Specified by:

write in interface Storable

Parameters:

out - the output to write to

Throws:

java.io.IOException - if writing fails