org.eclipse.equinox.internal.p2.metadata

Class OmniVersion

java.lang.Object

org.eclipse.equinox.p2.metadata.Version

org.eclipse.equinox.internal.p2.metadata.BasicVersion

org.eclipse.equinox.internal.p2.metadata.OmniVersion

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Version>

public class OmniVersion
extends BasicVersion

The Generic Omni Version is composed of a vector of Comparable objects and a pad value. The pad might be null. The vector can contain integers, strings, VersionVector instances, or one of the special objects MAX_VALUE, MAXS_VALUE, or MIN_VALUE.

When two versions are compared, they are always considered padded to infinity by their pad value or by MIN_VALUE in case the pad value is null. The comparison is type sensitive so that:

 MAX_VALUE > Integer > VersionVector > MAXS_VALUE > String > MIN_VALUE

 

See Also:

Serialized Form

Field Summary

Fields inherited from class org.eclipse.equinox.p2.metadata.Version

emptyVersion, MAX_VERSION, RAW_PREFIX

Method Summary

Modifier and Type	Method and Description
int	compareTo(Version v)
static Version	createMaxVersion()
static Version	createMinVersion()
boolean	equals(java.lang.Object o)
IVersionFormat	getFormat() Returns the optional format.
int	getMajor() Returns the OSGi major component of this version identifier.
int	getMicro() Returns the OSGi micro component of this version identifier.
int	getMinor() Returns the OSGi minor component of this version identifier.
java.lang.String	getOriginal() Returns the original part of the string for this version or null if no such part was provided when the version was created.
java.lang.Comparable<?>	getPad() Returns the pad value used when comparing this versions to versions that has a larger number of segments
java.lang.String	getQualifier() Returns the OSGi qualifier component of this version identifier.
java.lang.Comparable<?>	getSegment(int index) An element from the raw vector representation of this version.
int	getSegmentCount() Returns the number of elements in the raw vector representation of this version.
int	hashCode()
boolean	isOSGiCompatible() Checks if this version is in compliance with the OSGi version spec.
void	originalToString(java.lang.StringBuffer sb, boolean rangeSafe) Appends the original for this version onto the sb StringBuffer if present.
void	rawToString(java.lang.StringBuffer sb, boolean rangeSafe) Appends the raw format for this version onto the sb StringBuffer.
void	toString(java.lang.StringBuffer sb) Appends the string representation of this version onto the sb StringBuffer.

Methods inherited from class org.eclipse.equinox.p2.metadata.Version

compile, create, createOSGi, createOSGi, parseVersion, toString

Methods inherited from class java.lang.Object

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

Method Detail

createMinVersion

public static Version createMinVersion()

createMaxVersion

public static Version createMaxVersion()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getFormat

public IVersionFormat getFormat()

Description copied from class: Version

Returns the optional format.

Specified by:

getFormat in class Version

getMajor

public int getMajor()

Description copied from class: BasicVersion

Returns the OSGi major component of this version identifier.

Specified by:

getMajor in class BasicVersion

Returns:

The major component.

See Also:

Version.isOSGiCompatible()

getMicro

public int getMicro()

Description copied from class: BasicVersion

Returns the OSGi micro component of this version identifier.

Specified by:

getMicro in class BasicVersion

Returns:

The micro component.

See Also:

Version.isOSGiCompatible()

getMinor

public int getMinor()

Description copied from class: BasicVersion

Returns the OSGi minor component of this version identifier.

Specified by:

getMinor in class BasicVersion

Returns:

The minor component.

See Also:

Version.isOSGiCompatible()

getOriginal

public java.lang.String getOriginal()

Description copied from class: Version

Returns the original part of the string for this version or null if no such part was provided when the version was created. An OSGi type version will always return the OSGi string representation.

Specified by:

getOriginal in class Version

Returns:

The original part of the version string or null if that part was missing.

getQualifier

public java.lang.String getQualifier()

Description copied from class: BasicVersion

Returns the OSGi qualifier component of this version identifier.

Specified by:

getQualifier in class BasicVersion

Returns:

The qualifier component or null if not set.

See Also:

Version.isOSGiCompatible()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isOSGiCompatible

public boolean isOSGiCompatible()

Checks if this version is in compliance with the OSGi version spec.

Specified by:

isOSGiCompatible in class Version

Returns:

A flag indicating whether the version is OSGi compatible or not.

originalToString

public void originalToString(java.lang.StringBuffer sb,
                             boolean rangeSafe)

Appends the original for this version onto the sb StringBuffer if present.

Specified by:

originalToString in class BasicVersion

Parameters:

sb - The buffer that will receive the raw string format

rangeSafe - Set to true if range delimiters should be escaped

rawToString

public void rawToString(java.lang.StringBuffer sb,
                        boolean rangeSafe)

Appends the raw format for this version onto the sb StringBuffer.

Specified by:

rawToString in class BasicVersion

Parameters:

sb - The buffer that will receive the raw string format

rangeSafe - Set to true if range delimiters should be escaped

toString

public void toString(java.lang.StringBuffer sb)

Appends the string representation of this version onto the sb StringBuffer.

Specified by:

toString in class Version

Parameters:

sb - The buffer that will receive the version string

getPad

public java.lang.Comparable<?> getPad()

Description copied from class: Version

Returns the pad value used when comparing this versions to versions that has a larger number of segments

Specified by:

getPad in class Version

Returns:

The pad value or null if not set.

getSegment

public java.lang.Comparable<?> getSegment(int index)

Description copied from class: Version

An element from the raw vector representation of this version.

Specified by:

getSegment in class Version

Parameters:

index - The zero based index of the desired element

Returns:

An element from the raw vector

getSegmentCount

public int getSegmentCount()

Description copied from class: Version

Returns the number of elements in the raw vector representation of this version.

Specified by:

getSegmentCount in class Version

Returns:

The number of elements in the raw vector.

compareTo

public int compareTo(Version v)