enterprises.orbital.base

Class OrbitalProperties

java.lang.Object

enterprises.orbital.base.OrbitalProperties

public abstract class OrbitalProperties
extends Object

Simple java properties management. Property files can be added dynamically and will be loaded into an internal global Properties object. This class also provides other utilities such as:

• A call to determine whether asserts have been enabled at runtime.
• A time generator to serve time stamps. Can be replaced for unit tests.
• Typed property getters for boolean and longs.

This class is often used in conjunction with PersistentProperty to provide for persistent properties which can be backed by default values provided from properties files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OrbitalProperties.DateFormatGenerator
static interface	OrbitalProperties.TimeGenerator Interface to generate a time stamp.

Constructor Summary

Constructors

Constructor and Description
OrbitalProperties()

Method Summary

Modifier and Type	Method and Description
static void	addPropertyFile(String path) Add a properties file to the global set of properties.
static ThreadLocal<DateFormat>	dateFormatFactory(OrbitalProperties.DateFormatGenerator generator)
static boolean	getBooleanGlobalProperty(String key)
static boolean	getBooleanGlobalProperty(String key, boolean def)
static Date	getCurrentDate()
static long	getCurrentTime() Return current time as returned by the current time generator.
static String	getGlobalProperty(String key)
static String	getGlobalProperty(String key, String def)
static long	getLongGlobalProperty(String key)
static long	getLongGlobalProperty(String key, long def)
static int	getNonzeroLimited(int provided, int max) Convenience function to return a value in the range [1, max] where: max is returned if "provided" < 1 (that is, < 1 is treated as use available max); max is returned if "provided" > max; otherwise, "provided" is returned.
static String	getPropertyName(Class<?> caller, String attribute) Generate a standard property name for some attribute of a given class.
static boolean	isAssertEnabled()
static void	setGlobalProperty(String key, String value)
static void	setTimeGenerator(OrbitalProperties.TimeGenerator tg)

Methods inherited from class java.lang.Object

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

Constructor Detail

OrbitalProperties

public OrbitalProperties()

Method Detail

isAssertEnabled

public static boolean isAssertEnabled()

addPropertyFile

public static final void addPropertyFile(String path)
                                  throws IOException

Add a properties file to the global set of properties. Other modules should normally call this method early in their life cycle to add properties as needed. Note that we only allow each unique path to be loaded once to avoid excessive loading and overwrites. As a result, modules should use unique names for their load files.

Parameters:

path - path to properties file to load.

Throws:

IOException - if an error occurs while loading the file

getPropertyName

public static final String getPropertyName(Class<?> caller,
                                           String attribute)

Generate a standard property name for some attribute of a given class. This is used to normalize all class-specific property names to the form: "FQCN.attribute". For example, calling this method with (org.evekit.model.corporation.MemberTracking.class, "max_results") will yield: org.evekit.model.corporation.MemberTracking.attr.max_results

Parameters:

caller - the class to be used to form the fully qualified named bit.

attribute - the attribute name to tag onto the class.

Returns:

a normalized class-specific property name for the given class and attribute.

getNonzeroLimited

public static final int getNonzeroLimited(int provided,
                                          int max)

Convenience function to return a value in the range [1, max] where:

• max is returned if "provided" < 1 (that is, < 1 is treated as use available max);
• max is returned if "provided" > max;
• otherwise, "provided" is returned.

Parameters:

provided - value provided by a caller

max - maximum value to allow.

Returns:

a value in the range [1, max] as defined above.

setTimeGenerator

public static void setTimeGenerator(OrbitalProperties.TimeGenerator tg)

getCurrentTime

public static long getCurrentTime()

Return current time as returned by the current time generator.

Returns:

current time.

getCurrentDate

public static Date getCurrentDate()

setGlobalProperty

public static void setGlobalProperty(String key,
                                     String value)

getGlobalProperty

public static String getGlobalProperty(String key)

getGlobalProperty

public static String getGlobalProperty(String key,
                                       String def)

getBooleanGlobalProperty

public static boolean getBooleanGlobalProperty(String key)

getBooleanGlobalProperty

public static boolean getBooleanGlobalProperty(String key,
                                               boolean def)

getLongGlobalProperty

public static long getLongGlobalProperty(String key)

getLongGlobalProperty

public static long getLongGlobalProperty(String key,
                                         long def)

dateFormatFactory

public static ThreadLocal<DateFormat> dateFormatFactory(OrbitalProperties.DateFormatGenerator generator)