tuwien.auto.calimero
Class Settings

java.lang.Object
  tuwien.auto.calimero.Settings

public final class Settings
extends java.lang.Object

General settings used in Calimero as well as Calimero related user information.

Method Summary

static java.lang.String	getBundleListing() Returns a listing containing all library bundles stating the bundle's presence for use.
static java.lang.String	getLibraryHeader(boolean verbose) Returns a default library header representation with general/usage information.
static java.lang.String	getLibraryVersion() Returns the Calimero library version as string representation.
static void	main(java.lang.String[] args) This entry routine of the library prints information to the standard output stream (System.out), mainly for user information.

Methods inherited from class java.lang.Object

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

Method Detail

getBundleListing

public static java.lang.String getBundleListing()

Returns a listing containing all library bundles stating the bundle's presence for use.

For loading a bundle, the default system class loader is used. A bundle is present if it can be loaded using the class loader, otherwise it is considered not available for use.
An available bundle entry starts with a '+' and consists of a short bundle name and the base package identifier string, a bundle not present starts with '-' and consists of a short name and is marked with the suffix "- not available".
The bundle entries in the returned string are separated using the newline ('\n') character.

Returns:

the bundle listing as string

getLibraryHeader

public static java.lang.String getLibraryHeader(boolean verbose)

Returns a default library header representation with general/usage information.

It includes stuff like the library name, library version, name and institute of the 'Vienna University of Technology' where the library was developed, and copyright. The returned information parts are divided using the newline ('\n') character.

Parameters:

verbose - true to return all header information just mentioned, false to only return library name and version comprised of one line (no line separators)

Returns:

header as string

getLibraryVersion

public static java.lang.String getLibraryVersion()

Returns the Calimero library version as string representation.

The returned version is formatted something similar to "main.minor[.milli][-phase]", for example "2.0.0-alpha".

Returns:

version as string

main

public static void main(java.lang.String[] args)

This entry routine of the library prints information to the standard output stream (System.out), mainly for user information.

Recognized options for output:

• no options: default library header information and bundle listing
• -v, --version: prints library name and version

Parameters:

args - argument list with options controlling output information