net.sf.mmm.util.version.base

Class AbstractVersionIdentifier

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VersionIdentifierImpl

public abstract class AbstractVersionIdentifier
extends Object
implements VersionIdentifier

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 int	hash
private static long	serialVersionUID UID for serialization.
private String	stringRepresentation

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
AbstractVersionIdentifier(String stringRepresentation) The constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(VersionIdentifier otherVersion) This method determines a (non-linear) distance from this version to the given otherVersion.
private int	compareToLabel(int currentResult, VersionIdentifier otherVersion) This method performs the part of compareTo(VersionIdentifier) for the label.
private <T extends Comparable<T>> int	compareToLinear(int currentResult, T thisValue, T otherValue, VersionIdentifier otherVersion) This method performs the part of compareTo(VersionIdentifier) for linear and optional attributes like VersionIdentifier.getTimestamp() or VersionIdentifier.getRevision().
private int	compareToPhase(int currentResult, VersionIdentifier otherVersion) This method performs the part of compareTo(VersionIdentifier) for the timestamp.
private int	compareToRevision(int currentResult, VersionIdentifier otherVersion) This method performs the part of compareTo(VersionIdentifier) for the revision.
private int	compareToTimestamp(int currentResult, VersionIdentifier otherVersion) This method performs the part of compareTo(VersionIdentifier) for the timestamp.
private int	compareToVersionNumber(VersionIdentifier otherVersion) This method performs the part of compareTo(VersionIdentifier) for the version number.
boolean	equals(Object other)
private static int	getPhaseNumberAsInt(VersionIdentifier version) This method gets VersionIdentifier.getPhaseNumber() as int.
String	getStringRepresentation()
String	getValue() This method returns the raw value of this datatype.
int	getVersionMajorSegment() This method gets the major segment of this VersionIdentifier.
int	getVersionMicroSegment() This method gets the micro segment of this VersionIdentifier.
int	getVersionMilliSegment() This method gets the milli segment of this VersionIdentifier.
int	getVersionMinorSegment() This method gets the minor segment of this VersionIdentifier.
int	hashCode()
protected void	setStringRepresentation(String stringRepresentation)
String	toString() This method gets a unique string representation of this VersionIdentifier.

Methods inherited from class java.lang.Object

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

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

getLabel, getPhase, getPhaseAlias, getPhaseNumber, getRevision, getTimestamp, getVersionSegment, getVersionSegmentCount, isSnapshot

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

hash

private transient int hash

See Also:

hashCode()

stringRepresentation

private transient String stringRepresentation

See Also:

toString()

Constructor Detail

AbstractVersionIdentifier

public AbstractVersionIdentifier(String stringRepresentation)

The constructor.

Parameters:

stringRepresentation - is the String returned by toString().

Method Detail

getVersionMajorSegment

public int getVersionMajorSegment()

This method gets the major segment of this VersionIdentifier. This is the most significant segment of the version. It only gets updated on significant functional and/or structural changes of the versioned artifact. An upgrade can cause appreciable manual effort and will often cause compatibility problems and require migration of data or configuration.

Specified by:

getVersionMajorSegment in interface VersionIdentifier

Returns:

the major version segment.

See Also:

VersionIdentifier.VERSION_SEGMENT_INDEX_MAJOR

getVersionMinorSegment

public int getVersionMinorSegment()

This method gets the minor segment of this VersionIdentifier. This is the second most significant segment of the version. It only gets updated on functional and/or structural changes of the versioned artifact. An upgrade should be supported but may cause compatibility problems and require migration of data or configuration.

Specified by:

getVersionMinorSegment in interface VersionIdentifier

Returns:

the minor version segment.

See Also:

VersionIdentifier.VERSION_SEGMENT_INDEX_MINOR

getVersionMilliSegment

public int getVersionMilliSegment()

This method gets the milli segment of this VersionIdentifier. This is the third most significant segment of the version. It only gets updated on small functional and/or structural changes of the versioned artifact. An upgrade should not cause problems but needs to be tested.

Specified by:

getVersionMilliSegment in interface VersionIdentifier

Returns:

the milli version segment.

See Also:

VersionIdentifier.VERSION_SEGMENT_INDEX_MILLI

getVersionMicroSegment

public int getVersionMicroSegment()

This method gets the micro segment of this VersionIdentifier. This is the fourth most significant segment of the version. It only gets updated on small internal changes (e.g. bugfixes) of the versioned artifact. An upgrade should not cause problems.

Specified by:

getVersionMicroSegment in interface VersionIdentifier

Returns:

the milli version segment.

See Also:

VersionIdentifier.VERSION_SEGMENT_INDEX_MICRO

getStringRepresentation

public String getStringRepresentation()

Returns:

the stringRepresentation

setStringRepresentation

protected void setStringRepresentation(String stringRepresentation)

Parameters:

stringRepresentation - is the stringRepresentation to set

compareToVersionNumber

private int compareToVersionNumber(VersionIdentifier otherVersion)

This method performs the part of compareTo(VersionIdentifier) for the version number.

Parameters:

otherVersion - is the VersionIdentifier to compare to.

Returns:

the result of comparison.

getPhaseNumberAsInt

private static int getPhaseNumberAsInt(VersionIdentifier version)

This method gets VersionIdentifier.getPhaseNumber() as int.

Parameters:

version - is the VersionIdentifier.

Returns:

the VersionIdentifier.getPhaseNumber() as int, using 0 for null.

compareToPhase

private int compareToPhase(int currentResult,
                           VersionIdentifier otherVersion)

This method performs the part of compareTo(VersionIdentifier) for the timestamp.

Parameters:

currentResult - is the current result so far.

otherVersion - is the VersionIdentifier to compare to.

Returns:

the result of comparison.

compareToTimestamp

private int compareToTimestamp(int currentResult,
                               VersionIdentifier otherVersion)

This method performs the part of compareTo(VersionIdentifier) for the timestamp.

Parameters:

currentResult - is the current result so far.

otherVersion - is the VersionIdentifier to compare to.

Returns:

the result of comparison.

compareToLinear

private <T extends Comparable<T>> int compareToLinear(int currentResult,
                                                      T thisValue,
                                                      T otherValue,
                                                      VersionIdentifier otherVersion)

This method performs the part of compareTo(VersionIdentifier) for linear and optional attributes like VersionIdentifier.getTimestamp() or VersionIdentifier.getRevision().

Type Parameters:

T - is the generic type of the Comparable value.

Parameters:

currentResult - is the current result so far.

thisValue - is the value of this VersionIdentifier.

otherValue - is the value of the other VersionIdentifier.

otherVersion - is the VersionIdentifier to compare to.

Returns:

the result of comparison.

compareToRevision

private int compareToRevision(int currentResult,
                              VersionIdentifier otherVersion)

This method performs the part of compareTo(VersionIdentifier) for the revision.

Parameters:

currentResult - is the current result so far.

otherVersion - is the VersionIdentifier to compare to.

Returns:

the result of comparison.

compareToLabel

private int compareToLabel(int currentResult,
                           VersionIdentifier otherVersion)

This method performs the part of compareTo(VersionIdentifier) for the label.

Parameters:

currentResult - is the current result so far.

otherVersion - is the VersionIdentifier to compare to.

Returns:

the result of comparison.

compareTo

public final int compareTo(VersionIdentifier otherVersion)

This method determines a (non-linear) distance from this version to the given otherVersion. It will return

• VersionIdentifier.COMPARE_TO_INCOMPARABLE if both versions are incompatible to each other (e.g. ).
• 0 if both versions are historically equivalent (but may NOT be equal)
• a negative value if this version is a predecessor of otherVersion. The value -1 indicates a strict predecessor.
• a positive value if this version is a successor of otherVersion. The value +1 indicates a strict successor.

The following table gives some examples:

version	otherVersion	version.compareTo(otherVersion)
1.0.0-SNAPSHOT	1.0.0-SNAPSHOT	0
1.0.0	1.0.0-SNAPSHOT	1 (VersionIdentifier.COMPARE_TO_STRICT_SUCCESSOR)
1.0.1	1.0.0	1 (VersionIdentifier.COMPARE_TO_STRICT_SUCCESSOR)
1.0.1	1.0.0-SNAPSHOT	>1
1.6.0u23	1.6.0u24	-1 (VersionIdentifier.COMPARE_TO_STRICT_PREDECESSOR)
3.7-SR1-indigo	4.1.1-201109121510	<-1
3.7.1-helios	3.7.1-indigo	VersionIdentifier.COMPARE_TO_INCOMPARABLE
1.0-20000101T000000Z	1.0-19991231T235959Z	VersionIdentifier.COMPARE_TO_INCOMPARABLE
1.0-20000101T000000Z	1.1-19991231T235959Z	VersionIdentifier.COMPARE_TO_INCOMPARABLE

Specified by:

compareTo in interface Comparable<VersionIdentifier>

Specified by:

compareTo in interface VersionIdentifier

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

getValue

public String getValue()

This method returns the raw value of this datatype. This will typically be a standard datatype (like String, Character, Boolean, any type of Number, any type of java.time.LocalDate, etc.).

Specified by:

getValue in interface AttributeReadValue<String>

Specified by:

getValue in interface SimpleDatatype<String>

Returns:

the value of this datatype.

toString

public String toString()

This method gets a unique string representation of this VersionIdentifier. Returns the official String representation of this Datatype. While the general contract of Object.toString() is very weak and mainly used for debugging, the contract here is very strong. The returned String has to be suitable for end-users and official output to any kind of sink.
ATTENTION:
This method is not supposed to do internationalization (I18N). See NlsMessage for this purpose and implement NlsObject if you want to support I18N/L10N.

Specified by:

toString in interface Datatype

Specified by:

toString in interface VersionIdentifier

Overrides:

toString in class Object

Returns:

the official String representation to display the value of this Datatype.