org.archive.util.anvl

Class ANVLRecord

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

java.util.LinkedList<Element>

org.archive.util.anvl.ANVLRecord

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Element>, Collection<Element>, Deque<Element>, List<Element>, Queue<Element>, UTF8Bytes

public class ANVLRecord
extends LinkedList<Element>
implements UTF8Bytes

An ordered List with 'data' Element values. ANVLRecords end with a blank line.

Author:

stack

See Also:

A Name-Value Language (ANVL), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CRLF An ANVL 'newline'.
static ANVLRecord	EMPTY_ANVL_RECORD
protected static String	FOLD_PREFIX
static long	MAXIMUM_SIZE Arbitrary upper bound on maximum size of ANVL Record.
static String	MIMETYPE

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface org.archive.io.UTF8Bytes

UTF8

Constructor Summary

Constructors

Constructor and Description
ANVLRecord()
ANVLRecord(Collection<? extends Element> c)
ANVLRecord(int initialCapacity) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addLabel(String l)
boolean	addLabelValue(String l, String v)
Map<String,String>	asMap()
ANVLRecord	clone()
int	getLength()
byte[]	getUTF8Bytes()
static boolean	isCR(char c)
static boolean	isCROrLF(char c)
static boolean	isLF(char c)
static ANVLRecord	load(InputStream is) Parses a single ANVLRecord from passed InputStream.
static ANVLRecord	load(String s) Parse passed String for an ANVL Record.
String	toString()

Methods inherited from class java.util.LinkedList

add, add, addAll, addAll, addFirst, addLast, clear, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, size, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode, isEmpty, iterator, listIterator, removeAll, retainAll, subList

Methods inherited from interface java.util.Deque

iterator

Field Detail

MIMETYPE

public static final String MIMETYPE

See Also:

Constant Field Values

EMPTY_ANVL_RECORD

public static final ANVLRecord EMPTY_ANVL_RECORD

MAXIMUM_SIZE

public static final long MAXIMUM_SIZE

Arbitrary upper bound on maximum size of ANVL Record. Will throw an IOException if exceed this size.

See Also:

Constant Field Values

CRLF

protected static final String CRLF

An ANVL 'newline'.

See Also:

http://en.wikipedia.org/wiki/CRLF, Constant Field Values

FOLD_PREFIX

protected static final String FOLD_PREFIX

See Also:

Constant Field Values

Constructor Detail

ANVLRecord

public ANVLRecord()

ANVLRecord

public ANVLRecord(Collection<? extends Element> c)

ANVLRecord

public ANVLRecord(int initialCapacity)

Deprecated.

Method Detail

addLabel

public boolean addLabel(String l)

addLabelValue

public boolean addLabelValue(String l,
                    String v)

toString

public String toString()

Overrides:

toString in class AbstractCollection<Element>

asMap

public Map<String,String> asMap()

clone

public ANVLRecord clone()

Overrides:

clone in class LinkedList<Element>

getUTF8Bytes

public byte[] getUTF8Bytes()
                    throws UnsupportedEncodingException

Specified by:

getUTF8Bytes in interface UTF8Bytes

Returns:

This ANVLRecord as UTF8 bytes.

Throws:

UnsupportedEncodingException

load

public static ANVLRecord load(InputStream is)
                       throws IOException

Parses a single ANVLRecord from passed InputStream. Read as a single-byte stream until we get to a CRLFCRLF which signifies End-of-ANVLRecord. Then parse all read as a UTF-8 Stream. Doing it this way, while requiring a double-scan, it makes it so do not need to be passed a RepositionableStream or a Stream that supports marking. Also no danger of over-reading which can happen when we wrap passed Stream with an InputStreamReader for doing UTF-8 character conversion (See the ISR class comment).

Parameters:

is - InputStream

Returns:

An ANVLRecord instance.

Throws:

IOException

load

public static ANVLRecord load(String s)
                       throws IOException

Parse passed String for an ANVL Record. Looked at writing javacc grammer but preprocessing is required to handle folding: See https://javacc.dev.java.net/servlets/BrowseList?list=users&by=thread&from=56173. Looked at Terence Parr's ANTLR. More capable. Can set lookahead count. A value of 3 would help with folding. But its a pain defining UNICODE grammers -- needed by ANVL -- and support seems incomplete anyways: http://www.doc.ic.ac.uk/lab/secondyear/Antlr/lexer.html#unicode. For now, go with the below hand-rolled parser.

Parameters:

s - String with an ANVLRecord.

Returns:

ANVLRecord parsed from passed String.

Throws:

IOException

getLength

public int getLength()

Returns:

Count of ANVLRecord bytes. Be careful, an empty ANVLRecord is CRLFCRLF so is of size 4. Also, expensive, since it makes String of the record so it can count bytes.

isCROrLF

public static boolean isCROrLF(char c)

isCR

public static boolean isCR(char c)

isLF

public static boolean isLF(char c)