org.clapper.curn
Class Version

java.lang.Object
  org.clapper.curn.Version

public final class Version
extends java.lang.Object

Contains the software version for the org.clapper.util library. Also contains a main program which, invoked, displays the name of the API and the version on standard output.

Version:

$Revision: 6346 $

Author:

Copyright © 2004-2006 Brian M. Clapper

Field Summary

static java.lang.String	BUILD_INFO_BUNDLE_NAME The name of the resource bundle containing the build info.
static java.lang.String	VERSION_BUNDLE_NAME This class's bundle

Method Summary

static java.lang.String	getBuildID() Get the build ID.
static org.clapper.util.misc.BuildInfo	getBuildInfo() Get the BuildInfo object that holds the build information data.
static java.lang.String	getCopyright() Get the copyright.
static java.lang.String	getFullVersion() Get the full program version string, which contains the program name, the version number and the build ID string.
static java.lang.String	getFullVersion(java.util.Locale locale) Get the full program version string, which contains the program name, the version number and the build ID string.
static java.lang.String	getUtilityName() Get curn's official name, for display purposes.
static java.lang.String	getVersionNumber() Get just the version number string.
static java.lang.String	getWebSite() Get the web site where curn can be found.
static void	showBuildInfo() Display build information to standard output.
static void	showBuildInfo(java.io.PrintStream out) Display build information to the specified PrintStream.
static void	showBuildInfo(java.io.PrintWriter out) Display build information to the specified PrintWriter.
static void	showVersion() Display version information only to standard output.
static void	showVersion(java.io.PrintStream out) Display version information to the specified PrintStream.
static void	showVersion(java.io.PrintWriter out) Display version information to the specified PrintWriter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BUILD_INFO_BUNDLE_NAME

public static final java.lang.String BUILD_INFO_BUNDLE_NAME

The name of the resource bundle containing the build info.

See Also:

Constant Field Values

VERSION_BUNDLE_NAME

public static final java.lang.String VERSION_BUNDLE_NAME

This class's bundle

See Also:

Constant Field Values

Method Detail

getVersionNumber

public static java.lang.String getVersionNumber()

Get just the version number string.

Returns:

the version number string

See Also:

getFullVersion(java.util.Locale)

getUtilityName

public static java.lang.String getUtilityName()

Get curn's official name, for display purposes.

Returns:

the official name

getWebSite

public static java.lang.String getWebSite()

Get the web site where curn can be found.

Returns:

the web site string

getCopyright

public static java.lang.String getCopyright()

Get the copyright.

Returns:

the copyright string

getFullVersion

public static java.lang.String getFullVersion(java.util.Locale locale)

Get the full program version string, which contains the program name, the version number and the build ID string. This is the string that the showVersion() method displays.

Parameters:

locale - the locale to use, or null for the default

Returns:

the full version string

See Also:

showVersion(), showVersion(PrintWriter), showVersion(PrintStream), getVersionNumber()

getFullVersion

public static java.lang.String getFullVersion()

Get the full program version string, which contains the program name, the version number and the build ID string. This is the string that the showVersion() method displays. This method assumes the default locale.

Returns:

the full version string

See Also:

showVersion(), showVersion(PrintWriter), showVersion(PrintStream), getVersionNumber()

getBuildID

public static java.lang.String getBuildID()

Get the build ID. Calling this method is equivalent to:

getBuildInfo().getBuildID();

Returns:

the build ID string

See Also:

getBuildInfo()

showVersion

public static void showVersion()

Display version information only to standard output.

See Also:

showVersion(PrintWriter), showVersion(PrintStream)

showVersion

public static void showVersion(java.io.PrintWriter out)

Display version information to the specified PrintWriter.

Parameters:

out - where to write the version string

See Also:

showVersion(), showVersion(PrintStream)

showVersion

public static void showVersion(java.io.PrintStream out)

Display version information to the specified PrintStream.

Parameters:

out - where to write the version string

See Also:

showVersion(), showVersion(PrintWriter)

showBuildInfo

public static void showBuildInfo()

Display build information to standard output.

See Also:

showBuildInfo(PrintWriter), showBuildInfo(PrintStream), getBuildInfo()

showBuildInfo

public static void showBuildInfo(java.io.PrintStream out)

Display build information to the specified PrintStream.

Parameters:

out - where to write the build information

See Also:

showBuildInfo(), showBuildInfo(PrintWriter), getBuildInfo()

showBuildInfo

public static void showBuildInfo(java.io.PrintWriter out)

Display build information to the specified PrintWriter.

Parameters:

out - where to write the build information

See Also:

showBuildInfo(), showBuildInfo(PrintStream), getBuildInfo()

getBuildInfo

public static org.clapper.util.misc.BuildInfo getBuildInfo()

Get the BuildInfo object that holds the build information data.

Returns:

the BuildInfo object.

See Also:

showBuildInfo(), showBuildInfo(PrintStream), showBuildInfo(PrintWriter)