Package org.microproxy.warc

Record Class WarcReader.Record

java.lang.Object

java.lang.Record

org.microproxy.warc.WarcReader.Record

Record Components:

version - the version, such as WARC/1.1

fields - the named fields, in order

block - the record's content block

Enclosing class:

WarcReader

public static record WarcReader.Record(String version, List<Map.Entry<String,String>> fields, byte[] block)
extends Record

One WARC record: its version line, named fields and block.

Constructor Summary

Constructors

Constructor	Description
Record(String version, List<Map.Entry<String,String>> fields, byte[] block)	Copies the fields.

Method Summary

Modifier and Type	Method	Description
byte[]	block()	Returns the value of the block record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	field(String name)	The first value of a named field, compared without regard to case.
List<Map.Entry<String,String>>	fields()	Returns the value of the fields record component.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the record id (WARC-Record-ID), or null.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the record type (WARC-Type), such as response; empty if missing.
String	version()	Returns the value of the version record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Record

public Record(String version,
 List<Map.Entry<String,String>> fields,
 byte[] block)

Copies the fields.

Method Details

field

public String field(String name)

The first value of a named field, compared without regard to case.

Parameters:

name - the field name, such as WARC-Target-URI

Returns:

the value, or null if the record has no such field

type

public String type()

Returns the record type (WARC-Type), such as response; empty if missing.

Returns:

the record type (WARC-Type), such as response; empty if missing

id

public String id()

Returns the record id (WARC-Record-ID), or null.

Returns:

the record id (WARC-Record-ID), or null

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

version

public String version()

Returns the value of the version record component.

Returns:

the value of the version record component

fields

public List<Map.Entry<String,String>> fields()

Returns the value of the fields record component.

Returns:

the value of the fields record component

block

public byte[] block()

Returns the value of the block record component.

Returns:

the value of the block record component