org.jplate.foundation.util
Class SystemProperties

java.lang.Object
  extended by org.jplate.foundation.util.SystemProperties

public final class SystemProperties
extends java.lang.Object

Represents non-synchronized read-only access to system properties. Commonly used system properties are defined here as public static strings thereby eliminating calling System.getProperties ( <property name> ) - eliminates a method call as well as a call to a synchronized collection (namely Properties which is a subclass of Hashtable ).

Please note: system properties are read and stored at class load time.

Modifications:
    $Date: 2008-12-02 12:32:45 -0500 (Tue, 02 Dec 2008) $
    $Revision: 479 $
    $Author: sfloess $ 
$HeadURL: https://jplate.svn.sourceforge.net/svnroot/jplate/trunk/src/dev/java/org/jplate/foundation/util/SystemProperties.java $


Field Summary
private static java.util.Map<java.lang.String,java.lang.String> _systemProperties
          Holds the system properties in a non-synchronized collection.
static java.lang.String CLASS_PATH
          Access to class path so one does not have to query a collection....
static java.lang.String CLASS_PATH_PROPERTY
          Class path property name.
static java.lang.String CLASS_VERSION
          Access to class version so one does not have to query a collection....
static java.lang.String CLASS_VERSION_PROPERTY
          Class version property name.
private static java.lang.String DEFAULT_NEW_LINE
          Default new line.
static java.lang.String FILE_SEPARATOR
          Access to file separator so one does not have to query a collection....
static java.lang.String FILE_SEPARATOR_PROPERTY
          File separator property name.
static java.lang.String JAVA_HOME
          Access to java home so one does not have to query a collection....
static java.lang.String JAVA_HOME_PROPERTY
          Java home property name.
static java.lang.String JAVA_VENDOR
          Access to java vendor so one does not have to query a collection....
static java.lang.String JAVA_VENDOR_PROPERTY
          Java vendor property name.
static java.lang.String JAVA_VENDOR_URL
          Access to java vendor URL so one does not have to query a collection....
static java.lang.String JAVA_VENDOR_URL_PROPERTY
          Java vendor URL property name.
static java.lang.String JAVA_VERSION
          Access to java version so one does not have to query a collection....
static java.lang.String JAVA_VERSION_PROPERTY
          Java version property name.
static java.lang.String LINE_SEPARATOR
          Access to line separator so one does not have to query a collection....
static java.lang.String LINE_SEPARATOR_PROPERTY
          Line separator property name.
static java.lang.String OS_ARCHITECTURE
          Access to operating system architecture so one does not have to query a collection....
static java.lang.String OS_ARCHITECTURE_PROPERTY
          Operating system architecture property name.
static java.lang.String OS_NAME
          Access to operating system name so one does not have to query a collection....
static java.lang.String OS_NAME_PROPERTY
          Operating system name property name.
static java.lang.String OS_VERSION
          Access to operating system version so one does not have to query a collection....
static java.lang.String OS_VERSION_PROPERTY
          Operating system version property name.
static java.lang.String PATH_SEPARATOR
          Access to path separator so one does not have to query a collection....
static java.lang.String PATH_SEPARATOR_PROPERTY
          Path separator property name.
static java.lang.String USER_DIR
          Access to current working user dir so one does not have to query a collection....
static java.lang.String USER_DIR_PROPERTY
          Current working user dir property name.
static java.lang.String USER_HOME
          Access to user home so one does not have to query a collection....
static java.lang.String USER_HOME_PROPERTY
          User home property name.
static java.lang.String USER_NAME
          Access to user name so one does not have to query a collection....
static java.lang.String USER_NAME_PROPERTY
          User name property name.
 
Constructor Summary
private SystemProperties()
          Default constructor not allowed.
 
Method Summary
static java.lang.String getProperty(java.lang.String name)
          Return a property value for the property entitled name or null if one does not exist.
static java.lang.String getProperty(java.lang.String name, java.lang.String defaultValue)
          Return a property value for property name or defaultValue if one does not exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_systemProperties

private static final java.util.Map<java.lang.String,java.lang.String> _systemProperties
Holds the system properties in a non-synchronized collection.


LINE_SEPARATOR_PROPERTY

public static final java.lang.String LINE_SEPARATOR_PROPERTY
Line separator property name.

See Also:
Constant Field Values

DEFAULT_NEW_LINE

private static final java.lang.String DEFAULT_NEW_LINE
Default new line.

See Also:
Constant Field Values

FILE_SEPARATOR_PROPERTY

public static final java.lang.String FILE_SEPARATOR_PROPERTY
File separator property name.

See Also:
Constant Field Values

CLASS_PATH_PROPERTY

public static final java.lang.String CLASS_PATH_PROPERTY
Class path property name.

See Also:
Constant Field Values

CLASS_VERSION_PROPERTY

public static final java.lang.String CLASS_VERSION_PROPERTY
Class version property name.

See Also:
Constant Field Values

JAVA_HOME_PROPERTY

public static final java.lang.String JAVA_HOME_PROPERTY
Java home property name.

See Also:
Constant Field Values

JAVA_VENDOR_PROPERTY

public static final java.lang.String JAVA_VENDOR_PROPERTY
Java vendor property name.

See Also:
Constant Field Values

JAVA_VENDOR_URL_PROPERTY

public static final java.lang.String JAVA_VENDOR_URL_PROPERTY
Java vendor URL property name.

See Also:
Constant Field Values

JAVA_VERSION_PROPERTY

public static final java.lang.String JAVA_VERSION_PROPERTY
Java version property name.

See Also:
Constant Field Values

OS_ARCHITECTURE_PROPERTY

public static final java.lang.String OS_ARCHITECTURE_PROPERTY
Operating system architecture property name.

See Also:
Constant Field Values

OS_NAME_PROPERTY

public static final java.lang.String OS_NAME_PROPERTY
Operating system name property name.

See Also:
Constant Field Values

OS_VERSION_PROPERTY

public static final java.lang.String OS_VERSION_PROPERTY
Operating system version property name.

See Also:
Constant Field Values

PATH_SEPARATOR_PROPERTY

public static final java.lang.String PATH_SEPARATOR_PROPERTY
Path separator property name.

See Also:
Constant Field Values

USER_DIR_PROPERTY

public static final java.lang.String USER_DIR_PROPERTY
Current working user dir property name.

See Also:
Constant Field Values

USER_HOME_PROPERTY

public static final java.lang.String USER_HOME_PROPERTY
User home property name.

See Also:
Constant Field Values

USER_NAME_PROPERTY

public static final java.lang.String USER_NAME_PROPERTY
User name property name.

See Also:
Constant Field Values

LINE_SEPARATOR

public static final java.lang.String LINE_SEPARATOR
Access to line separator so one does not have to query a collection....


FILE_SEPARATOR

public static final java.lang.String FILE_SEPARATOR
Access to file separator so one does not have to query a collection....


CLASS_PATH

public static final java.lang.String CLASS_PATH
Access to class path so one does not have to query a collection....


CLASS_VERSION

public static final java.lang.String CLASS_VERSION
Access to class version so one does not have to query a collection....


JAVA_HOME

public static final java.lang.String JAVA_HOME
Access to java home so one does not have to query a collection....


JAVA_VENDOR

public static final java.lang.String JAVA_VENDOR
Access to java vendor so one does not have to query a collection....


JAVA_VENDOR_URL

public static final java.lang.String JAVA_VENDOR_URL
Access to java vendor URL so one does not have to query a collection....


JAVA_VERSION

public static final java.lang.String JAVA_VERSION
Access to java version so one does not have to query a collection....


OS_ARCHITECTURE

public static final java.lang.String OS_ARCHITECTURE
Access to operating system architecture so one does not have to query a collection....


OS_NAME

public static final java.lang.String OS_NAME
Access to operating system name so one does not have to query a collection....


OS_VERSION

public static final java.lang.String OS_VERSION
Access to operating system version so one does not have to query a collection....


PATH_SEPARATOR

public static final java.lang.String PATH_SEPARATOR
Access to path separator so one does not have to query a collection....


USER_DIR

public static final java.lang.String USER_DIR
Access to current working user dir so one does not have to query a collection....


USER_HOME

public static final java.lang.String USER_HOME
Access to user home so one does not have to query a collection....


USER_NAME

public static final java.lang.String USER_NAME
Access to user name so one does not have to query a collection....

Constructor Detail

SystemProperties

private SystemProperties()
Default constructor not allowed.

Throws:
java.lang.UnsupportedOperationException - if this constructor is called.
Method Detail

getProperty

public static java.lang.String getProperty(java.lang.String name)
Return a property value for the property entitled name or null if one does not exist.

Parameters:
name - The property name for which a value is to be sought.
Returns:
null If no property exists whose name is name.

getProperty

public static java.lang.String getProperty(java.lang.String name,
                                           java.lang.String defaultValue)
Return a property value for property name or defaultValue if one does not exist.

Parameters:
name - The property name for which a value is to be sought.
defaultValue - The value to return if no property value exists for name.
Returns:
The value for name or defaultValue if no property exists whose name is name.