votorola.a.diff

Class DiffKeyParse

java.lang.Object

DiffKeyParse

@ThreadSafe
public final class DiffKeyParse
extends Object

A difference key in parsed form.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiffKeyParse.MalformedKey Thrown when a malformed difference key is detected.

Constructor Summary

Constructors

Constructor and Description
DiffKeyParse(int a, int aR, int b, int bR) Constructs a DiffKeyParse from obsolete, named revision variables.
DiffKeyParse(List<Integer> aPathW, List<Integer> bPathW, int _revisionSeries) Constructs a DiffKeyParse by taking ownership of two path lists.
DiffKeyParse(String _key) Parses a difference key and constructs a DiffKeyParse.

Method Summary

Methods

Modifier and Type	Method and Description
List<Integer>	aPath() The revision path for the first (a) draft revision.
List<Integer>	bPath() The revision path for the second (b) draft revision.
String	key() The difference key in string form.
DiffKeyParse	newReverseParse() Constructs the reverse of this parse, in which all components of a-draft and b-draft are interchanged.
int	revisionSeries() The pollwiki revision series.
String	toString() Returns the difference key.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiffKeyParse

public DiffKeyParse(int a,
            int aR,
            int b,
            int bR)

Constructs a DiffKeyParse from obsolete, named revision variables. This form of difference key dates from when revision paths had a maximum length of two, the second revision (if present) always designating a remote draft. The revision series is zero in this case.

Parameters:

a - the aPath revision number at index zero.

aR - the aPath revision number at index one, or -1 if there is none.

b - the bPath revision number at index zero.

bR - the bPath revision number at index one, or -1 if there is none.

DiffKeyParse

public DiffKeyParse(List<Integer> aPathW,
            List<Integer> bPathW,
            int _revisionSeries)
             throws DiffKeyParse.MalformedKey

Constructs a DiffKeyParse by taking ownership of two path lists. API integrity and thread safety depend on the caller not subsequently modifying either list (unchecked constraint).

Throws:

DiffKeyParse.MalformedKey

See Also:

aPath(), bPath(), revisionSeries()

DiffKeyParse

public DiffKeyParse(String _key)
             throws DiffKeyParse.MalformedKey

Parses a difference key and constructs a DiffKeyParse.

Throws:

DiffKeyParse.MalformedKey

See Also:

key()

Method Detail

aPath

public final List<Integer> aPath()

The revision path for the first (a) draft revision.

bPath

public final List<Integer> bPath()

The revision path for the second (b) draft revision.

key

public final String key()

The difference key in string form.

newReverseParse

public DiffKeyParse newReverseParse()

Constructs the reverse of this parse, in which all components of a-draft and b-draft are interchanged.

revisionSeries

public final int revisionSeries()

The pollwiki revision series.

See Also:

PollwikiVS.revisionSeries()

toString

public final String toString()

Returns the difference key.

Overrides:

toString in class Object