com.aspc.remote.util.misc

Class CProperties

java.lang.Object

com.aspc.remote.util.misc.CProperties

public final class CProperties
extends java.lang.Object

Allows a properties file before the properties are required
THREAD MODE: MULTI-THREADED

Since:

19 March2004

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_DOC_ROOT_PATH Root document directory path property name
static java.lang.String	PROPERTY_DISABLE Disable the feature
static java.lang.String	PROPERTY_ENABLE enable the feature
static java.lang.String	PROPERTY_PROP_FILE location of properties file
static java.lang.String	PROPERTY_REQUEST_TIMEOUT cservlet request timeout
static java.lang.String	ST_HOME Home directory path property name

Method Summary

Modifier and Type	Method and Description
static java.lang.String	findProperty(java.lang.String name) Return specified property value.
static java.lang.String	findProperty(java.lang.String name, java.lang.String defaultValue) Return specified property value.
static java.lang.String	getDocRoot() Get value for DOC_ROOT.
static java.lang.String	getHomeDir() Get the current home setting
static java.lang.String	getProperty(java.lang.String name) Return specified property value.
static java.lang.String	getProperty(java.lang.String name, java.lang.String defaultValue) Return specified property value.
static boolean	hasProperty(java.lang.String name) Determines if the property list contains a setting for a property
static boolean	isDisabled(java.lang.String module) Has this module been disabled.
static boolean	isMac() is Mac?
static boolean	isUnix() is UNIX ?
static void	reloadProperties() Forces reload of properties

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_DISABLE

public static final java.lang.String PROPERTY_DISABLE

Disable the feature

See Also:

Constant Field Values

PROPERTY_ENABLE

public static final java.lang.String PROPERTY_ENABLE

enable the feature

See Also:

Constant Field Values

PROPERTY_PROP_FILE

public static final java.lang.String PROPERTY_PROP_FILE

location of properties file

See Also:

Constant Field Values

PROPERTY_REQUEST_TIMEOUT

public static final java.lang.String PROPERTY_REQUEST_TIMEOUT

cservlet request timeout

See Also:

Constant Field Values

ST_HOME

public static final java.lang.String ST_HOME

Home directory path property name

See Also:

Constant Field Values

DEFAULT_DOC_ROOT_PATH

public static final java.lang.String DEFAULT_DOC_ROOT_PATH

Root document directory path property name

See Also:

Constant Field Values

Method Detail

isDisabled

@CheckReturnValue
public static boolean isDisabled(@Nonnull
                                                   java.lang.String module)

Has this module been disabled.

Parameters:

module - The module to check

Returns:

true if disabled.

isUnix

@CheckReturnValue
public static boolean isUnix()

is UNIX ?

Returns:

true if Unix

isMac

@CheckReturnValue
public static boolean isMac()

is Mac?

Returns:

true if Unix

getProperty

@CheckReturnValue
 @Nullable
public static java.lang.String getProperty(@Nonnull
                                                                        java.lang.String name)

Return specified property value.

Parameters:

name - name of property

Returns:

the property value

findProperty

@CheckReturnValue
 @Nonnull
public static java.lang.String findProperty(@Nonnull
                                                                        java.lang.String name)

Return specified property value.

Parameters:

name - name of property

Returns:

the property value

findProperty

@CheckReturnValue
 @Nonnull
public static java.lang.String findProperty(@Nonnull
                                                                        java.lang.String name,
                                                                        @Nonnull
                                                                        java.lang.String defaultValue)

Return specified property value.

Parameters:

name - name of property

defaultValue - the default value

Returns:

the property value

getProperty

@CheckReturnValue
 @Nullable
public static java.lang.String getProperty(@Nonnull
                                                                        java.lang.String name,
                                                                        @Nullable
                                                                        java.lang.String defaultValue)

Return specified property value.

Parameters:

name - name of property

defaultValue - value to be returned if not value associated with supplied property

Returns:

the property value of default value if none found

hasProperty

@CheckReturnValue
public static boolean hasProperty(@Nonnull
                                                    java.lang.String name)

Determines if the property list contains a setting for a property

Parameters:

name - name of property to check

Returns:

true if the property list contains a setting for the supplied property name

reloadProperties

public static void reloadProperties()
                             throws java.io.IOException

Forces reload of properties

Throws:

java.io.IOException

getHomeDir

@Nonnull
 @CheckReturnValue
public static java.lang.String getHomeDir()

Get the current home setting

Returns:

the path of the home directory

getDocRoot

@CheckReturnValue
 @Nonnull
public static java.lang.String getDocRoot()

Get value for DOC_ROOT.

Returns:

the path of the document root directory