Package com.github.bottomlessarchive.warc.service.record.domain

Enum WarcRecordType

java.lang.Object

java.lang.Enum<WarcRecordType>

com.github.bottomlessarchive.warc.service.record.domain.WarcRecordType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WarcRecordType>, java.lang.constant.Constable

public enum WarcRecordType
extends java.lang.Enum<WarcRecordType>

Describes the various types of WARC records.

See Also:

https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/#warc-type-mandatory

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTINUATION	Record blocks from 'continuation' records must be appended to corresponding prior record block(s) (e.g. from other WARC files) to create the logically complete full-sized original record.
CONVERSION	A 'conversion' record shall contain an alternative version of another record’s content that was created as the result of an archival process.
METADATA	A 'metadata' record contains content created in order to further describe, explain, or accompany a harvested resource, in ways not covered by other record types.
REQUEST	A 'request' record holds the details of a complete scheme-specific request, including network protocol information, where possible.
RESOURCE	A 'resource' record contains a resource, without full protocol response information.
RESPONSE	A 'response' record should contain a complete scheme-specific response, including network protocol information, where possible.
REVISIT	A 'revisit' record describes the revisitation of content already archived, and might include only an abbreviated content body which has to be interpreted relative to a previous record.
WARCINFO	A 'warcinfo' record describes the records that follow it, up through end of file, end of input, or until next 'warcinfo' record.

Method Summary

Modifier and Type	Method	Description
static WarcRecordType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static WarcRecordType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

WARCINFO

public static final WarcRecordType WARCINFO

A 'warcinfo' record describes the records that follow it, up through end of file, end of input, or until next 'warcinfo' record. Typically, this appears once and at the beginning of a WARC file. For a web archive, it often contains information about the web crawl which generated the following records.

See Also:

https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/#warcinfo

REQUEST

public static final WarcRecordType REQUEST

A 'request' record holds the details of a complete scheme-specific request, including network protocol information, where possible.

See Also:

https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/#request

RESPONSE

public static final WarcRecordType RESPONSE

A 'response' record should contain a complete scheme-specific response, including network protocol information, where possible.

See Also:

https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/#response

RESOURCE

public static final WarcRecordType RESOURCE

A 'resource' record contains a resource, without full protocol response information. For example: a file directly retrieved from a locally accessible repository or the result of a networked retrieval where the protocol information has been discarded.

See Also:

https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/#resource

METADATA

public static final WarcRecordType METADATA

A 'metadata' record contains content created in order to further describe, explain, or accompany a harvested resource, in ways not covered by other record types. A 'metadata' record will almost always refer to another record of another type, with that other record holding original harvested or transformed content. (However, it is allowable for a 'metadata' record to refer to any record type, including other 'metadata' records.) Any number of metadata records may reference another specific record.

See Also:

https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/#metadata

REVISIT

public static final WarcRecordType REVISIT

A 'revisit' record describes the revisitation of content already archived, and might include only an abbreviated content body which has to be interpreted relative to a previous record. Most typically, a 'revisit' record is used instead of a 'response' or 'resource' record to indicate that the content visited was either a complete or substantial duplicate of material previously archived.

See Also:

https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/#revisit

CONVERSION

public static final WarcRecordType CONVERSION

A 'conversion' record shall contain an alternative version of another record’s content that was created as the result of an archival process. Typically, this is used to hold content transformations that maintain viability of content after widely available rendering tools for the originally stored format disappear. As needed, the original content may be migrated (transformed) to a more viable format in order to keep the information usable with current tools while minimizing loss of information (intellectual content, look and feel, etc.). Any number of 'conversion' records may be created that reference a specific source record, which may itself contain transformed content. Each transformation should result in a freestanding, complete record, with no dependency on survival of the original record.

See Also:

https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/#conversion

CONTINUATION

public static final WarcRecordType CONTINUATION

Record blocks from 'continuation' records must be appended to corresponding prior record block(s) (e.g. from other WARC files) to create the logically complete full-sized original record. That is, 'continuation' records are used when a record that would otherwise cause a WARC file size to exceed a desired limit is broken into segments.

See Also:

https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/#continuation

Method Details

values

public static WarcRecordType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WarcRecordType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null