LibMuse 6.0.2
com.choosemuse.libmuse.ApiVersion Class Referenceabstract

Public Member Functions

abstract long getMonotonic ()
 
abstract long getMajor ()
 
abstract long getMinor ()
 
abstract long getPatch ()
 
abstract long getApi ()
 
abstract String getString ()
 

Detailed Description

Library version interface.

Describes the version of LibMuse.

Member Function Documentation

§ getApi()

abstract long com.choosemuse.libmuse.ApiVersion.getApi ( )
abstract

API

This number is incremented when changes are introduced to the API that are not backwards compatible.

Returns
The API version.

§ getMajor()

abstract long com.choosemuse.libmuse.ApiVersion.getMajor ( )
abstract

Major release.

This number is incremented on a major release of new functionality.

Returns
The major version.

§ getMinor()

abstract long com.choosemuse.libmuse.ApiVersion.getMinor ( )
abstract

Minor release.

This number is incremented when minor changes are made that are backwards compatible.

Returns
The minor version.

§ getMonotonic()

abstract long com.choosemuse.libmuse.ApiVersion.getMonotonic ( )
abstract

Returns a monotonically increasing version number.

This number is guaranteed to increase from release to release. Currently it is equivalent to:

get_major() * 1000000 + get_minor() * 10000 + get_patch() * 100 + get_api()

So for major = 5, minor = 1, patch = 3, api = 2, it would be 5010302.

§ getPatch()

abstract long com.choosemuse.libmuse.ApiVersion.getPatch ( )
abstract

Patch release.

This number is incremented when backwards-compatible bugfixes are made.

Returns
The patch version.

§ getString()

abstract String com.choosemuse.libmuse.ApiVersion.getString ( )
abstract

String representation of the version.

This is a string like "x.y.z API Version j" where x is get_major(), y is get_minor(), z is get_patch() and j is get_api(). The format may change from release to release. In particular, don't make assumptions about it or try to parse it. Use the other API calls on this interface to get the numerical versions.

Returns
The version string.

The documentation for this class was generated from the following file: