org.netpreserve.jwarc

Class WarcParser

java.lang.Object

org.netpreserve.jwarc.MessageParser

org.netpreserve.jwarc.WarcParser

public class WarcParser
extends MessageParser

Low-level WARC record parser.

Unless you're doing something advanced (like non-blocking IO) you should use the higher-level WarcReader class instead.

Constructor Summary

Constructors

Constructor and Description
WarcParser()

Method Summary

Modifier and Type	Method and Description
MessageHeaders	headers()
boolean	isError()
boolean	isFinished()
static WarcParser	newWarcFieldsParser()
void	parse(ByteBuffer data)
boolean	parse(ReadableByteChannel channel, ByteBuffer buffer)
long	position()
void	reset()
void	setLenient(boolean lenient) Sets the lenient mode for the WarcParser.
MessageVersion	version()

Methods inherited from class org.netpreserve.jwarc.MessageParser

emitWarning, getErrorContext, getErrorContext

Methods inherited from class java.lang.Object

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

Constructor Detail

WarcParser

public WarcParser()

Method Detail

newWarcFieldsParser

public static WarcParser newWarcFieldsParser()

reset

public void reset()

setLenient

public void setLenient(boolean lenient)

Sets the lenient mode for the WarcParser.

When enabled, this causes the parser to follow the specification less strictly, allowing reading of non-compliant records by:

• permitting ASCII control characters in header field names and values
• allowing lines to end with LF instead of CRLF
• permitting multi-digit WARC minor versions like "0.18"

Calling this method also resets the state of the parser.

isFinished

public boolean isFinished()

isError

public boolean isError()

parse

public void parse(ByteBuffer data)

parse

public boolean parse(ReadableByteChannel channel,
                     ByteBuffer buffer)
              throws IOException

Throws:

IOException

headers

public MessageHeaders headers()

version

public MessageVersion version()

position

public long position()