xdev.util.systemproperty

Interface SystemProperty<T>

Type Parameters:

T - type of the SystemProperty that is wrapped.

All Known Implementing Classes:

AbstractSystemProperty, BooleanSystemProperty, IntegerSystemProperty, LongSystemProperty, StringSystemProperty

public interface SystemProperty<T>

SystemProperty is a thin wrapper around the java system properties facility. It provides type-safe access to a system property and is aware of the name of that property.

Since:

3.2

Author:

XDEV Software (RHHF)

Method Summary

Modifier and Type	Method and Description
void	clear() Removes the system property from the system property set.
String	getName() Returns the name of the system property that is wrapped by this SystemProperty instance.
T	getValue() Determines the value of the system property specified by getName().
T	getValue(T defaultValue) Determines the value of the system property specified by getName().
String	setValue(T value) Sets the system property specified by getName().

Method Detail

getValue

T getValue()

Determines the value of the system property specified by getName().

Returns:

the value of the property. null if the specified system property was not found or the value could not be parsed.

getValue

T getValue(T defaultValue)

Determines the value of the system property specified by getName().

Parameters:

defaultValue - will be returned if the specified system property was not found.

Returns:

the value of the property. defaultValue if the specified system property was not found or the value could not be parsed.

getName

String getName()

Returns the name of the system property that is wrapped by this SystemProperty instance.

Returns:

the name of the system property that is wrapped by this SystemProperty instance.

setValue

String setValue(T value)
         throws SecurityException,
                NullPointerException,
                IllegalArgumentException

Sets the system property specified by getName().

First, if a security manager exists, its SecurityManager.checkPermission method is called with a PropertyPermission(key, "write") permission. This may result in a SecurityException being thrown. If no exception is thrown, the specified property is set to the given value.

Parameters:

value - the value of the system property.

Returns:

the previous value of the system property, or null if it did not have one.

Throws:

SecurityException - if a security manager exists and its checkPermission method doesn't allow setting of the specified property.

NullPointerException - if getName() or value is null.

IllegalArgumentException - if getName() is empty.

clear

void clear()

Removes the system property from the system property set.