ANVLRecord (webarchive-commons 1.1.9 API)

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:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Element>, java.util.Collection<Element>, java.util.Deque<Element>, java.util.List<Element>, java.util.Queue<Element>, UTF8Bytes
```
public class ANVLRecord
extends java.util.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 java.lang.String`	`CRLF` An ANVL 'newline'.
`static ANVLRecord`	`EMPTY_ANVL_RECORD`
`protected static java.lang.String`	`FOLD_PREFIX`
`static long`	`MAXIMUM_SIZE` Arbitrary upper bound on maximum size of ANVL Record.
`static java.lang.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(java.util.Collection<? extends Element> c)

ANVLRecord(int initialCapacity)
Deprecated.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addLabel(java.lang.String l)`
`boolean`	`addLabelValue(java.lang.String l, java.lang.String v)`
`java.util.Map<java.lang.String,java.lang.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(java.io.InputStream is)` Parses a single ANVLRecord from passed InputStream.
`static ANVLRecord`	`load(java.lang.String s)` Parse passed String for an ANVL Record.
`java.lang.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, spliterator, 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, replaceAll, retainAll, sort, subList

Methods inherited from interface java.util.Deque
iterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - MIMETYPE
```
public static final java.lang.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 java.lang.String CRLF
```
    An ANVL 'newline'.
    
    See Also:
    
    http://en.wikipedia.org/wiki/CRLF, Constant Field Values
  - FOLD_PREFIX
```
protected static final java.lang.String FOLD_PREFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ANVLRecord
```
public ANVLRecord()
```
  - ANVLRecord
```
public ANVLRecord(java.util.Collection<? extends Element> c)
```
  - ANVLRecord
```
public ANVLRecord(int initialCapacity)
```
    Deprecated.
- Method Detail
  - addLabel
```
public boolean addLabel(java.lang.String l)
```
  - addLabelValue
```
public boolean addLabelValue(java.lang.String l,
                             java.lang.String v)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.util.AbstractCollection<Element>
  - asMap
```
public java.util.Map<java.lang.String,java.lang.String> asMap()
```
  - clone
```
public ANVLRecord clone()
```
    Overrides:
    
    clone in class java.util.LinkedList<Element>
  - getUTF8Bytes
```
public byte[] getUTF8Bytes()
                    throws java.io.UnsupportedEncodingException
```
    Specified by:
    
    getUTF8Bytes in interface UTF8Bytes
    
    Returns:
    
    This ANVLRecord as UTF8 bytes.
    
    Throws:
    
    java.io.UnsupportedEncodingException
  - load
```
public static ANVLRecord load(java.io.InputStream is)
                       throws java.io.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:
    
    java.io.IOException
  - load
```
public static ANVLRecord load(java.lang.String s)
                       throws java.io.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:
    
    java.io.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)
```

Class ANVLRecord

Field Summary

Fields inherited from class java.util.AbstractList

Fields inherited from interface org.archive.io.UTF8Bytes

Constructor Summary

Method Summary

Methods inherited from class java.util.LinkedList

Methods inherited from class java.util.AbstractSequentialList

Methods inherited from class java.util.AbstractList

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Deque

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

MIMETYPE

EMPTY_ANVL_RECORD

MAXIMUM_SIZE

CRLF

FOLD_PREFIX

Constructor Detail

ANVLRecord

ANVLRecord

ANVLRecord

Method Detail

addLabel

addLabelValue

toString

asMap

clone

getUTF8Bytes

load

load

getLength

isCROrLF

isCR

isLF