org.osgi.framework.Version Class Reference

List of all members.


Detailed Description

Version identifier for bundles and packages.

Version identifiers have four components.

  1. Major version. A non-negative integer.
  2. Minor version. A non-negative integer.
  3. Micro version. A non-negative integer.
  4. Qualifier. A text string. See Version(String) for the format of the qualifier string.

Version objects are immutable.

Version:
Revision
1.16
Since:
1.3

Definition at line 44 of file Version.java.


Public Member Functions

 Version (int major, int minor, int micro)
 Creates a version identifier from the specified numerical components.
 Version (int major, int minor, int micro, String qualifier)
 Creates a version identifier from the specifed components.
 Version (String version)
 Created a version identifier from the specified string.
int getMajor ()
 Returns the major component of this version identifier.
int getMinor ()
 Returns the minor component of this version identifier.
int getMicro ()
 Returns the micro component of this version identifier.
String getQualifier ()
 Returns the qualifier component of this version identifier.
String toString ()
 Returns the string representation of this version identifier.
int hashCode ()
 Returns a hash code value for the object.
boolean equals (Object object)
 Compares this Version object to another object.
int compareTo (Object object)
 Compares this Version object to another object.

Static Public Member Functions

static Version parseVersion (String version)
 Parses a version identifier from the specified string.

Static Public Attributes

static final Version emptyVersion = new Version(0, 0, 0)
 The empty version "0.0.0".

Constructor & Destructor Documentation

org.osgi.framework.Version.Version ( int  major,
int  minor,
int  micro 
)

Creates a version identifier from the specified numerical components.

The qualifier is set to the empty string.

Parameters:
major Major component of the version identifier.
minor Minor component of the version identifier.
micro Micro component of the version identifier.
Exceptions:
IllegalArgumentException If the numerical components are negative.

Definition at line 69 of file Version.java.

Referenced by org.osgi.framework.Version.parseVersion().

org.osgi.framework.Version.Version ( int  major,
int  minor,
int  micro,
String  qualifier 
)

Creates a version identifier from the specifed components.

Parameters:
major Major component of the version identifier.
minor Minor component of the version identifier.
micro Micro component of the version identifier.
qualifier Qualifier component of the version identifier. If null is specified, then the qualifier will be set to the empty string.
Exceptions:
IllegalArgumentException If the numerical components are negative or the qualifier string is invalid.

Definition at line 85 of file Version.java.

org.osgi.framework.Version.Version ( String  version  ) 

Created a version identifier from the specified string.

Here is the grammar for version strings.

 version ::= major('.'minor('.'micro('.'qualifier)?)?)?
 major ::= digit+
 minor ::= digit+
 micro ::= digit+
 qualifier ::= (alpha|digit|'_'|'-')+
 digit ::= [0..9]
 alpha ::= [a..zA..Z]
 

There must be no whitespace in version.

Parameters:
version String representation of the version identifier.
Exceptions:
IllegalArgumentException If version is improperly formatted.

Definition at line 119 of file Version.java.


Member Function Documentation

static Version org.osgi.framework.Version.parseVersion ( String  version  )  [static]

Parses a version identifier from the specified string.

See Version(String) for the format of the version string.

Parameters:
version String representation of the version identifier. Leading and trailing whitespace will be ignored.
Returns:
A Version object representing the version identifier. If version is null or the empty string then emptyVersion will be returned.
Exceptions:
IllegalArgumentException If version is improperly formatted.

Definition at line 198 of file Version.java.

References org.osgi.framework.Version.emptyVersion, and org.osgi.framework.Version.Version().

int org.osgi.framework.Version.getMajor (  ) 

Returns the major component of this version identifier.

Returns:
The major component.

Definition at line 216 of file Version.java.

int org.osgi.framework.Version.getMinor (  ) 

Returns the minor component of this version identifier.

Returns:
The minor component.

Definition at line 225 of file Version.java.

int org.osgi.framework.Version.getMicro (  ) 

Returns the micro component of this version identifier.

Returns:
The micro component.

Definition at line 234 of file Version.java.

String org.osgi.framework.Version.getQualifier (  ) 

Returns the qualifier component of this version identifier.

Returns:
The qualifier component.

Definition at line 243 of file Version.java.

String org.osgi.framework.Version.toString (  ) 

Returns the string representation of this version identifier.

The format of the version string will be major.minor.micro if qualifier is the empty string or major.minor.micro.qualifier otherwise.

Returns:
The string representation of this version identifier.

Definition at line 257 of file Version.java.

Referenced by org.knopflerfish.framework.ExportedPackageImpl.getSpecificationVersion(), org.knopflerfish.framework.ImportPkg.ImportPkg(), and org.knopflerfish.framework.VersionRange.toString().

int org.osgi.framework.Version.hashCode (  ) 

Returns a hash code value for the object.

Returns:
An integer which is a hash code value for this object.

Definition at line 272 of file Version.java.

Referenced by org.knopflerfish.framework.VersionRange.hashCode().

boolean org.osgi.framework.Version.equals ( Object  object  ) 

Compares this Version object to another object.

A version is considered to be equal to another version if the major, minor and micro components are equal and the qualifier component is equal (using String.equals).

Parameters:
object The Version object to be compared.
Returns:
true if object is a Version and is equal to this object; false otherwise.

Definition at line 290 of file Version.java.

References org.osgi.framework.Version.major, org.osgi.framework.Version.micro, org.osgi.framework.Version.minor, and org.osgi.framework.Version.qualifier.

Referenced by org.knopflerfish.framework.VersionRange.equals(), org.knopflerfish.framework.ExportPkg.ExportPkg(), and org.knopflerfish.framework.Bundles.getBundle().

int org.osgi.framework.Version.compareTo ( Object  object  ) 

Compares this Version object to another object.

A version is considered to be less than another version if its major component is less than the other version's major component, or the major components are equal and its minor component is less than the other version's minor component, or the major and minor components are equal and its micro component is less than the other version's micro component, or the major, minor and micro components are equal and it's qualifier component is less than the other version's qualifier component (using String.compareTo).

A version is considered to be equal to another version if the major, minor and micro components are equal and the qualifier component is equal (using String.compareTo).

Parameters:
object The Version object to be compared.
Returns:
A negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified Version object.
Exceptions:
ClassCastException If the specified object is not a Version.

Definition at line 329 of file Version.java.

References org.osgi.framework.Version.major, org.osgi.framework.Version.micro, org.osgi.framework.Version.minor, and org.osgi.framework.Version.qualifier.

Referenced by org.knopflerfish.framework.VersionRange.compareTo(), org.knopflerfish.framework.Bundles.getBundles(), and org.knopflerfish.framework.VersionRange.withinRange().


Member Data Documentation

final Version org.osgi.framework.Version.emptyVersion = new Version(0, 0, 0) [static]

The empty version "0.0.0".

Equivalent to calling new Version(0,0,0).

Definition at line 55 of file Version.java.

Referenced by org.knopflerfish.framework.ImportPkg.ImportPkg(), org.osgi.framework.Version.parseVersion(), org.knopflerfish.framework.ExportPkg.pkgString(), and org.knopflerfish.framework.VersionRange.VersionRange().


The documentation for this class was generated from the following file:
Generated on Mon Jan 11 21:19:24 2010 for OpenMobileIS by  doxygen 1.5.4