WarcHeader (jwat-warc 1.0.3 API)

java.lang.Object
- org.jwat.warc.WarcHeader

```
public class WarcHeader
extends Object
```
Central class for working with WARC headers. This class includes support for reading and writing WARC headers. Methods are also available to validate individual headers and a WARC header as a whole.

Author:

nicl

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`bMagicIdentified` Was "WARC/" identified while looking for the version string.
`boolean`	`bMandatoryMissing` Is the header missing one of the mandatory headers.
`boolean`	`bValidVersion` Is the version recognized.
`boolean`	`bValidVersionFormat` Is the version format valid.
`boolean`	`bVersionParsed` Did the version string include between 2 and 4 substrings delimited by ".".
`Long`	`contentLength` Content-Length converted to a `Long` object, if valid.
`String`	`contentLengthStr` Content-Length field string value.
`ContentType`	`contentType` Content-Type converted to a `ContentType` object, if valid.
`String`	`contentTypeStr` Content-Type field string value.
`protected Diagnostics<Diagnosis>`	`diagnostics` Diagnostics used to report diagnoses.
`protected WarcFieldParsers`	`fieldParsers` WARC field parser used.
`byte[]`	`headerBytes` Raw WARC header byte array.
`protected ByteArrayOutputStream`	`headerBytesOut` Raw WARC header output stream.
`protected List<HeaderLine>`	`headerList` List of parsed header fields.
`protected Map<String,HeaderLine>`	`headerMap` Map of parsed header fields.
`int`	`major` Major version number from WARC header.
`int`	`minor` Minor version number from WARC header.
`protected WarcReader`	`reader` Associated WarcReader context.
`protected boolean[]`	`seen` Array used for duplicate header detection.
`protected long`	`startOffset` WARC record starting offset relative to the source WARC file input stream.
`static boolean`	`URI_LTGT` An URI with encapsulating <> characters.
`static boolean`	`URI_NAKED` An URI without encapsulating <> characters.
`protected UriProfile`	`uriProfile` URI profile.
`int[]`	`versionArr` Array based on the version string split by the "." delimiter and converted to integers.
`String`	`versionStr` Raw version string.
`WarcDigest`	`warcBlockDigest` WARC-Block-Digest converted to a `WarcDigest` object, if valid.
`String`	`warcBlockDigestStr` WARC-Block-Digest field string value.
`List<WarcConcurrentTo>`	`warcConcurrentToList` List of WARC-Concurrent-To field string values and converted `URI` objects, if valid.
`Date`	`warcDate` WARC-Date converted to a `Date` object, if valid.
`protected DateFormat`	`warcDateFormat` WARC `DateFormat` as specified by the WARC ISO standard.
`String`	`warcDateStr` WARC-Date field string value.
`String`	`warcFilename` WARC-Filename field string value.
`ContentType`	`warcIdentifiedPayloadType` WARC-Identified-Payload-Type converted to a `ContentType` object, if valid.
`String`	`warcIdentifiedPayloadTypeStr` WARC-Identified-Payload-Type field string value.
`InetAddress`	`warcInetAddress` WARC-IP-Address converted to an `InetAddress` object, if valid.
`String`	`warcIpAddress` WARC-IP-Address field string value.
`WarcDigest`	`warcPayloadDigest` WARC-Payload-Digest converted to a `WarcDigest` object, if valid.
`String`	`warcPayloadDigestStr` WARC-Payload-Digest field string value.
`Integer`	`warcProfileIdx` WARC-Profile converted to an integer id, if valid.
`String`	`warcProfileStr` WARC-Profile field string value.
`Uri`	`warcProfileUri` WARC-Profile field converted to an `Uri` object, if valid.
`String`	`warcRecordIdStr` WARC-Record-Id field string value.
`Uri`	`warcRecordIdUri` WARC-Record-Id converted to an `Uri` object, if valid.
`Date`	`warcRefersToDate` WARC-Date converted to a `Date` object, if valid.
`String`	`warcRefersToDateStr` WARC-Refers-To-Date
`String`	`warcRefersToStr` WARC-Refers-To field string value.
`String`	`warcRefersToTargetUriStr` WARC-Refers-To-Target-URI field string value.
`Uri`	`warcRefersToTargetUriUri` WARC-Refers-To-Target-URI converted to an `Uri` object, if valid.
`Uri`	`warcRefersToUri` WARC-Refers-To converted to an `Uri` object, if valid.
`Integer`	`warcSegmentNumber` WARC-Segment-Number converted to an `Integer` object, if valid.
`String`	`warcSegmentNumberStr` WARC-Segment-Number field string value.
`String`	`warcSegmentOriginIdStr` WARC-Segment-Origin-Id field string value.
`Uri`	`warcSegmentOriginIdUrl` WARC-Segment-Origin-Id converted to an `Uri` object, if valid.
`Long`	`warcSegmentTotalLength` WARC-Segment-Total-Length converted to a `Long` object, if valid.
`String`	`warcSegmentTotalLengthStr` WARC-Segment-Total-Length field string value.
`protected UriProfile`	`warcTargetUriProfile` WARC-Target-URI profile.
`String`	`warcTargetUriStr` WARC_Target-URI field string value.
`Uri`	`warcTargetUriUri` WARC-TargetURI converted to an `Uri` object, if valid.
`Integer`	`warcTruncatedIdx` WARC-Truncated converted to an integer id, if valid.
`String`	`warcTruncatedStr` WARC-Truncated field string value.
`Integer`	`warcTypeIdx` WARC-Type converted to an integer id, if identified.
`String`	`warcTypeStr` WARC-Type field string value.
`String`	`warcWarcinfoIdStr` WARC-Warcinfo-Id field string value.
`Uri`	`warcWarcinfoIdUri` WARC-Warcinfo-Id converted to an `Uri` object, if valid.

Constructor Summary

Constructors
Modifier Constructor and Description

protected WarcHeader()
Non public constructor to allow unit testing.

Constructors
Modifier	Constructor and Description
`protected`	`WarcHeader()` Non public constructor to allow unit testing.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addErrorDiagnosis(DiagnosisType type, String entity, String... information)` Add an error diagnosis of the given type on a specific entity with optional extra information.
`protected void`	`addHeader(HeaderLine headerLine)` Identify a (WARC) header name, validate the value and set the header.
`HeaderLine`	`addHeader(String fieldName, ContentType contentTypeFieldValue, String fieldValueStr)` Add an Content-Type header using the supplied string and object values and return a `HeaderLine` object corresponding to how the header would be read.
`HeaderLine`	`addHeader(String fieldName, Date dateFieldValue, String fieldValueStr)` Add an Date header using the supplied string and object values and return a `HeaderLine` object corresponding to how the header would be read.
`HeaderLine`	`addHeader(String fieldName, InetAddress inetAddrFieldValue, String fieldValueStr)` Add an InetAddress header using the supplied string and object values and return a `HeaderLine` object corresponding to how the header would be read.
`HeaderLine`	`addHeader(String fieldName, Integer integerFieldValue, String fieldValueStr)` Add an Integer header using the supplied string and object values and return a `HeaderLine` object corresponding to how the header would be read.
`HeaderLine`	`addHeader(String fieldName, Long longFieldValue, String fieldValueStr)` Add a Long header using the supplied string and object values and return a `HeaderLine` object corresponding to how the header would be read.
`HeaderLine`	`addHeader(String fieldName, String fieldValue)` Add a String header using the supplied string and return a `HeaderLine` object corresponding to how the header would be read.
`HeaderLine`	`addHeader(String fieldName, String fieldValueStr, int dt, Integer integerFieldValue, Long longFieldValue, WarcDigest digestFieldValue, ContentType contentTypeFieldValue, Date dateFieldValue, InetAddress inetAddrFieldValue, Uri uriFieldValue)` Add a header with the supplied field name, data type and value and return a `HeaderLine` corresponding to how the header will be read.
`HeaderLine`	`addHeader(String fieldName, Uri uriFieldValue, String fieldValueStr)` Add an URI header using the supplied string and object values and return a `HeaderLine` object corresponding to how the header would be read.
`HeaderLine`	`addHeader(String fieldName, WarcDigest digestFieldValue, String fieldValueStr)` Add an Digest header using the supplied string and object values and return a `HeaderLine` object corresponding to how the header would be read.
`protected void`	`addWarningDiagnosis(DiagnosisType type, String entity, String... information)` Add a warning diagnosis of the given type on a specific entity with optional extra information.
`protected void`	`checkFieldPolicy(int recordType, int fieldType, Object fieldObj, String valueStr)` Given a WARC record type and a WARC field looks up the policy in a matrix build from the WARC ISO standard.
`protected void`	`checkFields()` Validate the WARC header relative to the WARC-Type and according to the WARC ISO standard.
`HeaderLine`	`getHeader(String field)` Get a header line structure or null, if no header line structure is stored with the given header name.
`List<HeaderLine>`	`getHeaderList()` Get a `List` of all the headers found during parsing.
`long`	`getStartOffset()` Returns the starting offset of the record in the containing WARC.
`static WarcHeader`	`initHeader(WarcReader reader, long startOffset, Diagnostics<Diagnosis> diagnostics)` Create and initialize a new `WarcHeader` for reading.
`static WarcHeader`	`initHeader(WarcWriter writer, Diagnostics<Diagnosis> diagnostics)` Create and initialize a new `WarcHeader` for writing.
`boolean`	`parseHeader(ByteCountingPushBackInputStream in)` Try to parse a WARC header and return a boolean indicating the success or failure of this.
`protected void`	`parseHeaders(ByteCountingPushBackInputStream in)` Reads WARC header lines one line at a time until an empty line is encountered.
`protected boolean`	`parseVersion(ByteCountingPushBackInputStream in)` Looks forward in the input stream for a valid WARC version line.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - URI_LTGT
```
public static final boolean URI_LTGT
```
    An URI with encapsulating <> characters.
    
    See Also:
    
    Constant Field Values
  - URI_NAKED
```
public static final boolean URI_NAKED
```
    An URI without encapsulating <> characters.
    
    See Also:
    
    Constant Field Values
  - reader
```
protected WarcReader reader
```
    Associated WarcReader context. Must be set prior to calling the various methods.
  - diagnostics
```
protected Diagnostics<Diagnosis> diagnostics
```
    Diagnostics used to report diagnoses. Must be set prior to calling the various methods.
  - warcTargetUriProfile
```
protected UriProfile warcTargetUriProfile
```
    WARC-Target-URI profile.
  - uriProfile
```
protected UriProfile uriProfile
```
    URI profile.
  - fieldParsers
```
protected WarcFieldParsers fieldParsers
```
    WARC field parser used. Must be set prior to calling the various methods.
  - warcDateFormat
```
protected DateFormat warcDateFormat
```
    WARC DateFormat as specified by the WARC ISO standard.
  - startOffset
```
protected long startOffset
```
    WARC record starting offset relative to the source WARC file input stream. The offset is correct for both compressed and uncompressed streams.
  - bMagicIdentified
```
public boolean bMagicIdentified
```
    Was "WARC/" identified while looking for the version string.
  - bVersionParsed
```
public boolean bVersionParsed
```
    Did the version string include between 2 and 4 substrings delimited by ".".
  - bValidVersionFormat
```
public boolean bValidVersionFormat
```
    Is the version format valid.
  - bValidVersion
```
public boolean bValidVersion
```
    Is the version recognized. (0.17, 0.18 or 1.0)
  - versionStr
```
public String versionStr
```
    Raw version string.
  - versionArr
```
public int[] versionArr
```
    Array based on the version string split by the "." delimiter and converted to integers.
  - major
```
public int major
```
    Major version number from WARC header.
  - minor
```
public int minor
```
    Minor version number from WARC header.
  - seen
```
protected boolean[] seen
```
    Array used for duplicate header detection.
  - bMandatoryMissing
```
public boolean bMandatoryMissing
```
    Is the header missing one of the mandatory headers.
  - warcTypeStr
```
public String warcTypeStr
```
    WARC-Type field string value.
  - warcTypeIdx
```
public Integer warcTypeIdx
```
    WARC-Type converted to an integer id, if identified.
  - warcFilename
```
public String warcFilename
```
    WARC-Filename field string value. (warcinfo record type only)
  - warcRecordIdStr
```
public String warcRecordIdStr
```
    WARC-Record-Id field string value.
  - warcRecordIdUri
```
public Uri warcRecordIdUri
```
    WARC-Record-Id converted to an Uri object, if valid.
  - warcDateStr
```
public String warcDateStr
```
    WARC-Date field string value.
  - warcDate
```
public Date warcDate
```
    WARC-Date converted to a Date object, if valid.
  - contentLengthStr
```
public String contentLengthStr
```
    Content-Length field string value.
  - contentLength
```
public Long contentLength
```
    Content-Length converted to a Long object, if valid.
  - contentTypeStr
```
public String contentTypeStr
```
    Content-Type field string value.
  - contentType
```
public ContentType contentType
```
    Content-Type converted to a ContentType object, if valid.
  - warcTruncatedStr
```
public String warcTruncatedStr
```
    WARC-Truncated field string value.
  - warcTruncatedIdx
```
public Integer warcTruncatedIdx
```
    WARC-Truncated converted to an integer id, if valid.
  - warcIpAddress
```
public String warcIpAddress
```
    WARC-IP-Address field string value.
  - warcInetAddress
```
public InetAddress warcInetAddress
```
    WARC-IP-Address converted to an InetAddress object, if valid.
  - warcConcurrentToList
```
public List<WarcConcurrentTo> warcConcurrentToList
```
    List of WARC-Concurrent-To field string values and converted URI objects, if valid.
  - warcRefersToStr
```
public String warcRefersToStr
```
    WARC-Refers-To field string value.
  - warcRefersToUri
```
public Uri warcRefersToUri
```
    WARC-Refers-To converted to an Uri object, if valid.
  - warcTargetUriStr
```
public String warcTargetUriStr
```
    WARC_Target-URI field string value.
  - warcTargetUriUri
```
public Uri warcTargetUriUri
```
    WARC-TargetURI converted to an Uri object, if valid.
  - warcWarcinfoIdStr
```
public String warcWarcinfoIdStr
```
    WARC-Warcinfo-Id field string value.
  - warcWarcinfoIdUri
```
public Uri warcWarcinfoIdUri
```
    WARC-Warcinfo-Id converted to an Uri object, if valid.
  - warcBlockDigestStr
```
public String warcBlockDigestStr
```
    WARC-Block-Digest field string value.
  - warcBlockDigest
```
public WarcDigest warcBlockDigest
```
    WARC-Block-Digest converted to a WarcDigest object, if valid.
  - warcPayloadDigestStr
```
public String warcPayloadDigestStr
```
    WARC-Payload-Digest field string value.
  - warcPayloadDigest
```
public WarcDigest warcPayloadDigest
```
    WARC-Payload-Digest converted to a WarcDigest object, if valid.
  - warcIdentifiedPayloadTypeStr
```
public String warcIdentifiedPayloadTypeStr
```
    WARC-Identified-Payload-Type field string value.
  - warcIdentifiedPayloadType
```
public ContentType warcIdentifiedPayloadType
```
    WARC-Identified-Payload-Type converted to a ContentType object, if valid.
  - warcProfileStr
```
public String warcProfileStr
```
    WARC-Profile field string value. (revisit record only)
  - warcProfileUri
```
public Uri warcProfileUri
```
    WARC-Profile field converted to an Uri object, if valid. (revisit record only)
  - warcProfileIdx
```
public Integer warcProfileIdx
```
    WARC-Profile converted to an integer id, if valid. (revisit record only)
  - warcSegmentNumberStr
```
public String warcSegmentNumberStr
```
    WARC-Segment-Number field string value.
  - warcSegmentNumber
```
public Integer warcSegmentNumber
```
    WARC-Segment-Number converted to an Integer object, if valid.
  - warcSegmentOriginIdStr
```
public String warcSegmentOriginIdStr
```
    WARC-Segment-Origin-Id field string value. (continuation record only)
  - warcSegmentOriginIdUrl
```
public Uri warcSegmentOriginIdUrl
```
    WARC-Segment-Origin-Id converted to an Uri object, if valid. (continuation record only)
  - warcSegmentTotalLengthStr
```
public String warcSegmentTotalLengthStr
```
    WARC-Segment-Total-Length field string value. (continuation record only)
  - warcSegmentTotalLength
```
public Long warcSegmentTotalLength
```
    WARC-Segment-Total-Length converted to a Long object, if valid. (continuation record only)
  - warcRefersToTargetUriStr
```
public String warcRefersToTargetUriStr
```
    WARC-Refers-To-Target-URI field string value.
  - warcRefersToTargetUriUri
```
public Uri warcRefersToTargetUriUri
```
    WARC-Refers-To-Target-URI converted to an Uri object, if valid.
  - warcRefersToDateStr
```
public String warcRefersToDateStr
```
    WARC-Refers-To-Date
  - warcRefersToDate
```
public Date warcRefersToDate
```
    WARC-Date converted to a Date object, if valid.
  - headerBytesOut
```
protected ByteArrayOutputStream headerBytesOut
```
    Raw WARC header output stream.
  - headerBytes
```
public byte[] headerBytes
```
    Raw WARC header byte array.
  - headerList
```
protected List<HeaderLine> headerList
```
    List of parsed header fields.
  - headerMap
```
protected Map<String,HeaderLine> headerMap
```
    Map of parsed header fields.
- Constructor Detail
  - WarcHeader
```
protected WarcHeader()
```
    Non public constructor to allow unit testing.
- Method Detail
  - initHeader
```
public static WarcHeader initHeader(WarcWriter writer,
                                    Diagnostics<Diagnosis> diagnostics)
```
    Create and initialize a new WarcHeader for writing.
    
    Parameters:
    
    writer - writer which shall be used
    
    diagnostics - diagnostics object used by writer
    
    Returns:
    
    a WarcHeader prepared for writing
  - initHeader
```
public static WarcHeader initHeader(WarcReader reader,
                                    long startOffset,
                                    Diagnostics<Diagnosis> diagnostics)
```
    Create and initialize a new WarcHeader for reading.
    
    Parameters:
    
    reader - reader which shall be used
    
    startOffset - start offset of header
    
    diagnostics - diagnostics object used by reader
    
    Returns:
    
    a WarcHeader prepared for reading
  - addErrorDiagnosis
```
protected void addErrorDiagnosis(DiagnosisType type,
                                 String entity,
                                 String... information)
```
    Add an error diagnosis of the given type on a specific entity with optional extra information. The information varies according to the diagnosis type.
    
    Parameters:
    
    type - diagnosis type
    
    entity - entity examined
    
    information - optional extra information
  - addWarningDiagnosis
```
protected void addWarningDiagnosis(DiagnosisType type,
                                   String entity,
                                   String... information)
```
    Add a warning diagnosis of the given type on a specific entity with optional extra information. The information varies according to the diagnosis type.
    
    Parameters:
    
    type - diagnosis type
    
    entity - entity examined
    
    information - optional extra information
  - getStartOffset
```
public long getStartOffset()
```
    Returns the starting offset of the record in the containing WARC.
    
    Returns:
    
    the starting offset of the record
  - parseHeader
```
public boolean parseHeader(ByteCountingPushBackInputStream in)
                    throws IOException
```
    Try to parse a WARC header and return a boolean indicating the success or failure of this.
    
    Parameters:
    
    in - input stream with WARC data
    
    Returns:
    
    boolean indicating whether a header was parsed or not
    
    Throws:
    
    IOException - if an i/o exception occurs while parsing for a header
  - parseVersion
```
protected boolean parseVersion(ByteCountingPushBackInputStream in)
                        throws IOException
```
    Looks forward in the input stream for a valid WARC version line.
    
    Parameters:
    
    in - data input stream
    
    Returns:
    
    true, if magic WARC header found
    
    Throws:
    
    IOException - if an error occurs while reading version data
  - parseHeaders
```
protected void parseHeaders(ByteCountingPushBackInputStream in)
                     throws IOException
```
    Reads WARC header lines one line at a time until an empty line is encountered.
    
    Parameters:
    
    in - header input stream
    
    Throws:
    
    IOException - if an error occurs while reading the WARC header
  - addHeader
```
protected void addHeader(HeaderLine headerLine)
```
    Identify a (WARC) header name, validate the value and set the header.
    
    Parameters:
    
    headerLine - the headerLine
  - getHeaderList
```
public List<HeaderLine> getHeaderList()
```
    Get a List of all the headers found during parsing.
    
    Returns:
    
    List of HeaderLine
  - getHeader
```
public HeaderLine getHeader(String field)
```
    Get a header line structure or null, if no header line structure is stored with the given header name.
    
    Parameters:
    
    field - header name
    
    Returns:
    
    HeaderLine structure or null
  - addHeader
```
public HeaderLine addHeader(String fieldName,
                            String fieldValue)
```
    Add a String header using the supplied string and return a HeaderLine object corresponding to how the header would be read.
    
    Parameters:
    
    fieldName - name of field to add
    
    fieldValue - field value string
    
    Returns:
    
    HeaderLine object corresponding to what would have been read
  - addHeader
```
public HeaderLine addHeader(String fieldName,
                            Integer integerFieldValue,
                            String fieldValueStr)
```
    Add an Integer header using the supplied string and object values and return a HeaderLine object corresponding to how the header would be read. If both string and object values are not null they are used as is. If the string value is null and the object is not null, the object's toString method is called. If the object is null and the string is not null, the string is parsed and validated resulting in an object, if valid.
    
    Parameters:
    
    fieldName - name of field to add
    
    integerFieldValue - Integer field value object
    
    fieldValueStr - Integer field value string
    
    Returns:
    
    HeaderLine object corresponding to what would have been read
  - addHeader
```
public HeaderLine addHeader(String fieldName,
                            Long longFieldValue,
                            String fieldValueStr)
```
    Add a Long header using the supplied string and object values and return a HeaderLine object corresponding to how the header would be read. If both string and object values are not null they are used as is. If the string value is null and the object is not null, the object's toString method is called. If the object is null and the string is not null, the string is parsed and validated resulting in an object, if valid.
    
    Parameters:
    
    fieldName - name of field to add
    
    longFieldValue - Long field value object
    
    fieldValueStr - Long field value string
    
    Returns:
    
    HeaderLine object corresponding to what would have been read
  - addHeader
```
public HeaderLine addHeader(String fieldName,
                            WarcDigest digestFieldValue,
                            String fieldValueStr)
```
    Add an Digest header using the supplied string and object values and return a HeaderLine object corresponding to how the header would be read. If both string and object values are not null they are used as is. If the string value is null and the object is not null, the object's toString method is called. If the object is null and the string is not null, the string is parsed and validated resulting in an object, if valid.
    
    Parameters:
    
    fieldName - name of field to add
    
    digestFieldValue - Digest field value object
    
    fieldValueStr - Digest field value string
    
    Returns:
    
    HeaderLine object corresponding to what would have been read
  - addHeader
```
public HeaderLine addHeader(String fieldName,
                            ContentType contentTypeFieldValue,
                            String fieldValueStr)
```
    Add an Content-Type header using the supplied string and object values and return a HeaderLine object corresponding to how the header would be read. If both string and object values are not null they are used as is. If the string value is null and the object is not null, the object's toString method is called. If the object is null and the string is not null, the string is parsed and validated resulting in an object, if valid.
    
    Parameters:
    
    fieldName - name of field to add
    
    contentTypeFieldValue - ContentType field value object
    
    fieldValueStr - Content-Type field value string
    
    Returns:
    
    HeaderLine object corresponding to what would have been read
  - addHeader
```
public HeaderLine addHeader(String fieldName,
                            Date dateFieldValue,
                            String fieldValueStr)
```
    Add an Date header using the supplied string and object values and return a HeaderLine object corresponding to how the header would be read. If both string and object values are not null they are used as is. If the string value is null and the object is not null, the object's toString method is called. If the object is null and the string is not null, the string is parsed and validated resulting in an object, if valid.
    
    Parameters:
    
    fieldName - name of field to add
    
    dateFieldValue - Date field value object
    
    fieldValueStr - Date field value string
    
    Returns:
    
    HeaderLine object corresponding to what would have been read
  - addHeader
```
public HeaderLine addHeader(String fieldName,
                            InetAddress inetAddrFieldValue,
                            String fieldValueStr)
```
    Add an InetAddress header using the supplied string and object values and return a HeaderLine object corresponding to how the header would be read. If both string and object values are not null they are used as is. If the string value is null and the object is not null, the object's toString method is called. If the object is null and the string is not null, the string is parsed and validated resulting in an object, if valid.
    
    Parameters:
    
    fieldName - name of field to add
    
    inetAddrFieldValue - InetAddress field value object
    
    fieldValueStr - IP-Address field value string
    
    Returns:
    
    HeaderLine object corresponding to what would have been read
  - addHeader
```
public HeaderLine addHeader(String fieldName,
                            Uri uriFieldValue,
                            String fieldValueStr)
```
    Add an URI header using the supplied string and object values and return a HeaderLine object corresponding to how the header would be read. If both string and object values are not null they are used as is. If the string value is null and the object is not null, the object's toString method is called. If the object is null and the string is not null, the string is parsed and validated resulting in an object, if valid.
    
    Parameters:
    
    fieldName - name of field to add
    
    uriFieldValue - URI field value object
    
    fieldValueStr - URI field value string
    
    Returns:
    
    HeaderLine object corresponding to what would have been read
  - addHeader
```
public HeaderLine addHeader(String fieldName,
                            String fieldValueStr,
                            int dt,
                            Integer integerFieldValue,
                            Long longFieldValue,
                            WarcDigest digestFieldValue,
                            ContentType contentTypeFieldValue,
                            Date dateFieldValue,
                            InetAddress inetAddrFieldValue,
                            Uri uriFieldValue)
```
    Add a header with the supplied field name, data type and value and return a HeaderLine corresponding to how the header will be read. The data type is validated against the field data type. The values used are the field value string and the parameter corresponding to the data type.
    
    Parameters:
    
    fieldName - header field name
    
    fieldValueStr - field value in string form
    
    dt - data type of the field value string when converted to an object
    
    integerFieldValue - Integer object field value
    
    longFieldValue - Long object field value
    
    digestFieldValue - Digest object field value
    
    contentTypeFieldValue - ContentType object field value
    
    dateFieldValue - Date object field value
    
    inetAddrFieldValue - InetAddress object field value
    
    uriFieldValue - URI object field value
    
    Returns:
    
    HeaderLine object corresponding to what would have been read
  - checkFields
```
protected void checkFields()
```
    Validate the WARC header relative to the WARC-Type and according to the WARC ISO standard.
  - checkFieldPolicy
```
protected void checkFieldPolicy(int recordType,
                                int fieldType,
                                Object fieldObj,
                                String valueStr)
```
    Given a WARC record type and a WARC field looks up the policy in a matrix build from the WARC ISO standard.
    
    Parameters:
    
    recordType - WARC record type id
    
    fieldType - WARC field type id
    
    fieldObj - WARC field
    
    valueStr - WARC raw field value

Class WarcHeader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

URI_LTGT

URI_NAKED

reader

diagnostics

warcTargetUriProfile

uriProfile

fieldParsers

warcDateFormat

startOffset

bMagicIdentified

bVersionParsed

bValidVersionFormat

bValidVersion

versionStr

versionArr

major

minor

seen

bMandatoryMissing

warcTypeStr

warcTypeIdx

warcFilename

warcRecordIdStr

warcRecordIdUri

warcDateStr

warcDate

contentLengthStr

contentLength

contentTypeStr

contentType

warcTruncatedStr

warcTruncatedIdx

warcIpAddress

warcInetAddress

warcConcurrentToList

warcRefersToStr

warcRefersToUri

warcTargetUriStr

warcTargetUriUri

warcWarcinfoIdStr

warcWarcinfoIdUri

warcBlockDigestStr

warcBlockDigest

warcPayloadDigestStr

warcPayloadDigest

warcIdentifiedPayloadTypeStr

warcIdentifiedPayloadType

warcProfileStr

warcProfileUri

warcProfileIdx

warcSegmentNumberStr

warcSegmentNumber

warcSegmentOriginIdStr

warcSegmentOriginIdUrl

warcSegmentTotalLengthStr

warcSegmentTotalLength

warcRefersToTargetUriStr

warcRefersToTargetUriUri

warcRefersToDateStr

warcRefersToDate

headerBytesOut

headerBytes

headerList

headerMap

Constructor Detail

WarcHeader

Method Detail

initHeader

initHeader

addErrorDiagnosis

addWarningDiagnosis

getStartOffset

parseHeader

parseVersion