Class Geneious
- java.lang.Object
-
- com.biomatters.geneious.publicapi.plugin.Geneious
-
public final class Geneious extends java.lang.Object
General information about the Geneious Prime application.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Geneious.MajorVersion
Represents a major version number of Geneious (the first 2 numbers of the 3 number version number) for versions of Geneious from 6.0 onwards.
-
Constructor Summary
Constructors Constructor Description Geneious()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String
getApiVersion()
Current Geneious public API version (convenience function) Of the form x.y where x,y are integers.static int
getMajorApiVersion()
Major Geneious public API version.static Geneious.MajorVersion
getMajorVersion()
static int
getMinorApiVersion()
Minor Geneious public API version.static java.lang.String
getName()
Get the application name, "Geneious Prime".static java.net.URL
getServerResource(java.lang.String resource)
Gets a resource from the Geneious Server class which is used for resources that we want to make available to a plugin when it is running on the server but we do not to ship it with Geneiousstatic java.lang.String
getVersion()
Get the current Geneious version.static boolean
isClient()
static boolean
isCommandLine()
static boolean
isHeadless()
static boolean
isServer()
-
-
-
Method Detail
-
getName
public static java.lang.String getName()
Get the application name, "Geneious Prime".
-
getVersion
public static java.lang.String getVersion()
Get the current Geneious version.- Returns:
- the current Geneious version of the form x.y.z where x,y,z are integers.
-
getMajorVersion
public static Geneious.MajorVersion getMajorVersion()
- Returns:
- the major version for the currently running instance of Geneious.
- Since:
- API 4.600 (Geneious 6.0.0)
-
getApiVersion
public static java.lang.String getApiVersion()
Current Geneious public API version (convenience function) Of the form x.y where x,y are integers. This is just a concatenation ofgetMajorApiVersion()
and "." andgetMinorApiVersion()
- Returns:
- current Geneious public API version
-
getMajorApiVersion
public static int getMajorApiVersion()
Major Geneious public API version. This should change only very rarely (in fact we hope never) when we break backwards compatibility when introducing new changes to the public API.- Returns:
- the major version number
-
getMinorApiVersion
public static int getMinorApiVersion()
Minor Geneious public API version. Whenever we make a new release of Geneious that includes new additions to the public API, this value will be increased.- Returns:
- the minor version number
-
isClient
public static boolean isClient()
- Returns:
- true if running the Geneious client application rather than Geneious Server
- Since:
- API 4.14 (Geneious 5.1)
-
isServer
public static boolean isServer()
- Returns:
- true if running Geneious Server rather than the Geneious client
- Since:
- API 4.14 (Geneious 5.1)
-
getServerResource
public static java.net.URL getServerResource(java.lang.String resource)
Gets a resource from the Geneious Server class which is used for resources that we want to make available to a plugin when it is running on the server but we do not to ship it with Geneious- Parameters:
resource
- String name of hte resource- Returns:
- URL of resource or null if not found
- Since:
- API 4.50 (Geneious 5.5.0)
-
isHeadless
public static boolean isHeadless()
- Returns:
- true if Geneious is running in headless mode. The user interface is not started in this situation. Typically this means that either Geneious Server is running or that Geneious has been started to perform an operation on the command line and will exit when the operation is complete.
- Since:
- API 4.21 (Geneious 5.2.1)
-
isCommandLine
public static boolean isCommandLine()
- Returns:
- true if Geneious is running in Command Line Mode.
- Since:
- API 4.202200 (Geneious 2022.0.0)
-
-