tuwien.auto.calimero.Settings Maven / Gradle / Ivy
Show all versions of calimero-core Show documentation
/*
Calimero 2 - A library for KNX network access
Copyright (c) 2006, 2015 B. Malinowsky
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under terms
of your choice, provided that you also meet, for each linked independent
module, the terms and conditions of the license of that module. An
independent module is a module which is not derived from or based on
this library. If you modify this library, you may extend this exception
to your version of the library, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from your
version.
*/
package tuwien.auto.calimero;
/**
* General settings used in Calimero 2 as well as library user information.
*
* @author B. Malinowsky
*/
public final class Settings
{
private static final String version = "2.3-beta";
private static final String library = "Calimero 2";
private static final String desc = "A library for KNX network access";
private static final String tuwien = "Vienna University of Technology";
private static final String group = "Automation Systems Group";
private static final String copyright = "(c) 2007-2016";
// aligns the bundle package name following the friendly name,
// works for friendly name with max length of 20 chars
private static final String bundleAlignment = " ";
// just use newline, it's easier to deal with
private static final String sep = "\n";
private Settings()
{}
/**
* Returns the core library version as string representation.
*
* The returned version is formatted something similar to
* "main.minor[.milli][-phase]", for example, "2.0" or "2.0.0-alpha".
*
* @return version as string
*/
public static String getLibraryVersion()
{
return version;
}
/**
* 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.
*
* @param verbose true to return all header information just mentioned,
* false to only return library name and version comprised of
* one line (no line separators)
* @return header as string
*/
public static String getLibraryHeader(final boolean verbose)
{
if (!verbose)
return library + " version " + version;
final StringBuffer buf = new StringBuffer();
buf.append(library).append(" - ").append(desc).append(sep);
buf.append("Version ").append(version).append(sep);
buf.append(group).append(", ");
buf.append(tuwien).append(sep);
buf.append(copyright);
return buf.toString();
}
/**
* Returns a listing containing all library bundles, stating each 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.
*
* @return the bundle listing as string
*/
public static String getBundleListing()
{
final StringBuffer buf = new StringBuffer();
buf.append(getBundle("log service", "tuwien.auto.calimero.log.LogService", 1)
+ sep);
buf.append(getBundle("cEMI", "tuwien.auto.calimero.cemi.CEMI", 1)).append(sep);
buf.append(getBundle("KNXnet/IP",
"tuwien.auto.calimero.knxnetip.KNXnetIPConnection", 1)).append(sep);
buf.append(getBundle("serial", "tuwien.auto.calimero.serial.FT12Connection", 1))
.append(sep);
buf.append(getBundle("KNX network link",
"tuwien.auto.calimero.link.KNXNetworkLink", 1)).append(sep);
buf.append(getBundle("DPT translators",
"tuwien.auto.calimero.dptxlator.DPTXlator", 1)).append(sep);
buf.append(getBundle("datapoints", "tuwien.auto.calimero.datapoint.Datapoint",
1)).append(sep);
buf.append(getBundle("network buffer",
"tuwien.auto.calimero.buffer.NetworkBuffer", 1)).append(sep);
buf.append(getBundle("process", "tuwien.auto.calimero.process."
+ "ProcessCommunicator", 1) + sep);
buf.append(getBundle("management", "tuwien.auto.calimero.mgmt.ManagementClient",
1)).append(sep);
buf.append(getBundle("XML", "tuwien.auto.calimero.xml.def.DefaultXMLReader", 2));
return buf.toString();
}
/**
* 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
*
*
* @param args argument list with options controlling output information
*/
public static void main(final String[] args)
{
if (args.length > 0 && (args[0].equals("--version") || args[0].equals("-v")))
out(getLibraryHeader(false));
else {
out(getLibraryHeader(true));
out(sep + "Available bundles:");
out(getBundleListing());
}
}
/**
* This constant is for library internal use only: development mode identifier.
*/
public static final int DEV_MODE = 1;
/**
* This constant is for library internal use only: deployed mode identifier.
*/
public static final int DEPLOY_MODE = 0;
/**
* Library internal use only.
*
* Used for development and debugging purposes, users of the library should not depend
* on this function.
*
* Querying library mode allows library functions to adapt its behavior, e.g.,
* provide additional logging output.
*
* @return the current library mode
*/
public static int getLibraryMode()
{
return DEV_MODE;
}
// for now, this works by loading one class as representative from a bundle
// to check availability, then class name is truncated to bundle id
private static String getBundle(final String friendlyName, final String className,
final int truncate)
{
try {
final ClassLoader cl = Settings.class.getClassLoader();
cl.loadClass(className);
int start = className.length();
for (int i = 0; i < truncate; ++i)
start = className.lastIndexOf('.', start - 1);
final String bundle = className.substring(0, start);
return "+ " + friendlyName + align(friendlyName) + "- " + bundle;
}
catch (final ClassNotFoundException e) {}
catch (final NoClassDefFoundError e) {}
return "- " + friendlyName + align(friendlyName) + "- not available";
}
private static String align(final String friendlyName)
{
return bundleAlignment.substring(friendlyName.length());
}
private static void out(final String s)
{
System.out.println(s);
}
}