dev.dejvokep.boostedyaml.dvs

Class Version

java.lang.Object

dev.dejvokep.boostedyaml.dvs.Version

All Implemented Interfaces:

Comparable<Version>

public class Version
extends Object
implements Comparable<Version>

The in-code representation of version IDs (e.g. 1.4 or 1.2-alpha).

Each version is defined by a Pattern and an array of cursors, each corresponding to one pattern Segment. A cursor represents the index of the element of that Segment which is forming the version ID and each time any cursor changes, the ID representation is rebuilt and cached.

Method Summary

Modifier and Type	Method and Description
String	asID() Returns the version as an ID (for example "1.2", "5" etc. according to the pattern).
int	compareTo(Version o)
Version	copy() Creates a copy of this version object.
boolean	equals(Object o)
int	getCursor(int index) Returns the cursor corresponding to pattern segment at the given index.
Pattern	getPattern() Returns the versions' pattern (was also used to parse the version).
int	hashCode()
void	next() Moves to the next version (accordingly to the pattern).
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

compareTo

public int compareTo(Version o)

Specified by:

compareTo in interface Comparable<Version>

getCursor

public int getCursor(int index)

Returns the cursor corresponding to pattern segment at the given index. The given index must be >= 0, simultaneously less than the amount of segments defining the pattern.

The returned cursor is guaranteed to be >= 0 and less than the corresponding segment's length.

Parameters:

index - the index of the cursor to return

Returns:

the cursor

next

public void next()

Moves to the next version (accordingly to the pattern).

More formally, shifts the cursor of the least significant segment (on the right). If it was the last element in the segment's definition, resets the cursor to 0 (first element) and shifts the cursor of 2nd least significant part (just to the left) the same way.

For example, 1.2 -> 1.3 (depending on the pattern configuration, just for illustration).

asID

public String asID()

Returns the version as an ID (for example "1.2", "5" etc. according to the pattern).

Returns:

the version as an ID

copy

public Version copy()

Creates a copy of this version object. The new object does not keep reference to this one in any means except the pattern, which is shared between them.

More formally, only makes a shallow copy of the cursor indexes.

Returns:

the new, copied version object

getPattern

public Pattern getPattern()

Returns the versions' pattern (was also used to parse the version).

Returns:

the versions' pattern

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object