org.netpreserve.jwarc

Class WarcRecord

java.lang.Object

org.netpreserve.jwarc.Message

org.netpreserve.jwarc.WarcRecord

Direct Known Subclasses:

Warcinfo, WarcTargetRecord

public class WarcRecord
extends Message

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WarcRecord.AbstractBuilder<R extends WarcRecord,B extends WarcRecord.AbstractBuilder<R,B>>
static interface	WarcRecord.Constructor<R extends WarcRecord>

Method Summary

Modifier and Type	Method and Description
Optional<WarcDigest>	blockDigest() Digest created from "WARC-Block-Digest" header containing digest values that were calculated by applying hash functions to this content body during creation of the WARC file.
Optional<WarcDigest>	calculatedBlockDigest() Digest created while reading the WARC record body if the WARC reader is configured to calculate digests and a "WARC-Block-Digest" header is present, see WarcReader.calculateBlockDigest().
java.time.Instant	date() The instant that data capture for this record began.
URI	id() The globally unique identifier for this record.
Optional<Long>	segmentNumber() The current record's relative ordering in a sequence of segmented records.
String	toString()
WarcTruncationReason	truncated() The reason why this record was truncated or WarcTruncationReason.NOT_TRUNCATED.
String	type() The type of record.

Methods inherited from class org.netpreserve.jwarc.Message

body, contentType, headers, serializeHeader, version

Methods inherited from class java.lang.Object

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

Method Detail

type

public String type()

The type of record.

id

public URI id()

The globally unique identifier for this record.

date

public java.time.Instant date()

The instant that data capture for this record began.

truncated

public WarcTruncationReason truncated()

The reason why this record was truncated or WarcTruncationReason.NOT_TRUNCATED.

segmentNumber

public Optional<Long> segmentNumber()

The current record's relative ordering in a sequence of segmented records.

Mandatory for all records in the sequence starting from 1.

blockDigest

public Optional<WarcDigest> blockDigest()

Digest created from "WARC-Block-Digest" header containing digest values that were calculated by applying hash functions to this content body during creation of the WARC file.

calculatedBlockDigest

public Optional<WarcDigest> calculatedBlockDigest()
                                           throws IOException

Digest created while reading the WARC record body if the WARC reader is configured to calculate digests and a "WARC-Block-Digest" header is present, see WarcReader.calculateBlockDigest(). Note: Calling this method will consume the record body exhaustively, it should be called after the record block or payload has been processed.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object