UserProperties

Inheritance: java.lang.Object, java.util.Dictionary, java.util.Hashtable, java.util.Properties

public class UserProperties extends Properties

Special property class which allows typed properties to be set and returned. It also allows the hookup of two default property objects to be searched if this property object does not contain the property.

Constructors

ConstructorDescription
UserProperties()Initializes an empty instance of UserProperties class.
UserProperties(Properties defaults)Initializes an of UserProperties class with default values.
UserProperties(Properties defaults, Properties altDefaults)Constructs UserProperties with a defaults and altDefaults table, which are searched in that order.

Methods

MethodDescription
propertyNames()Returns properties names.
printProperties()Prints all set properties.
setProperties(Properties properties)Copies properties, including its defaults into this UserProperties
setProperty(String key, String value)Sets string property value.
setProperty(String key, String[] value)Sets string array property value.
setProperty(Properties properties, String key, String[] value)Sets string array property value in specified properties table.
setProperty(String key, Color value)Sets color property value.
setProperty(Properties properties, String key, Color value)Sets color property value in specified properties table.
setProperty(String key, Rectangle value)Sets rectangle property value.
setProperty(Properties properties, String key, Rectangle value)Sets rectangle property value in specified properties table.
setProperty(String key, Insets value)Sets insets property value.
setProperty(Properties properties, String key, Insets value)Sets insets property value in specified properties table.
setProperty(String key, Dimension value)Sets dimension property value.
setProperty(Properties properties, String key, Dimension value)Sets dimension property value in specified properties table.
setProperty(String key, int value)Sets integer property value.
setProperty(Properties properties, String key, int value)Sets integer property value in specified properties table.
setProperty(String key, double value)Sets double property value.
setProperty(Properties properties, String key, double value)Sets double property value in specified properties table.
setProperty(String key, float value)Sets float property value.
setProperty(Properties properties, String key, float value)Sets float property value in specified properties table.
setProperty(String key, boolean value)Sets boolean property value.
setProperty(Properties properties, String key, boolean value)Sets boolean property value in specified properties table.
getProperty(String key)Gets string property value.
getProperty(String key, String def)Gets string property value.
getPropertyStringArray(String key)Gets string array property value.
getPropertyStringArray(String key, String[] def)Gets string array property value.
getPropertyColor(String key)Gets color property value.
getPropertyColor(String key, Color def)Gets color property value.
getPropertyRectangle(String key)Gets rectangle property value.
getPropertyRectangle(String key, Rectangle def)Gets rectangle property value.
getPropertyInsets(String key)Gets insets property value.
getPropertyInsets(String key, Insets def)Gets insets property value.
getPropertyDimension(String key)Gets dimension property value.
getPropertyDimension(String key, Dimension def)Gets dimension property value.
getPropertyInt(String key)Gets integer property value.
getPropertyInt(String key, int def)Gets integer property value.
getPropertyDouble(String key)Gets double property value.
getPropertyDouble(String key, double def)Gets double property value.
getPropertyFloat(String key)Gets float property value.
getPropertyFloat(String key, float def)Gets float property value.
isProperty(String key)Gets boolean property value.
isProperty(String key, boolean def)Gets boolean property value.

UserProperties()

public UserProperties()

Initializes an empty instance of UserProperties class.

UserProperties(Properties defaults)

public UserProperties(Properties defaults)

Initializes an of UserProperties class with default values.

Parameters:

ParameterTypeDescription
defaultsjava.util.PropertiesDefault properties values.

UserProperties(Properties defaults, Properties altDefaults)

public UserProperties(Properties defaults, Properties altDefaults)

Constructs UserProperties with a defaults and altDefaults table, which are searched in that order.

Parameters:

ParameterTypeDescription
defaultsjava.util.PropertiesDefault properties.
altDefaultsjava.util.PropertiesAlternative default properties.

propertyNames()

public Enumeration propertyNames()

Returns properties names.

Returns: java.util.Enumeration - Enumeration of properties names.

printProperties()

public void printProperties()

Prints all set properties.

setProperties(Properties properties)

public void setProperties(Properties properties)

Copies properties, including its defaults into this UserProperties

Parameters:

ParameterTypeDescription
propertiesjava.util.PropertiesProperties.

setProperty(String key, String value)

public Object setProperty(String key, String value)

Sets string property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
valuejava.lang.StringThe value of property.

Returns: java.lang.Object - A property.

setProperty(String key, String[] value)

public Object setProperty(String key, String[] value)

Sets string array property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
valuejava.lang.String[]The value of property.

Returns: java.lang.Object - A property.

setProperty(Properties properties, String key, String[] value)

public static Object setProperty(Properties properties, String key, String[] value)

Sets string array property value in specified properties table.

Parameters:

ParameterTypeDescription
propertiesjava.util.PropertiesThe properties table.
keyjava.lang.StringThe name of property.
valuejava.lang.String[]The value of property.

Returns: java.lang.Object - A property.

setProperty(String key, Color value)

public Object setProperty(String key, Color value)

Sets color property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
valuejava.awt.ColorThe value of property.

Returns: java.lang.Object - A property.

setProperty(Properties properties, String key, Color value)

public static Object setProperty(Properties properties, String key, Color value)

Sets color property value in specified properties table.

Parameters:

ParameterTypeDescription
propertiesjava.util.PropertiesThe properties table.
keyjava.lang.StringThe name of property.
valuejava.awt.ColorThe value of property.

Returns: java.lang.Object - A property.

setProperty(String key, Rectangle value)

public Object setProperty(String key, Rectangle value)

Sets rectangle property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
valuejava.awt.RectangleThe value of property.

Returns: java.lang.Object - A property.

setProperty(Properties properties, String key, Rectangle value)

public static Object setProperty(Properties properties, String key, Rectangle value)

Sets rectangle property value in specified properties table.

Parameters:

ParameterTypeDescription
propertiesjava.util.PropertiesThe properties table.
keyjava.lang.StringThe name of property.
valuejava.awt.RectangleThe value of property.

Returns: java.lang.Object - A property.

setProperty(String key, Insets value)

public Object setProperty(String key, Insets value)

Sets insets property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
valuejava.awt.InsetsThe value of property.

Returns: java.lang.Object - A property.

setProperty(Properties properties, String key, Insets value)

public static Object setProperty(Properties properties, String key, Insets value)

Sets insets property value in specified properties table.

Parameters:

ParameterTypeDescription
propertiesjava.util.PropertiesThe properties table.
keyjava.lang.StringThe name of property.
valuejava.awt.InsetsThe value of property.

Returns: java.lang.Object - A property.

setProperty(String key, Dimension value)

public Object setProperty(String key, Dimension value)

Sets dimension property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
valuejava.awt.DimensionThe value of property.

Returns: java.lang.Object - A property.

setProperty(Properties properties, String key, Dimension value)

public static Object setProperty(Properties properties, String key, Dimension value)

Sets dimension property value in specified properties table.

Parameters:

ParameterTypeDescription
propertiesjava.util.PropertiesThe properties table.
keyjava.lang.StringThe name of property.
valuejava.awt.DimensionThe value of property.

Returns: java.lang.Object - A property.

setProperty(String key, int value)

public Object setProperty(String key, int value)

Sets integer property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
valueintThe value of property.

Returns: java.lang.Object - A property.

setProperty(Properties properties, String key, int value)

public static Object setProperty(Properties properties, String key, int value)

Sets integer property value in specified properties table.

Parameters:

ParameterTypeDescription
propertiesjava.util.PropertiesThe properties table.
keyjava.lang.StringThe name of property.
valueintThe value of property.

Returns: java.lang.Object - A property.

setProperty(String key, double value)

public Object setProperty(String key, double value)

Sets double property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
valuedoubleThe value of property.

Returns: java.lang.Object - A property.

setProperty(Properties properties, String key, double value)

public static Object setProperty(Properties properties, String key, double value)

Sets double property value in specified properties table.

Parameters:

ParameterTypeDescription
propertiesjava.util.PropertiesThe properties table.
keyjava.lang.StringThe name of property.
valuedoubleThe value of property.

Returns: java.lang.Object - A property.

setProperty(String key, float value)

public Object setProperty(String key, float value)

Sets float property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
valuefloatThe value of property.

Returns: java.lang.Object - A property.

setProperty(Properties properties, String key, float value)

public static Object setProperty(Properties properties, String key, float value)

Sets float property value in specified properties table.

Parameters:

ParameterTypeDescription
propertiesjava.util.PropertiesThe properties table.
keyjava.lang.StringThe name of property.
valuefloatThe value of property.

Returns: java.lang.Object - A property.

setProperty(String key, boolean value)

public Object setProperty(String key, boolean value)

Sets boolean property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
valuebooleanThe value of property.

Returns: java.lang.Object - A property.

setProperty(Properties properties, String key, boolean value)

public static Object setProperty(Properties properties, String key, boolean value)

Sets boolean property value in specified properties table.

Parameters:

ParameterTypeDescription
propertiesjava.util.PropertiesThe properties table.
keyjava.lang.StringThe name of property.
valuebooleanThe value of property.

Returns: java.lang.Object - A property.

getProperty(String key)

public String getProperty(String key)

Gets string property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: java.lang.String - Property value.

getProperty(String key, String def)

public String getProperty(String key, String def)

Gets string property value. If requested property is absent, returns provided default value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
defjava.lang.StringDefault value of property.

Returns: java.lang.String - Property value.

getPropertyStringArray(String key)

public String[] getPropertyStringArray(String key)

Gets string array property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: java.lang.String[] - Property value.

getPropertyStringArray(String key, String[] def)

public String[] getPropertyStringArray(String key, String[] def)

Gets string array property value. If requested property is absent, returns provided default value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
defjava.lang.String[]Default value of property.

Returns: java.lang.String[] - Property value.

getPropertyColor(String key)

public Color getPropertyColor(String key)

Gets color property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: java.awt.Color - Property value.

getPropertyColor(String key, Color def)

public Color getPropertyColor(String key, Color def)

Gets color property value. If requested property is absent, returns provided default value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
defjava.awt.ColorDefault value of property.

Returns: java.awt.Color - Property value.

getPropertyRectangle(String key)

public Rectangle getPropertyRectangle(String key)

Gets rectangle property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: java.awt.Rectangle - Property value.

getPropertyRectangle(String key, Rectangle def)

public Rectangle getPropertyRectangle(String key, Rectangle def)

Gets rectangle property value. If requested property is absent, returns provided default value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
defjava.awt.RectangleDefault value of property.

Returns: java.awt.Rectangle - Property value.

getPropertyInsets(String key)

public Insets getPropertyInsets(String key)

Gets insets property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: java.awt.Insets - Property value.

getPropertyInsets(String key, Insets def)

public Insets getPropertyInsets(String key, Insets def)

Gets insets property value. If requested property is absent, returns provided default value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
defjava.awt.InsetsDefault value of property.

Returns: java.awt.Insets - Property value.

getPropertyDimension(String key)

public Dimension getPropertyDimension(String key)

Gets dimension property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: java.awt.Dimension - Property value.

getPropertyDimension(String key, Dimension def)

public Dimension getPropertyDimension(String key, Dimension def)

Gets dimension property value. If requested property is absent, returns provided default value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
defjava.awt.DimensionDefault value of property.

Returns: java.awt.Dimension - Property value.

getPropertyInt(String key)

public int getPropertyInt(String key)

Gets integer property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: int - Property value.

getPropertyInt(String key, int def)

public int getPropertyInt(String key, int def)

Gets integer property value. If requested property is absent, returns provided default value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
defintDefault value of property.

Returns: int - Property value.

getPropertyDouble(String key)

public double getPropertyDouble(String key)

Gets double property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: double - Property value.

getPropertyDouble(String key, double def)

public double getPropertyDouble(String key, double def)

Gets double property value. If requested property is absent, returns provided default value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
defdoubleDefault value of property.

Returns: double - Property value.

getPropertyFloat(String key)

public float getPropertyFloat(String key)

Gets float property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: float - Property value.

getPropertyFloat(String key, float def)

public float getPropertyFloat(String key, float def)

Gets float property value. If requested property is absent, returns provided default value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
deffloatDefault value of property.

Returns: float - Property value.

isProperty(String key)

public boolean isProperty(String key)

Gets boolean property value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.

Returns: boolean - Property value.

isProperty(String key, boolean def)

public boolean isProperty(String key, boolean def)

Gets boolean property value. If requested property is absent, returns provided default value.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe name of property.
defbooleanDefault value of property.

Returns: boolean - Property value.