org.apache.avalon.framework
Class Version

java.lang.Object
  |
  +--org.apache.avalon.framework.Version

public final class Version
extends java.lang.Object

This class is used to hold version information pertaining to a Component or interface.

The version number of a Component is made up of three dot-separated fields:

"major.minor.revision"

The major, minor and revision fields are integer numbers represented in decimal notation and have the following meaning:

Author:
Federico Barbieri, Pierpaolo Fumagalli, Stefano Mazzocchi, Roberto Lo Giacco, Peter Donald

Constructor Summary
Version(int major, int minor, int revision)
          Create a new instance of a Version object with the specified version numbers.
 
Method Summary
 boolean complies(Version other)
          Check this Version against another for compliancy (compatibility).
 boolean equals(Version other)
          Check this Version against another for equality.
 java.lang.String toString()
          Overload toString to report version correctly.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Version

public Version(int major,
               int minor,
               int revision)
Create a new instance of a Version object with the specified version numbers.
Parameters:
major - This Version major number.
minor - This Version minor number.
rev - This Version revision number.
Method Detail

equals

public boolean equals(Version other)
Check this Version against another for equality.

If this Version is compatible with the specified one, then true is returned, otherwise false.

Parameters:
other - The other Version object to be compared with this for equality.

complies

public boolean complies(Version other)
Check this 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 ) );
 
Parameters:
other - The other Version object to be compared with this for compliancy (compatibility).

toString

public java.lang.String toString()
Overload toString to report version correctly.
Overrides:
toString in class java.lang.Object
Returns:
the dot seperated version string


Copyright © 2001 Apache Jakarta Project. All Rights Reserved.