|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.core.runtime.PluginVersionIdentifier
Version identifier for a plug-in. In its string representation, it consists of up to 4 tokens separated by a decimal point. The first 3 tokens are positive integer numbers, the last token is an uninterpreted string (no whitespace characters allowed). For example, the following are valid version identifiers (as strings):
0.0.0
1.0.127564
3.7.2.build-127J
1.9
(interpreted as 1.9.0
)3
(interpreted as 3.0.0
)The version identifier can be decomposed into a major, minor, service level component and qualifier components. A difference in the major component is interpreted as an incompatible version change. A difference in the minor (and not the major) component is interpreted as a compatible version change. The service level component is interpreted as a cumulative and compatible service update of the minor version component. The qualifier is not interpreted, other than in version comparisons. The qualifiers are compared using lexicographical string comparison.
Version identifiers can be matched as perfectly equal, equivalent, compatible or greaterOrEqual.
Clients may instantiate; not intended to be subclassed by clients.
IPluginDescriptor.getVersionIdentifier()
,
String.compareTo(java.lang.String)
Constructor Summary | |
PluginVersionIdentifier(int major,
int minor,
int service)
Creates a plug-in version identifier from its components. |
|
PluginVersionIdentifier(int major,
int minor,
int service,
String qualifier)
Creates a plug-in version identifier from its components. |
|
PluginVersionIdentifier(String versionId)
Creates a plug-in version identifier from the given string. |
Method Summary | |
boolean |
equals(Object object)
Compare version identifiers for equality. |
int |
getMajorComponent()
Returns the major (incompatible) component of this version identifier. |
int |
getMinorComponent()
Returns the minor (compatible) component of this version identifier. |
String |
getQualifierComponent()
Returns the qualifier component of this version identifier. |
int |
getServiceComponent()
Returns the service level component of this version identifier. |
int |
hashCode()
Returns a hash code value for the object. |
boolean |
isCompatibleWith(PluginVersionIdentifier id)
Compares two version identifiers for compatibility. |
boolean |
isEquivalentTo(PluginVersionIdentifier id)
Compares two version identifiers for equivalency. |
boolean |
isGreaterOrEqualTo(PluginVersionIdentifier id)
Compares two version identifiers to see if this one is greater than or equal to the argument. |
boolean |
isGreaterThan(PluginVersionIdentifier id)
Compares two version identifiers for order using multi-decimal comparison. |
boolean |
isPerfect(PluginVersionIdentifier id)
Compares two version identifiers for perfect equality. |
String |
toString()
Returns the string representation of this version identifier. |
static IStatus |
validateVersion(String version)
Validates the given string as a plug-in version identifier. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public PluginVersionIdentifier(int major, int minor, int service)
major
- major component of the version identifierminor
- minor component of the version identifierservice
- service update component of the version identifierpublic PluginVersionIdentifier(int major, int minor, int service, String qualifier)
major
- major component of the version identifierminor
- minor component of the version identifierservice
- service update component of the version identifierqualifier
- qualifier component of the version identifier.
Qualifier characters that are not a letter or a digit are replaced.public PluginVersionIdentifier(String versionId)
0.0.0
1.0.127564
3.7.2.build-127J
1.9
(interpreted as 1.9.0
)3
(interpreted as 3.0.0
)
versionId
- string representation of the version identifier.
Qualifier characters that are not a letter or a digit are replaced.Method Detail |
public static IStatus validateVersion(String version)
version
- the string to validate
IStatus.OK
if
the given string is valid as a plug-in version identifier, otherwise a status
object indicating what is wrong with the stringpublic boolean equals(Object object)
equals
in class Object
object
- an object to compare
public int hashCode()
hashCode
in class Object
public int getMajorComponent()
public int getMinorComponent()
public int getServiceComponent()
public String getQualifierComponent()
public boolean isGreaterOrEqualTo(PluginVersionIdentifier id)
A version identifier is considered to be greater than or equal if its major component is greater than the argument major component, or the major components are equal and its minor component is greater than the argument minor component, or the major and minor components are equal and its service component is greater than the argument service component, or the major, minor and service components are equal and the qualifier component is greated than the argument qualifier component (using lexicographic string comparison), or all components are equal.
true
is this version identifier
is compatible with the given version identifier, and
false
otherwisepublic boolean isCompatibleWith(PluginVersionIdentifier id)
A version identifier is considered to be compatible if its major component equals to the argument major component, and its minor component is greater than or equal to the argument minor component. If the minor components are equal, than the service level of the version identifier must be greater than or equal to the service level of the argument identifier. If the service levels are equal, the two version identifiers are considered to be equivalent if this qualifier is greated or equal to the qualifier of the argument (using lexicographic string comparison).
true
is this version identifier
is compatible with the given version identifier, and
false
otherwisepublic boolean isEquivalentTo(PluginVersionIdentifier id)
Two version identifiers are considered to be equivalent if their major and minor component equal and are at least at the same service level as the argument. If the service levels are equal, the two version identifiers are considered to be equivalent if this qualifier is greated or equal to the qualifier of the argument (using lexicographic string comparison).
true
is this version identifier
is equivalent to the given version identifier, and
false
otherwisepublic boolean isPerfect(PluginVersionIdentifier id)
Two version identifiers are considered to be perfectly equal if their major, minor, service and qualifier components are equal
true
is this version identifier
is perfectly equal to the given version identifier, and
false
otherwisepublic boolean isGreaterThan(PluginVersionIdentifier id)
true
is this version identifier
is greater than the given version identifier, and
false
otherwisepublic String toString()
vi.equals(new PluginVersionIdentifier(vi.toString()))
.
toString
in class Object
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |