- ACTIVE_SUFFIX - Static variable in class org.jwat.arc.ArcFileWriter
-
Suffix used for open files.
- addErrorDiagnosis(DiagnosisType, String, String...) - Method in class org.jwat.arc.ArcRecordBase
-
Add an error diagnosis of the given type on a specific entity with
optional extra information.
- addInvalidExpectedError(String, String...) - Method in class org.jwat.arc.ArcFieldParsers
-
Add an error diagnosis on the given entity stating that it is invalid
and something else was expected.
- addRequiredMissingError(String) - Method in class org.jwat.arc.ArcFieldParsers
-
Add an error diagnosis on the given entity stating that it is required
but is missing.
- ARC_DATE_FORMAT - Static variable in class org.jwat.arc.ArcConstants
-
ARC date format string as specified in the ARC documentation.
- ARC_FILE - Static variable in class org.jwat.arc.ArcConstants
-
Invalid ARC file property.
- ARC_MAGIC_HEADER - Static variable in class org.jwat.arc.ArcConstants
-
An ARC version block starts with this string.
- ARC_RECORD - Static variable in class org.jwat.arc.ArcConstants
-
Invalid ARC record property.
- ARC_RECORD_TRAILING_NEWLINES - Static variable in class org.jwat.arc.ArcConstants
-
Trailing newlines after each record as per the ARC documentation.
- ARC_SCHEME - Static variable in class org.jwat.arc.ArcConstants
-
Arc file URL URI scheme.
- ARC_VB_MAX_TRAILING_NEWLINES - Static variable in class org.jwat.arc.ArcConstants
-
Maximum payload size in bytes of unwanted trailing new lines in
V1.0/V2.0 version block.
- ARC_VERSION_BLOCK - Static variable in class org.jwat.arc.ArcConstants
-
Invalid ARC version block property.
- ArcConstants - Class in org.jwat.arc
-
Class containing all relevant ARC constants and structures.
- ArcConstants() - Constructor for class org.jwat.arc.ArcConstants
-
No constructor for this utility class, static access only.
- ArcDateParser - Class in org.jwat.arc
-
ARC Date parser and format validator ("yyyyMMddHHmmss").
- ArcFieldParsers - Class in org.jwat.arc
-
Separate class containing all the different types of field parser.
- ArcFieldParsers() - Constructor for class org.jwat.arc.ArcFieldParsers
-
- arcFileConfig - Variable in class org.jwat.arc.ArcFileWriter
-
Overall ARC file writer configuration.
- ArcFileNaming - Interface in org.jwat.arc
-
Implementations of this interface are used to name the ARC files written by the ArcFileWriter.
- arcFileNaming - Variable in class org.jwat.arc.ArcFileWriter
-
ARC file naming Configuration.
- ArcFileNamingDefault - Class in org.jwat.arc
-
Default ARC file naming implementation used for writing to multiple files.
- ArcFileNamingDefault(String, Date, String, String) - Constructor for class org.jwat.arc.ArcFileNamingDefault
-
Construct file naming instance.
- ArcFileNamingSingleFile - Class in org.jwat.arc
-
Simple ARC file naming implementation used for writing to a single file only.
- ArcFileNamingSingleFile(String) - Constructor for class org.jwat.arc.ArcFileNamingSingleFile
-
Construct a new instance with the filename to return.
- ArcFileNamingSingleFile(File) - Constructor for class org.jwat.arc.ArcFileNamingSingleFile
-
Construct a new instance with the file whose filename to return.
- ArcFileWriter - Class in org.jwat.arc
-
Simple ARC file writer wrapping some of the trivial code related to writing records.
- ArcFileWriter() - Constructor for class org.jwat.arc.ArcFileWriter
-
Constructor for internal and unit test use.
- ArcFileWriterConfig - Class in org.jwat.arc
-
General configuration of ArcFileWriter.
- ArcFileWriterConfig() - Constructor for class org.jwat.arc.ArcFileWriterConfig
-
Construct instance with largely default values, except the targetDir which is null.
- ArcFileWriterConfig(File, boolean, long, boolean) - Constructor for class org.jwat.arc.ArcFileWriterConfig
-
Construct an instance with custom values.
- ArcHeader - Class in org.jwat.arc
-
Class for parsing and validating the common ARC record header present in
both ARC records and ARC version blocks.
- ArcHeader() - Constructor for class org.jwat.arc.ArcHeader
-
Non public constructor to allow unit testing.
- archiveDate - Variable in class org.jwat.arc.ArcHeader
-
Archive date validated and converted to a Date object.
- archiveDateStr - Variable in class org.jwat.arc.ArcHeader
-
ARC record archive-date field string value.
- archiveLength - Variable in class org.jwat.arc.ArcHeader
-
Archive-length validated and converted into a Long object.
- archiveLengthStr - Variable in class org.jwat.arc.ArcHeader
-
ARC record archive-length field string value.
- arcParsedRecordHeader(ArcReader, long, ArcHeader) - Method in interface org.jwat.arc.ArcRecordParserCallback
-
- ArcReader - Class in org.jwat.arc
-
ARC Reader base class.
- ArcReader() - Constructor for class org.jwat.arc.ArcReader
-
- ArcReaderCompressed - Class in org.jwat.arc
-
ARC Reader implementation for reading GZip compressed files.
- ArcReaderCompressed() - Constructor for class org.jwat.arc.ArcReaderCompressed
-
This constructor is used to get random access to records.
- ArcReaderCompressed(GzipReader) - Constructor for class org.jwat.arc.ArcReaderCompressed
-
Construct reader using the supplied input stream.
- ArcReaderCompressed(GzipReader, int) - Constructor for class org.jwat.arc.ArcReaderCompressed
-
Construct object using supplied GzipInputStream.
- ArcReaderFactory - Class in org.jwat.arc
-
Factory used for creating ArcReader instances.
- ArcReaderFactory() - Constructor for class org.jwat.arc.ArcReaderFactory
-
Private constructor to enforce factory methods.
- ArcReaderUncompressed - Class in org.jwat.arc
-
ARC Reader implementation for reading uncompressed files.
- ArcReaderUncompressed() - Constructor for class org.jwat.arc.ArcReaderUncompressed
-
This constructor is used to get random access to records.
- ArcReaderUncompressed(ByteCountingPushBackInputStream) - Constructor for class org.jwat.arc.ArcReaderUncompressed
-
Construct reader using the supplied input stream.
- ArcRecord - Class in org.jwat.arc
-
This class represents an ARC record and header including possible
validation and format warnings/errors encountered in the process.
- ArcRecord() - Constructor for class org.jwat.arc.ArcRecord
-
Protected constructor to force instantiation of record header
from stream.
- ArcRecordBase - Class in org.jwat.arc
-
This abstract class represents the common base ARC data which is present in
both a record or version block.
- ArcRecordBase() - Constructor for class org.jwat.arc.ArcRecordBase
-
- ArcRecordParserCallback - Interface in org.jwat.arc
-
- arcRecordType - Variable in enum org.jwat.arc.ArcVersion
-
Arc record field type.
- ArcVersion - Enum in org.jwat.arc
-
Supported ARC file versions.
- ArcVersionBlock - Class in org.jwat.arc
-
This class represents an ARC version block and header including possible
validation and format warnings/errors encountered in the process.
- ArcVersionBlock() - Constructor for class org.jwat.arc.ArcVersionBlock
-
Protected constructor to force instantiation of version block
from stream.
- ArcVersionHeader - Class in org.jwat.arc
-
This class can be used to post process a payload object to parse and
validate a suspected ARC version block header.
- ArcVersionHeader() - Constructor for class org.jwat.arc.ArcVersionHeader
-
- ArcWriter - Class in org.jwat.arc
-
Base class for ARC writer implementations.
- ArcWriter() - Constructor for class org.jwat.arc.ArcWriter
-
- ArcWriterCompressed - Class in org.jwat.arc
-
ARC Writer implementation for writing GZip compressed files.
- ArcWriterFactory - Class in org.jwat.arc
-
Factory used for creating ArcWriter instances.
- ArcWriterFactory() - Constructor for class org.jwat.arc.ArcWriterFactory
-
Private constructor to enforce factory methods.
- ArcWriterUncompressed - Class in org.jwat.arc
-
ARC Writer implementation for writing uncompressed files.
- arpCallback - Variable in class org.jwat.arc.ArcReader
-
Callback used to monitor and modify internal data as it is being parsed.
- bBlockDigest - Variable in class org.jwat.arc.ArcReader
-
Block Digest enabled/disabled.
- bClosed - Variable in class org.jwat.arc.ArcRecordBase
-
Has record been closed flag.
- bCompression - Variable in class org.jwat.arc.ArcFileWriterConfig
-
Compress archive(s).
- bExceptionOnContentLengthMismatch - Variable in class org.jwat.arc.ArcWriter
-
Configuration for throwing exception on content-length mismatch.
- bHasPseudoEmptyPayload - Variable in class org.jwat.arc.ArcRecordBase
-
Has all the payload data been processed while reading the record header.
- bIsCompliant - Variable in class org.jwat.arc.ArcReader
-
Compliance status for records parsed up to now.
- bIsCompliant - Variable in class org.jwat.arc.ArcRecordBase
-
Is this record compliant ie.
- blockDesc - Variable in class org.jwat.arc.ArcVersionHeader
-
Block description line.
- blockDescVersion - Variable in class org.jwat.arc.ArcVersionHeader
-
Version of the block description.
- blockDigestAlgorithm - Variable in class org.jwat.arc.ArcReader
-
Optional block digest algorithm to use.
- blockDigestEncoding - Variable in class org.jwat.arc.ArcReader
-
Encoding scheme used to encode block digest into a string.
- bOverwrite - Variable in class org.jwat.arc.ArcFileWriterConfig
-
Overwrite existing file(s).
- bPayloadClosed - Variable in class org.jwat.arc.ArcRecordBase
-
Has payload been closed before.
- bPayloadDigest - Variable in class org.jwat.arc.ArcReader
-
Payload Digest enabled/disabled.
- bStrict - Variable in class org.jwat.arc.ArcReader
-
Strict mode enabled or disabled.
- bufferSize - Variable in class org.jwat.arc.ArcReaderCompressed
-
Buffer size, if any, to use on GZip entry InputStream.
- bValidVersionFormat - Variable in class org.jwat.arc.ArcVersionHeader
-
Is the version format valid.
- checksumStr - Variable in class org.jwat.arc.ArcHeader
-
ARC record checksum field string value.
- close() - Method in class org.jwat.arc.ArcFileWriter
-
Close writer and release all resources.
- close() - Method in class org.jwat.arc.ArcReader
-
Close current record resource(s) and input stream(s).
- close() - Method in class org.jwat.arc.ArcReaderCompressed
-
- close() - Method in class org.jwat.arc.ArcReaderUncompressed
-
- close() - Method in class org.jwat.arc.ArcRecordBase
-
Close resources associated with the ARC record.
- close() - Method in class org.jwat.arc.ArcWriter
-
Close ARC writer and free its resources.
- close() - Method in class org.jwat.arc.ArcWriterCompressed
-
- close() - Method in class org.jwat.arc.ArcWriterUncompressed
-
- closeRecord() - Method in class org.jwat.arc.ArcWriter
-
Close the ARC record in an implementation specific way.
- closeRecord() - Method in class org.jwat.arc.ArcWriterCompressed
-
- closeRecord() - Method in class org.jwat.arc.ArcWriterUncompressed
-
- closeRecord_impl() - Method in class org.jwat.arc.ArcWriter
-
Closes the ARC record by writing one newline and comparing the amount of
payload data streamed with the content-length supplied with the header.
- computedBlockDigest - Variable in class org.jwat.arc.ArcRecordBase
-
Computed block digest.
- computedPayloadDigest - Variable in class org.jwat.arc.ArcRecordBase
-
Computed payload digest.
- consumed - Variable in class org.jwat.arc.ArcReader
-
Number of bytes consumed by this reader.
- consumed - Variable in class org.jwat.arc.ArcRecordBase
-
Uncompressed bytes consumed while validating this record.
- CONTENT_TYPE_FORMAT - Static variable in class org.jwat.arc.ArcConstants
-
Content-type format string as specified in RFC2616.
- CONTENT_TYPE_NO_TYPE - Static variable in class org.jwat.arc.ArcConstants
-
Special content-type for none.
- CONTENT_TYPE_TEXT_PLAIN - Static variable in class org.jwat.arc.ArcConstants
-
Text plain content type.
- contentType - Variable in class org.jwat.arc.ArcHeader
-
Content-Type wrapper object with optional parameters.
- contentTypeStr - Variable in class org.jwat.arc.ArcHeader
-
ARC record content-type field string value.
- create(ArcVersion, String) - Static method in class org.jwat.arc.ArcVersionHeader
-
Create a version header and initialize it using the version and origin
code arguments.
- createRecord(ArcWriter) - Static method in class org.jwat.arc.ArcRecord
-
Create and initialize a new ArcRecord for writing.
- createRecord(ArcWriter) - Static method in class org.jwat.arc.ArcVersionBlock
-
Create and initialize a new ArcVersionBlock for writing.
- currentEntry - Variable in class org.jwat.arc.ArcReaderCompressed
-
GZip entry for the current record, if random access methods used.
- currentReader - Variable in class org.jwat.arc.ArcReaderCompressed
-
GZip reader used for the current record, if random access methods used.
- currentRecord - Variable in class org.jwat.arc.ArcReader
-
Current record of either kind.
- getArchiveDate() - Method in class org.jwat.arc.ArcRecordBase
-
ArchiveDate getter.
- getArchiveDateStr() - Method in class org.jwat.arc.ArcRecordBase
-
Raw ArchiveDate getter.
- getArchiveLength() - Method in class org.jwat.arc.ArcRecordBase
-
Length getter.
- getArchiveLengthStr() - Method in class org.jwat.arc.ArcRecordBase
-
Raw Length getter.
- getArcRecordParserCallback() - Method in class org.jwat.arc.ArcReader
-
- getArcWriterInstance(ArcFileNaming, ArcFileWriterConfig) - Static method in class org.jwat.arc.ArcFileWriter
-
Returns a configured ARC file writer.
- getBlockDigestAlgorithm() - Method in class org.jwat.arc.ArcReader
-
Get the optional block digest algorithm.
- getBlockDigestEnabled() - Method in class org.jwat.arc.ArcReader
-
Get the readers block digest on/off status.
- getBlockDigestEncoding() - Method in class org.jwat.arc.ArcReader
-
Get the optional block digest encoding scheme.
- getChecksum() - Method in class org.jwat.arc.ArcRecordBase
-
Checksum getter.
- getConsumed() - Method in class org.jwat.arc.ArcReader
-
Get number of bytes consumed by this reader.
- getConsumed() - Method in class org.jwat.arc.ArcReaderCompressed
-
Get number of bytes consumed by the ARC GzipReader.
- getConsumed() - Method in class org.jwat.arc.ArcReaderUncompressed
-
- getConsumed() - Method in class org.jwat.arc.ArcRecordBase
-
Return number of uncompressed bytes consumed validating this record.
- getContentType() - Method in class org.jwat.arc.ArcRecordBase
-
Content-Type getter.
- getContentTypeStr() - Method in class org.jwat.arc.ArcRecordBase
-
Raw Content-Type getter.
- getDate(String) - Static method in class org.jwat.arc.ArcDateParser
-
Parses the date using the format yyyyMMddHHmmss.
- getDateFormat() - Static method in class org.jwat.arc.ArcDateParser
-
Return a DateFormat object which can be used to string
format ARC dates.
- getFile() - Method in class org.jwat.arc.ArcFileWriter
-
Returns the current ARC file object.
- getFilename(int, boolean) - Method in interface org.jwat.arc.ArcFileNaming
-
Return the next file name to use.
- getFilename(int, boolean) - Method in class org.jwat.arc.ArcFileNamingDefault
-
- getFilename(int, boolean) - Method in class org.jwat.arc.ArcFileNamingSingleFile
-
Just returns the filename used to construct this object.
- getFileName() - Method in class org.jwat.arc.ArcRecordBase
-
FileName getter.
- getHttpHeader() - Method in class org.jwat.arc.ArcRecordBase
-
Returns the HttpHeader object if identified in the payload,
or null.
- getInetAddress() - Method in class org.jwat.arc.ArcRecordBase
-
inetAddress getter.
- getIpAddress() - Method in class org.jwat.arc.ArcRecordBase
-
IpAddress getter.
- getIteratorExceptionThrown() - Method in class org.jwat.arc.ArcReader
-
Gets an exception thrown in the iterator if any or null.
- getLocation() - Method in class org.jwat.arc.ArcRecordBase
-
Location getter.
- getNextRecord() - Method in class org.jwat.arc.ArcReader
-
Parses and gets the next ARC record.
- getNextRecord() - Method in class org.jwat.arc.ArcReaderCompressed
-
- getNextRecord() - Method in class org.jwat.arc.ArcReaderUncompressed
-
- getNextRecordFrom(InputStream, long) - Method in class org.jwat.arc.ArcReader
-
Parses and gets the next ARC record.
- getNextRecordFrom(InputStream, long, int) - Method in class org.jwat.arc.ArcReader
-
Parses and gets the next ARC record.
- getNextRecordFrom(InputStream, long) - Method in class org.jwat.arc.ArcReaderCompressed
-
- getNextRecordFrom(InputStream, long, int) - Method in class org.jwat.arc.ArcReaderCompressed
-
- getNextRecordFrom(InputStream, long) - Method in class org.jwat.arc.ArcReaderUncompressed
-
- getNextRecordFrom(InputStream, long, int) - Method in class org.jwat.arc.ArcReaderUncompressed
-
- getOffset() - Method in class org.jwat.arc.ArcReader
-
Get the current offset in the ARC InputStream.
- getOffset() - Method in class org.jwat.arc.ArcReaderCompressed
-
Get the current offset in the ARC GzipReader.
- getOffset() - Method in class org.jwat.arc.ArcReaderUncompressed
-
- getOffset() - Method in class org.jwat.arc.ArcRecordBase
-
Offset getter.
- getOffsetStr() - Method in class org.jwat.arc.ArcRecordBase
-
Raw Offset getter.
- getPayload() - Method in class org.jwat.arc.ArcRecordBase
-
Return Payload object.
- getPayloadContent() - Method in class org.jwat.arc.ArcRecordBase
-
Payload content InputStream getter.
- getPayloadDigestAlgorithm() - Method in class org.jwat.arc.ArcReader
-
Get the optional payload digest algorithm.
- getPayloadDigestEnabled() - Method in class org.jwat.arc.ArcReader
-
Get the readers payload digest on/off status.
- getPayloadDigestEncoding() - Method in class org.jwat.arc.ArcReader
-
Get the optional payload digest encoding scheme.
- getPayloadHeaderMaxSize() - Method in class org.jwat.arc.ArcReader
-
Get the max size allowed for a payload header.
- getReader(InputStream, int) - Static method in class org.jwat.arc.ArcReaderFactory
-
Creates a new ArcReader from an InputStream
wrapped by a BufferedInputStream.
- getReader(InputStream) - Static method in class org.jwat.arc.ArcReaderFactory
-
Creates a new ArcReader from an InputStream.
- getReaderCompressed() - Static method in class org.jwat.arc.ArcReaderFactory
-
Creates a new ArcReader without any associated
InputStream for random access to GZip compressed records.
- getReaderCompressed(InputStream) - Static method in class org.jwat.arc.ArcReaderFactory
-
Creates a new ArcReader from an InputStream
primarily for random access to GZip compressed records.
- getReaderCompressed(InputStream, int) - Static method in class org.jwat.arc.ArcReaderFactory
-
Creates a new ArcReader from an InputStream
wrapped by a BufferedInputStream primarily for random
access to GZip compressed records.
- getReaderUncompressed() - Static method in class org.jwat.arc.ArcReaderFactory
-
Creates a new ArcReader without any associated
InputStream for random access to uncompressed records.
- getReaderUncompressed(InputStream) - Static method in class org.jwat.arc.ArcReaderFactory
-
Creates a new ArcReader from an InputStream
primarily for random access to uncompressed records.
- getReaderUncompressed(InputStream, int) - Static method in class org.jwat.arc.ArcReaderFactory
-
Creates a new ArcReader from an InputStream
wrapped by a BufferedInputStream primarily for random
access to uncompressed records.
- getRecordHeaderMaxSize() - Method in class org.jwat.arc.ArcReader
-
Get the max size allowed for a record header.
- getResultCode() - Method in class org.jwat.arc.ArcRecordBase
-
Result-Code getter.
- getResultCodeStr() - Method in class org.jwat.arc.ArcRecordBase
-
Raw Result-Code getter.
- getScheme() - Method in class org.jwat.arc.ArcRecordBase
-
Protocol getter.
- getSequenceNr() - Method in class org.jwat.arc.ArcFileWriter
-
Returns the current sequence number.
- getStartOffset() - Method in class org.jwat.arc.ArcHeader
-
Returns the starting offset of the record in the containing ARC.
- getStartOffset() - Method in class org.jwat.arc.ArcReader
-
Get the offset of the current ARC record or -1 if none have been read.
- getStartOffset() - Method in class org.jwat.arc.ArcReaderCompressed
-
Get the offset of the current ARC record from the GZip entry or -1 if
no records have been read yet.
- getStartOffset() - Method in class org.jwat.arc.ArcReaderUncompressed
-
- getStartOffset() - Method in class org.jwat.arc.ArcRecordBase
-
Returns the parsing start offset of the record in the containing ARC.
- getUriProfile() - Method in class org.jwat.arc.ArcReader
-
Get the URI profile used to validate URL URIs.
- getUrl() - Method in class org.jwat.arc.ArcRecordBase
-
URL getter.
- getUrlStr() - Method in class org.jwat.arc.ArcRecordBase
-
Raw URL getter.
- getVersion() - Method in class org.jwat.arc.ArcRecordBase
-
Version getter.
- getWriter() - Method in class org.jwat.arc.ArcFileWriter
-
Returns the current ARC writer object.
- getWriter(OutputStream, boolean) - Static method in class org.jwat.arc.ArcWriterFactory
-
Creates a new unbuffered ArcWriter from an
OutputStream.
- getWriter(OutputStream, int, boolean) - Static method in class org.jwat.arc.ArcWriterFactory
-
Creates a new buffered ArcWriter from an
OutputStream.
- getWriterCompressed(OutputStream) - Static method in class org.jwat.arc.ArcWriterFactory
-
Creates a new unbuffered compressing ArcWriter from an
OutputStream.
- getWriterCompressed(OutputStream, int) - Static method in class org.jwat.arc.ArcWriterFactory
-
Creates a new buffered compressing ArcWriter from an
OutputStream.
- getWriterUncompressed(OutputStream) - Static method in class org.jwat.arc.ArcWriterFactory
-
Creates a new unbuffered non compressing ArcWriter from an
OutputStream.
- getWriterUncompressed(OutputStream, int) - Static method in class org.jwat.arc.ArcWriterFactory
-
Creates a new buffered non compressing ArcWriter from an
OutputStream.
- in - Variable in class org.jwat.arc.ArcReaderUncompressed
-
ARC file ByteCountingPushBackInputStream.
- in - Variable in class org.jwat.arc.ArcRecordBase
-
Input stream used to read this record.
- inetAddress - Variable in class org.jwat.arc.ArcHeader
-
IP-Address validated and converted to an InetAddress object.
- init() - Method in class org.jwat.arc.ArcReader
-
Method used to initialize a readers internal state.
- init() - Method in class org.jwat.arc.ArcWriter
-
Method used to initialize a readers internal state.
- initHeader(ArcFieldParsers, UriProfile, Diagnostics<Diagnosis>) - Static method in class org.jwat.arc.ArcHeader
-
Create a new ArcHeader for recreating a header object.
- initHeader(ArcWriter, Diagnostics<Diagnosis>) - Static method in class org.jwat.arc.ArcHeader
-
Create and initialize a new ArcHeader for writing.
- initHeader(ArcReader, long, Diagnostics<Diagnosis>) - Static method in class org.jwat.arc.ArcHeader
-
Create and initialize a new ArcHeader for reading.
- ipAddressStr - Variable in class org.jwat.arc.ArcHeader
-
ARC record IP-Address field string value.
- isArcFile(ByteCountingPushBackInputStream) - Static method in class org.jwat.arc.ArcReaderFactory
-
Check head of PushBackInputStream for an ARC file identifier.
- isArcRecord(ByteCountingPushBackInputStream) - Static method in class org.jwat.arc.ArcReaderFactory
-
Check head of PushBackInputStream for an ARC record identifier.
- isClosed() - Method in class org.jwat.arc.ArcRecordBase
-
Check to see if the record has been closed.
- isCompliant() - Method in class org.jwat.arc.ArcReader
-
Returns a boolean indicating whether the reader has only parsed
compliant records up to now.
- isCompliant() - Method in class org.jwat.arc.ArcRecordBase
-
Returns a boolean indicating the standard compliance of this record.
- isCompressed() - Method in class org.jwat.arc.ArcReader
-
Is this reader assuming GZip compressed input.
- isCompressed() - Method in class org.jwat.arc.ArcReaderCompressed
-
- isCompressed() - Method in class org.jwat.arc.ArcReaderUncompressed
-
- isCompressed() - Method in class org.jwat.arc.ArcWriter
-
Is this writer producing compressed output.
- isCompressed() - Method in class org.jwat.arc.ArcWriterCompressed
-
- isCompressed() - Method in class org.jwat.arc.ArcWriterUncompressed
-
- isStrict() - Method in class org.jwat.arc.ArcReader
-
Get the readers strict mode setting.
- isValidBlockdDesc - Variable in class org.jwat.arc.ArcVersionHeader
-
Did we recognize the block description line.
- isValidStreamOfCRLF(InputStream) - Method in class org.jwat.arc.ArcRecordBase
-
Parses the remaining input stream and validates that the characters
encountered are equal to LF or CR.
- isVersionValid - Variable in class org.jwat.arc.ArcVersionHeader
-
Did we find a valid version number.
- iterator() - Method in class org.jwat.arc.ArcReader
-
Returns an Iterator over the records as they are being
parsed.
- iteratorExceptionThrown - Variable in class org.jwat.arc.ArcReader
-
Exception thrown while using the iterator.
- parseArcRecord(ArcReader, Diagnostics<Diagnosis>, ArcHeader, ByteCountingPushBackInputStream) - Static method in class org.jwat.arc.ArcRecord
-
Creates a new ArcRecord based on the supplied header and
starts processing the payload, if present.
- parseContentType(String, String, boolean) - Method in class org.jwat.arc.ArcFieldParsers
-
Parse and validate a content type.
- parseDate(String, String, boolean) - Method in class org.jwat.arc.ArcFieldParsers
-
Parses ARC record date.
- parseHeader(ByteCountingPushBackInputStream) - Method in class org.jwat.arc.ArcHeader
-
Tries to read lines from the input stream to determine if they could
be possible ARC record header lines.
- parseHeaders(String[]) - Method in class org.jwat.arc.ArcHeader
-
Examines an array of strings to determine if it could be an ARC record
header.
- parseInteger(String, String, boolean) - Method in class org.jwat.arc.ArcFieldParsers
-
Returns an Integer object holding the value of the specified string.
- parseIpAddress(String, String, boolean) - Method in class org.jwat.arc.ArcFieldParsers
-
Parse and validate an IP address.
- parseLong(String, String, boolean) - Method in class org.jwat.arc.ArcFieldParsers
-
Returns a Long object holding the value of the specified string.
- parseRecord(ByteCountingPushBackInputStream, ArcReader) - Static method in class org.jwat.arc.ArcRecordBase
-
Reads from the input stream and tries to parse and identify an
ArcRecord or ArcVersionBlock record.
- parseString(String, String, boolean) - Method in class org.jwat.arc.ArcFieldParsers
-
Validates that the string is not null but only if nullable is false.
- parseUri(String, UriProfile, String, boolean) - Method in class org.jwat.arc.ArcFieldParsers
-
Returns an URL object holding the value of the specified string.
- parseVersionBlock(ArcReader, Diagnostics<Diagnosis>, ArcHeader, ArcFieldParsers, ByteCountingPushBackInputStream) - Static method in class org.jwat.arc.ArcVersionBlock
-
Creates a new VersionBlock based on the supplied header and
the version block in the payload, if present.
- payload - Variable in class org.jwat.arc.ArcRecordBase
-
Payload object if any exists.
- payloadClosed() - Method in class org.jwat.arc.ArcRecordBase
-
Called when the payload object is closed and final steps in the
validation process can be performed.
- payloadDigestAlgorithm - Variable in class org.jwat.arc.ArcReader
-
Optional payload digest algorithm to use.
- payloadDigestEncoding - Variable in class org.jwat.arc.ArcReader
-
Encoding scheme used to encode payload digest into a string.
- payloadHeaderMaxSize - Variable in class org.jwat.arc.ArcReader
-
Max size allowed for a payload header.
- payloadWrittenTotal - Variable in class org.jwat.arc.ArcWriter
-
Total bytes written for current record payload.
- processPayload(ByteCountingPushBackInputStream, ArcReader) - Method in class org.jwat.arc.ArcRecord
-
- processPayload(ByteCountingPushBackInputStream, ArcReader) - Method in class org.jwat.arc.ArcRecordBase
-
Process the ARC record stream for possible payload data.
- processPayload(ByteCountingPushBackInputStream, ArcReader) - Method in class org.jwat.arc.ArcVersionBlock
-
An ARC version block payload must include a version line and a
block description line and in v1.1 the rest of the payload consists
of XML formatted metadata related to the harvesters configuration.
- processPayload(ByteCountingPushBackInputStream, long, String, ArcFieldParsers, Diagnostics<Diagnosis>) - Static method in class org.jwat.arc.ArcVersionHeader
-
Method called to parse and validate an ARC version block.
- PUSHBACK_BUFFER_SIZE - Static variable in class org.jwat.arc.ArcReaderCompressed
-
Buffer size used by PushbackInputStream.
- PUSHBACK_BUFFER_SIZE - Static variable in class org.jwat.arc.ArcReaderFactory
-
Buffer size used by PushbackInputStream.
- PUSHBACK_BUFFER_SIZE - Static variable in class org.jwat.arc.ArcReaderUncompressed
-
Buffer size used by PushbackInputStream.
- PUSHBACK_BUFFER_SIZE - Static variable in class org.jwat.arc.ArcVersionHeader
-
Buffer size used by PushbackInputStream.
- reader - Variable in class org.jwat.arc.ArcHeader
-
Associated WarcReader context.
- reader - Variable in class org.jwat.arc.ArcReaderCompressed
-
ARC file GzipInputStream.
- reader - Variable in class org.jwat.arc.ArcRecordBase
-
Reader instance used, required for file compliance.
- readHeader(MaxLengthRecordingInputStream, long) - Method in class org.jwat.arc.ArcVersionHeader
-
- rebuild() - Method in class org.jwat.arc.ArcVersionHeader
-
Use the information contained in this object to rebuild the byte array
representation of the version header.
- recordClosed() - Method in class org.jwat.arc.ArcReader
-
Callback method called when the payload has been processed.
- recordClosed() - Method in class org.jwat.arc.ArcReaderCompressed
-
- recordClosed() - Method in class org.jwat.arc.ArcReaderUncompressed
-
- recordFieldVersion - Variable in class org.jwat.arc.ArcHeader
-
Which version of the record fields was parsed, 1.x or 2.0.
- recordHeaderMaxSize - Variable in class org.jwat.arc.ArcReader
-
Max size allowed for a record header.
- records - Variable in class org.jwat.arc.ArcReader
-
Records parsed.
- recordType - Variable in class org.jwat.arc.ArcRecordBase
-
Record type, version block or arc record.
- reserved - Variable in class org.jwat.arc.ArcVersionHeader
-
Reserved field value, used for version 1.1.
- reservedStr - Variable in class org.jwat.arc.ArcVersionHeader
-
Reserved field value string, used for version 1.1.
- reset() - Method in class org.jwat.arc.ArcReader
-
Reset reader for reuse.
- resultCode - Variable in class org.jwat.arc.ArcHeader
-
Result-code validated and converted into an Integer object.
- resultCodeStr - Variable in class org.jwat.arc.ArcHeader
-
ARC record result-code field string value.
- RT_ARC_RECORD - Static variable in class org.jwat.arc.ArcRecordBase
-
Arc record record type.
- RT_VERSION_BLOCK - Static variable in class org.jwat.arc.ArcRecordBase
-
Version block record type.
- S_HEADER_WRITTEN - Static variable in class org.jwat.arc.ArcWriter
-
State after header has been written.
- S_INIT - Static variable in class org.jwat.arc.ArcWriter
-
State after writer has been constructed and before records have been written.
- S_PAYLOAD_WRITTEN - Static variable in class org.jwat.arc.ArcWriter
-
State after payload has been written.
- S_RECORD_CLOSED - Static variable in class org.jwat.arc.ArcWriter
-
State after record has been closed.
- sequenceNr - Variable in class org.jwat.arc.ArcFileWriter
-
Current sequence number.
- setArcRecordParserCallback(ArcRecordParserCallback) - Method in class org.jwat.arc.ArcReader
-
- setBlockDigestAlgorithm(String) - Method in class org.jwat.arc.ArcReader
-
Tries to set the optional block digest algorithm and returns a boolean
indicating whether the algorithm was accepted or not.
- setBlockDigestEnabled(boolean) - Method in class org.jwat.arc.ArcReader
-
Set the readers block digest on/off status.
- setBlockDigestEncoding(String) - Method in class org.jwat.arc.ArcReader
-
Set the optional block digest encoding scheme.
- setExceptionOnContentLengthMismatch(boolean) - Method in class org.jwat.arc.ArcWriter
-
Tell the writer what to do in case of mismatch between content-length
and amount payload written.
- setPayloadDigestAlgorithm(String) - Method in class org.jwat.arc.ArcReader
-
Tries to set the optional payload digest algorithm and returns a boolean
indicating whether the algorithm was accepted or not.
- setPayloadDigestEnabled(boolean) - Method in class org.jwat.arc.ArcReader
-
Set the readers payload digest on/off status.
- setPayloadDigestEncoding(String) - Method in class org.jwat.arc.ArcReader
-
Set the optional payload digest encoding scheme.
- setPayloadHeaderMaxSize(int) - Method in class org.jwat.arc.ArcReader
-
Set the max size allowed for a payload header.
- setRecordHeaderMaxSize(int) - Method in class org.jwat.arc.ArcReader
-
Set the max size allowed for a record header.
- setStrict(boolean) - Method in class org.jwat.arc.ArcReader
-
Set the readers strict mode on/off.
- setUriProfile(UriProfile) - Method in class org.jwat.arc.ArcReader
-
Set the URI profile used to validate URL URIs.
- startOffset - Variable in class org.jwat.arc.ArcHeader
-
ARC record starting offset relative to the source ARC file input
stream.
- startOffset - Variable in class org.jwat.arc.ArcReaderCompressed
-
Cached start offset used after the reader is closed.
- startOffset - Variable in class org.jwat.arc.ArcReaderUncompressed
-
Start offset of current or next valid record.
- startOffset - Variable in class org.jwat.arc.ArcRecordBase
-
ARC record parsing start offset relative to the source ARC file input
stream.
- state - Variable in class org.jwat.arc.ArcWriter
-
Current state of writer.
- stream_copy_buffer - Variable in class org.jwat.arc.ArcWriter
-
Buffer used by streamPayload() to copy from one stream to another.
- streamPayload(InputStream) - Method in class org.jwat.arc.ArcWriter
-
Stream the content of an input stream to the payload content.
- streamPayload(InputStream) - Method in class org.jwat.arc.ArcWriterCompressed
-
- supportMultipleFiles() - Method in interface org.jwat.arc.ArcFileNaming
-
Does this naming implementation support multiple files.
- supportMultipleFiles() - Method in class org.jwat.arc.ArcFileNamingDefault
-
- supportMultipleFiles() - Method in class org.jwat.arc.ArcFileNamingSingleFile
-