Package org.cytoscape.application

Interface CyVersion

public interface CyVersion
An interface providing access to version information about this version of the Cytoscape application. Cytoscape strives to follow the Semantic Versioning standard to ensure comprehensible backwards compatibility versioning.

Module: application-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>application-api</artifactId>
</dependency>

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static String
    VERSION_PROPERTY_NAME
    Deprecated.
    static String
    VERSION_REGEX
    The regular expression used to test the property version string.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getBugFixVersion()
    The third of the three numbers defining the version of the software, meaning "5" if the version is "3.2.5".
    int
    getMajorVersion()
    The first of the three numbers defining the version of the software, meaning "3" if the version is "3.2.5".
    int
    getMinorVersion()
    The second of the three numbers defining the version of the software, meaning "2" if the version is "3.2.5".
    String
    getQualifier()
    Any text following the last digit of the bug fix version.
    String
    getVersion()
    The full version as a string, for example "3.2.5-alpha".

  • Field Details

    • VERSION_PROPERTY_NAME

      @Deprecated static final String VERSION_PROPERTY_NAME
      Deprecated.
      The string used to identify the Property containing the version number.
      See Also:
      Constant Field Values

    • VERSION_REGEX

      static final String VERSION_REGEX
      The regular expression used to test the property version string.
      See Also:
      Constant Field Values

  • Method Details

    • getVersion

      String getVersion()
      The full version as a string, for example "3.2.5-alpha".
      Returns:
      the full version as a string.

    • getMajorVersion

      int getMajorVersion()
      The first of the three numbers defining the version of the software, meaning "3" if the version is "3.2.5". This number changes only for comprehensive software changes and while APIs may be similar between versions, they are not guaranteed to be compatible.
      Returns:
      The integer describing the major version of this application.

    • getMinorVersion

      int getMinorVersion()
      The second of the three numbers defining the version of the software, meaning "2" if the version is "3.2.5". This number changes as new functionality or a new API is added to the software. Minor version APIs are guaranteed to be backwards compatible for all previous versions within the major version (i.e. version 3.2 will be completely compatible with all 3.1.x, and 3.0.x code).
      Returns:
      The integer describing the minor version of this application.

    • getBugFixVersion

      int getBugFixVersion()
      The third of the three numbers defining the version of the software, meaning "5" if the version is "3.2.5". This number changes as bug fixes are made but no new features or APIs are added. Bug fix versions contain NO NEW FEATRURES! Bug fix version APIs are guaranteed to be backwards compatible for all previous versions within the major version (i.e. version 3.2.5 will be completely compatible with all 3.x versions of the code).
      Returns:
      The integer describing the bug fix version of this application.

    • getQualifier

      String getQualifier()
      Any text following the last digit of the bug fix version. If the version is 3.0.2-beta1 then the qualifier will be "-beta1". Final (stable) versions of the application should not include any qualifying information. All qualifying text indicates a pre-release, an unstable release, or unfinished release.
      Returns:
      Any text following the last digit of the bug fix version.