com.atlassian.confluence.setup
Enum BuildInformation

java.lang.Object
  extended by java.lang.Enum<BuildInformation>
      extended by com.atlassian.confluence.setup.BuildInformation
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<BuildInformation>

public enum BuildInformation
extends java.lang.Enum<BuildInformation>

Singleton which provides build and version information for the Confluence application. Configuration is read from "com/atlassian/confluence/default.properties" on the classpath.

Note that the build number in the application's home directory or database may differ from the version of the application at various times. This object only represents the build information of the application itself.


Enum Constant Summary
INSTANCE
           
 
Method Summary
 java.util.Date getBuildDate()
           
 java.lang.String getBuildExcludedLocale()
           
 java.lang.String getBuildNumber()
           
 java.lang.String getBuildPartner()
           
 java.lang.String getRevisionNumber()
           
 java.lang.String getVersionNumber()
           
 java.lang.String toString()
           
static BuildInformation valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static BuildInformation[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

INSTANCE

public static final BuildInformation INSTANCE
Method Detail

values

public static BuildInformation[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (BuildInformation c : BuildInformation.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static BuildInformation valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getVersionNumber

public java.lang.String getVersionNumber()
Returns:
the version number of this release of Confluence. Components are generally separated by either dots or dashes. Pre-release versions include letters as well as numbers. Sample release versions: 2.0, 2.8.2. Sample pre-release versions: 3.0-SNAPSHOT, 2.9-m4, 2.10-rc1.

getBuildDate

public java.util.Date getBuildDate()
Returns:
the date this version of Confluence was built

getBuildNumber

public java.lang.String getBuildNumber()
Returns:
a unique number for each release of Confluence. Used primarily to manage the execution of upgrade tasks. May be a value like '@BUILD_NUMBER@' during development.

getRevisionNumber

public java.lang.String getRevisionNumber()
Returns:
the internal revision number of the code in Confluence's source control system, or null if the revision number is not available.

getBuildPartner

public java.lang.String getBuildPartner()
Returns:
the partner this release of Confluence was built for, or null if this is not a partner-specific build of Confluence

getBuildExcludedLocale

public java.lang.String getBuildExcludedLocale()
Returns:
the locales of language packs which cannot be used with this release of Confluence due to partner licensing agreements, or null if this is not a partner-specific build of Confluence

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Enum<BuildInformation>


Copyright © 2003-2010 Atlassian. All Rights Reserved.