Package it.unimi.di.law.warc.records

Class WarcHeader

java.lang.Object

org.apache.http.message.BasicHeader

it.unimi.di.law.warc.records.WarcHeader

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.apache.http.Header, org.apache.http.NameValuePair

public class WarcHeader
extends org.apache.http.message.BasicHeader

A class used to represent WARC headers, with a set of static methods to handle them.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WarcHeader.Name	An enumeration of WARC headers.

Constructor Summary

Constructors

Constructor	Description
WarcHeader(WarcHeader.Name name, java.lang.String value)	Creates a WARC header.

Method Summary

Modifier and Type	Method	Description
static void	addIfNotPresent(org.apache.http.message.HeaderGroup headers, WarcHeader.Name name, java.lang.String value)	Adds the given header, if not present (otherwise does nothing).
static java.lang.String	formatDate(java.util.Calendar calendar)	Formats the date to be written in the WarcHeader.Name.WARC_DATE header.
static java.lang.String	formatId(java.util.UUID id)	Formats the record id to be written in the WarcHeader.Name.WARC_RECORD_ID header.
static org.apache.http.Header	getFirstHeader(org.apache.http.message.HeaderGroup headers, WarcHeader.Name name)	Returns the first header of given name.
static java.util.Date	parseDate(java.lang.String date)	Parses the date found in a WarcHeader.Name.WARC_DATE header.
static java.util.UUID	parseId(java.lang.String id)	Parses the date found in a WarcHeader.Name.WARC_RECORD_ID header.

Methods inherited from class org.apache.http.message.BasicHeader

clone, getElements, getName, getValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WarcHeader

public WarcHeader(WarcHeader.Name name,
                  java.lang.String value)

Creates a WARC header.

Parameters:

name - the header name.

value - the header value.

Method Detail

addIfNotPresent

public static void addIfNotPresent(org.apache.http.message.HeaderGroup headers,
                                   WarcHeader.Name name,
                                   java.lang.String value)

Adds the given header, if not present (otherwise does nothing).

Parameters:

headers - the headers where to add the new one.

name - the name of the header to add.

value - the value of the header to add.

getFirstHeader

public static org.apache.http.Header getFirstHeader(org.apache.http.message.HeaderGroup headers,
                                                    WarcHeader.Name name)

Returns the first header of given name.

Parameters:

headers - the headers to search from.

name - the name of the header to lookup.

Returns:

the header.

parseDate

public static java.util.Date parseDate(java.lang.String date)
                                throws WarcFormatException

Parses the date found in a WarcHeader.Name.WARC_DATE header.

Parameters:

date - the date.

Returns:

the parsed date.

Throws:

WarcFormatException

formatDate

public static java.lang.String formatDate(java.util.Calendar calendar)

Formats the date to be written in the WarcHeader.Name.WARC_DATE header.

Parameters:

calendar - the date.

Returns:

the formatted date.

parseId

public static java.util.UUID parseId(java.lang.String id)
                              throws WarcFormatException

Parses the date found in a WarcHeader.Name.WARC_RECORD_ID header.

Parameters:

id - the record id.

Returns:

the parsed record id.

Throws:

WarcFormatException

formatId

public static java.lang.String formatId(java.util.UUID id)

Formats the record id to be written in the WarcHeader.Name.WARC_RECORD_ID header.

Parameters:

id - the record id.

Returns:

the formatted record id.