net.sf.mmm.util.version.impl

Class VersionIdentifierImpl

java.lang.Object

net.sf.mmm.util.version.base.AbstractVersionIdentifier

net.sf.mmm.util.version.impl.VersionIdentifierImpl

All Implemented Interfaces:

Serializable, Comparable<VersionIdentifier>, AttributeReadValue<String>, Datatype, SimpleDatatype<String>, VersionIdentifier

public class VersionIdentifierImpl
extends AbstractVersionIdentifier

This is the abstract base implementation of VersionIdentifier.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private String	label
private DevelopmentPhase	phase
private String	phaseAlias
private Integer	phaseNumber
private Long	revision
private int[]	segments
private static long	serialVersionUID UID for serialization.
private boolean	snapshot
private Date	timestamp

Fields inherited from interface net.sf.mmm.util.version.api.VersionIdentifier

COMPARE_TO_INCOMPARABLE, COMPARE_TO_STRICT_PREDECESSOR, COMPARE_TO_STRICT_SUCCESSOR, SNAPSHOT, VERSION_SEGMENT_INDEX_MAJOR, VERSION_SEGMENT_INDEX_MICRO, VERSION_SEGMENT_INDEX_MILLI, VERSION_SEGMENT_INDEX_MINOR, VERSION_SEGMENT_INDEX_NANNO, VERSION_SEGMENT_INDEX_PICO

Constructor Summary

Constructors

Constructor and Description
VersionIdentifierImpl() The non-arg constructor.
VersionIdentifierImpl(String stringRepresentation, String label, Date timestamp, Long revision, DevelopmentPhase phase, String phaseAlias, Integer phaseNumber, boolean snapshot, int... versionSegments) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getLabel() This method gets the optional label of the VersionIdentifier.
DevelopmentPhase	getPhase() This method gets the DevelopmentPhase of this VersionIdentifier.
String	getPhaseAlias() This method gets the string representation of the phase for this VersionIdentifier.
Integer	getPhaseNumber() This method gets the subsequent number of this VersionIdentifier within a particular phase.
Long	getRevision() This method gets the revision of the VersionIdentifier.
Date	getTimestamp() This method gets the timestamp of the VersionIdentifier.
int	getVersionSegment(int index) This method gets an arbitrary segment of the version number.
int	getVersionSegmentCount() This method gets the number of segments of this VersionIdentifier .
boolean	isSnapshot() This method determines if this VersionIdentifier indicates a snapshot release.
protected void	setStringRepresentation(String stringRepresentation)
private void	validate() This method validates the consistency of this version identifier.

Methods inherited from class net.sf.mmm.util.version.base.AbstractVersionIdentifier

compareTo, equals, getStringRepresentation, getValue, getVersionMajorSegment, getVersionMicroSegment, getVersionMilliSegment, getVersionMinorSegment, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

segments

private int[] segments

See Also:

getVersionSegment(int)

phase

private DevelopmentPhase phase

See Also:

getPhase()

phaseNumber

private Integer phaseNumber

See Also:

getPhaseNumber()

phaseAlias

private String phaseAlias

See Also:

getPhaseAlias()

snapshot

private boolean snapshot

See Also:

isSnapshot()

revision

private Long revision

See Also:

getRevision()

timestamp

private Date timestamp

See Also:

getTimestamp()

label

private String label

See Also:

getLabel()

Constructor Detail

VersionIdentifierImpl

public VersionIdentifierImpl()

The non-arg constructor. Required for JAXB - not suitable for end-users.

VersionIdentifierImpl

public VersionIdentifierImpl(String stringRepresentation,
                             String label,
                             Date timestamp,
                             Long revision,
                             DevelopmentPhase phase,
                             String phaseAlias,
                             Integer phaseNumber,
                             boolean snapshot,
                             int... versionSegments)

The constructor.

Parameters:

stringRepresentation - - see AbstractVersionIdentifier.toString().

label - - see getLabel(). May be null.

timestamp - - see getTimestamp(). May be null.

revision - - see getRevision(). May be null.

phase - - see getPhase(). May be null.

phaseAlias - - see getPhase(). May be null (only if phase is null).

phaseNumber - - see getPhaseNumber(). May be null (only if phase is null).

snapshot - - see isSnapshot().

versionSegments - - see getVersionSegment(int). At least one segment is required if no snapshot.

Method Detail

validate

private void validate()

This method validates the consistency of this version identifier.

setStringRepresentation

protected void setStringRepresentation(String stringRepresentation)

Overrides:

setStringRepresentation in class AbstractVersionIdentifier

Parameters:

stringRepresentation - is the stringRepresentation to set

getVersionSegment

public int getVersionSegment(int index)
                      throws IndexOutOfBoundsException

This method gets an arbitrary segment of the version number. The version number is a part of the VersionIdentifier represented by the concatenation of all segments separated by a separator (typically the dot sign).
This method will return 0 if a segment is not available. However it will not throw an IndexOutOfBoundsException if the index is non negative.
Here are some examples

version number	VersionIdentifier.getVersionSegmentCount()	index	getSegment(index)
1.2.3.42	4	0	1
1.2.3.42	4	3	42
1.2.3.42	4	4	0
4.0	2	0	4
4.0	2	1	0
4.0	2	2	0
4.0	2	3	0

E.g. if the version number is "1.2.3.42", then getSegment()

Parameters:

index - is the 0-based index of the requested segment. It shall not be negative.

Returns:

the requested segment. If not available (in other words if index is greater or equal to VersionIdentifier.getVersionSegmentCount()) the value 0 is returned.

Throws:

IndexOutOfBoundsException - if the given index is negative.

See Also:

VersionIdentifier.VERSION_SEGMENT_INDEX_MAJOR, VersionIdentifier.VERSION_SEGMENT_INDEX_MINOR, VersionIdentifier.VERSION_SEGMENT_INDEX_MILLI, VersionIdentifier.VERSION_SEGMENT_INDEX_MICRO, VersionIdentifier.VERSION_SEGMENT_INDEX_NANNO, VersionIdentifier.VERSION_SEGMENT_INDEX_PICO

getVersionSegmentCount

public int getVersionSegmentCount()

This method gets the number of segments of this VersionIdentifier .

Returns:

the number of segments.

getPhase

public DevelopmentPhase getPhase()

This method gets the DevelopmentPhase of this VersionIdentifier.
ATTENTION:
If the phase is undefined (null), DevelopmentPhase.RELEASE will be assumed for VersionIdentifier.compareTo(VersionIdentifier).

Returns:

the DevelopmentPhase or null if NOT defined.

getPhaseNumber

public Integer getPhaseNumber()

This method gets the subsequent number of this VersionIdentifier within a particular phase. It is typically null and will then be omitted in the string-representation. However release-candidates and updates are often numbered (e.g. like "u1", "u2", ... in Java-releases or "RC1"/"SR1", ... in Eclipse-releases).
If VersionIdentifier.getPhase() returns null also this method should return null. Also if VersionIdentifier.getPhase() is DevelopmentPhase.RELEASE this method should return null (there is just one official release - after that there are updates).
ATTENTION:
If the phase is undefined (null), 0 will be assumed for VersionIdentifier.compareTo(VersionIdentifier).

Returns:

the phase number or null if NOT defined.

getPhaseAlias

public String getPhaseAlias()

This method gets the string representation of the phase for this VersionIdentifier. This is ideally VersionIdentifier.getPhase().toString() but may also be any other legal alias for the phase.
E.g. for DevelopmentPhase.RELEASE the phase name may also be "final", "GA", "RTM", "REL", "gold", or "stable".

Returns:

the alias of the phase.

isSnapshot

public boolean isSnapshot()

This method determines if this VersionIdentifier indicates a snapshot release. A snapshot is an informal pre-release. Multiple snapshot releases with different content can be published for snapshot versions while this is strictly prohibited for non-snapshot versions. A snapshot version is a strict predecessor of the same VersionIdentifier without the snapshot.
E.g. multiple "1.0.0-SNAPSHOT" versions can be published for testers. After all tests pass, the version "1.0.0" gets released. This approach is orthogonal to the phase and can be combined (e.g. "1.0.0-beta2-SNAPSHOT").

Returns:

true if this VersionIdentifier represents a snapshot release, false in case of an official release.

getRevision

public Long getRevision()

This method gets the revision of the VersionIdentifier. It typically has a technical nature and might be derived from the underlying version control system.

Returns:

the revision or null if NOT defined.

getTimestamp

public Date getTimestamp()

This method gets the timestamp of the VersionIdentifier. It indicates the point in time when this VersionIdentifier was assigned to the associated object. The timestamp may also called release date. The value is optional but is best practice to assign a timestamp to a VersionIdentifier.

Returns:

the timestamp or null if NOT defined.

getLabel

public String getLabel()

This method gets the optional label of the VersionIdentifier. A label is a non-technical identifier also called code name (e.g. "Tiger" or "Dolphin").

Returns:

the label or null if NOT defined.