|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.dpml.lang.Version
This class is used to hold version information.
The version number is made up of three dot-separated fields: "major.minor.micro" The major, minor and micro fields are integer numbers represented in decimal notation and have the following meaning:
Field Summary | |
static Version |
NULL_VERSION
Version -1.0.0. |
Constructor Summary | |
Version(int major,
int minor,
int micro)
Create a new instance of a Version object with the
specified version numbers. |
Method Summary | |
int |
compareTo(Object o)
Compare two versions together according to the Comparable interface. |
boolean |
complies(Version other)
Check this Version against another for compliancy
(compatibility). |
boolean |
equals(Object other)
Indicates whether some other object is "equal to" this Version . |
boolean |
equals(Version other)
Check this Version against another for equality. |
int |
getMajor()
Retrieve major component of version. |
int |
getMicro()
Retrieve micro component of version. |
int |
getMinor()
Retrieve minor component of version. |
int |
hashCode()
Add a hashing function to ensure the Version object is treated as expected in hashmaps and sets. |
static Version |
parse(String version)
Parse a version out of a string. |
String |
toString()
Overload toString to report version correctly. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final Version NULL_VERSION
Constructor Detail |
public Version(int major, int minor, int micro)
Version
object with the
specified version numbers.
major
- This Version
major number.minor
- This Version
minor number.micro
- This Version
micro number.Method Detail |
public static Version parse(String version) throws NumberFormatException, IllegalArgumentException, NullPointerException
version
- The input version string
NumberFormatException
- if an error occurs
IllegalArgumentException
- if an error occurs
NullPointerException
- if the version argument is null
.public int getMajor()
public int getMinor()
public int getMicro()
public boolean equals(Version other)
Version
against another for equality.
If this Version
is compatible with the specified one, then
true is returned, otherwise false.
other
- The other Version
object to be compared with this
for equality.
Version
is compatible with the specified onepublic boolean equals(Object other)
Version
.
Returns true if the other object is an instance of Version
and has the same major, minor, and micro components.
other
- an Object
value
Version
public int hashCode()
public boolean complies(Version other)
Version
against another for compliancy
(compatibility).
If this Version
is compatible with the specified one, then
true is returned, otherwise false. Be careful when using
this method since, in example, version 1.3.7 is compliant to version
1.3.6, while the opposite is not.
The following example displays the expected behaviour and results of version.
final Version v1 = new Version( 1, 3, 6 ); final Version v2 = new Version( 1, 3, 7 ); final Version v3 = new Version( 1, 4, 0 ); final Version v4 = new Version( 2, 0, 1 ); assert( v1.complies( v1 ) ); assert( ! v1.complies( v2 ) ); assert( v2.complies( v1 ) ); assert( ! v1.complies( v3 ) ); assert( v3.complies( v1 ) ); assert( ! v1.complies( v4 ) ); assert( ! v4.complies( v1 ) );
other
- The other Version
object to be compared with this
for compliancy (compatibility).
Version
is compatible with the specified onepublic String toString()
public int compareTo(Object o) throws NullPointerException
Comparable
interface.
compareTo
in interface Comparable
o
- the other object
NullPointerException
- if the argument is null.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |