org.modelio.vbasic.version

Class Version

java.lang.Object

org.modelio.vbasic.version.Version

All Implemented Interfaces:

Comparable<Version>

public class Version
extends Object
implements Comparable<Version>

Version identifier for Modelio and modules.

Version identifiers have three components:

• Major version
• Minor version
• Build version

Two Versions are considered equal if all components are equal.

Constructor Summary

Constructors

Constructor and Description
Version(int major, int minor, int build) Instantiate a new Version from its component. The standard format is Major.Minor.Build.Metamodel.
Version(String versionString) Instantiate a new Version from a String.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Version other)
boolean	equals(Object anObject) Compares this Version to the specified object.
int	getBuildVersion() Get the build number of this version
int	getMajorVersion() Get the major number of this version.
int	getMinorVersion() Get the minor number of this version.
int	hashCode()
boolean	isNewerThan(Version other) Check if this Version is strictly newer than the given Version.
boolean	isOlderThan(Version other) Check if this Version is strictly older than the given Version.
String	toString() Provides a formatted string representation of the version.
String	toString(String format) Provides a formatted string representation of the version.

Methods inherited from class java.lang.Object

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

Constructor Detail

Version

public Version(int major,
               int minor,
               int build)

Instantiate a new Version from its component.
The standard format is Major.Minor.Build.Metamodel.

Parameters:

major - the first component of the version.

minor - the second component of the version.

build - the third component of the version.

Version

public Version(String versionString)
        throws NumberFormatException

Instantiate a new Version from a String. The standard format is Major.Minor.Build.Metamodel.

Parameters:

versionString - The String to parse to create the version.

Throws:

NumberFormatException - thrown when the parameter doesn't have a valid format.

Method Detail

equals

public boolean equals(Object anObject)

Compares this Version to the specified object.

The result is true if and only if the argument is not null and is a Version object that represents the same version object as this object.

Two Versions are considered equal if the only difference is one of their metamodel version being zero.

Overrides:

equals in class Object

Parameters:

anObject - The object to compare this Version against.

Returns:

true if the given object represents a Version equivalent to this Version, false otherwise.

getBuildVersion

public int getBuildVersion()

Get the build number of this version

Returns:

the build number of this version.

getMajorVersion

public int getMajorVersion()

Get the major number of this version.

Returns:

the major number of this version.

getMinorVersion

public int getMinorVersion()

Get the minor number of this version.

Returns:

the minor number of this version.

isNewerThan

public boolean isNewerThan(Version other)

Check if this Version is strictly newer than the given Version.

Two Versions are considered equal if the only difference is one of their metamodel version being zero.

Parameters:

other - the Version object that must be compared to this Version.

Returns:

true if this is newer than the given version.

isOlderThan

public boolean isOlderThan(Version other)

Check if this Version is strictly older than the given Version.

Two Versions are considered equal if the only difference is one of their metamodel version being zero.

Parameters:

other - the Version object that must be compared to this Version.

Returns:

true if this is older than the given version.

toString

public String toString()

Provides a formatted string representation of the version.

The format is: V.R.CC.mmmm where:

• V is the major version number (one or more digits)
• R is the minor version number (one or more digits)
• CC is the correction level (0-padded to 2 digits)
• mmmm is the metamodel version (4 digits)

Overrides:

toString in class Object

Returns:

the formatted string representation of the version.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString(String format)

Provides a formatted string representation of the version.

Parameters:

format -

The format is: VRCM where:

• V means 'prints the major version number' (one or more digits)
• R means 'prints the minor version number (one or more digits)
• C means 'print the correction level (0-padded to 2 digits)
• other chars are just inserted in the resulting string. There is no way of escaping characters VRC and M

example: if version is 3.0.01.9013 version.toString("V.R") will produce 3.0 version.toString("V.R-C") will produce 3.0-01

Returns:

the formatted string representation of the version.

compareTo

public int compareTo(Version other)

Specified by:

compareTo in interface Comparable<Version>