edu.rice.cs.drjava.config
Class PropertyMaps

java.lang.Object
  edu.rice.cs.drjava.config.PropertyMaps

All Implemented Interfaces:

java.lang.Cloneable

public final class PropertyMaps
extends java.lang.Object
implements java.lang.Cloneable

Class representing all the variables that can be inserted as variables in external processes.

Version:

$Id: PropertyMaps.java 5175 2010-01-20 08:46:32Z mgricken $

Field Summary

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,DrJavaProperty>>	_props Map of property sets.
protected java.util.HashMap<java.lang.String,java.util.Stack<VariableProperty>>	_variables
static Lambda2<DrJavaProperty,PropertyMaps,java.lang.String>	GET_CURRENT A lambda to use the getCurrent() method, which forces an update.
static Lambda2<DrJavaProperty,PropertyMaps,java.lang.String>	GET_LAZY A lambda to use the getLazy() method, which does not force an update and might be stale.
static PropertyMaps	TEMPLATE Template instance.
protected static java.lang.String	VARIABLES_CATEGORY

Constructor Summary

PropertyMaps()
Create the basic property maps.

Method Summary

void	addVariable(java.lang.String name, java.lang.String value) Add a variable with the specified name and value, shadowing previous definitions of the variable.
void	clearCategory(java.lang.String category) Clear the specified category.
void	clearVariables() Clear all user-defined variables.
PropertyMaps	clone() Clone this PropertyMaps object.
java.util.Set<java.lang.String>	getCategories() Return the set of categories.
java.util.Map<java.lang.String,DrJavaProperty>	getProperties(java.lang.String category) Return the properties in a category.
DrJavaProperty	getProperty(java.lang.String key) Search through all categories and return the property requested, or null if not found.
DrJavaProperty	getProperty(java.lang.String category, java.lang.String name) Return the property requested, or null if not found.
void	removeProperty(DrJavaProperty p) Remove the specified property.
void	removeVariable(java.lang.String name) Remove the variable with the specified name, unshadowing previous definitions of the variable.
DrJavaProperty	setProperty(java.lang.String category, DrJavaProperty p) Add a property.
void	setVariable(java.lang.String name, java.lang.String value) Mutate the value of a variable with the specified name.

Methods inherited from class java.lang.Object

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

Field Detail

_props

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,DrJavaProperty>> _props

Map of property sets.

TEMPLATE

public static final PropertyMaps TEMPLATE

Template instance.

GET_LAZY

public static final Lambda2<DrJavaProperty,PropertyMaps,java.lang.String> GET_LAZY

A lambda to use the getLazy() method, which does not force an update and might be stale.

GET_CURRENT

public static final Lambda2<DrJavaProperty,PropertyMaps,java.lang.String> GET_CURRENT

A lambda to use the getCurrent() method, which forces an update.

_variables

protected java.util.HashMap<java.lang.String,java.util.Stack<VariableProperty>> _variables

VARIABLES_CATEGORY

protected static final java.lang.String VARIABLES_CATEGORY

See Also:

Constant Field Values

Constructor Detail

PropertyMaps

public PropertyMaps()

Create the basic property maps. One is named "Java" and contains the Java system properties. A second one is named "Config" and contains the DrJava configuration items.

Method Detail

getProperty

public DrJavaProperty getProperty(java.lang.String category,
                                  java.lang.String name)

Return the property requested, or null if not found.

Parameters:

category - name of the category

name - name of the property

Returns:

property, or null if not found

Throws:

java.lang.IllegalArgumentException - if category is not known.

getProperty

public DrJavaProperty getProperty(java.lang.String key)

Search through all categories and return the property requested, or null if not found.

Parameters:

key - key of the property

Returns:

property, or null if not found

removeProperty

public void removeProperty(DrJavaProperty p)

Remove the specified property.

Parameters:

p - property to remove

setProperty

public DrJavaProperty setProperty(java.lang.String category,
                                  DrJavaProperty p)

Add a property.

clearCategory

public void clearCategory(java.lang.String category)

Clear the specified category.

getCategories

public java.util.Set<java.lang.String> getCategories()

Return the set of categories.

getProperties

public java.util.Map<java.lang.String,DrJavaProperty> getProperties(java.lang.String category)

Return the properties in a category.

Throws:

java.lang.IllegalArgumentException - if category is not known.

clearVariables

public void clearVariables()

Clear all user-defined variables.

addVariable

public void addVariable(java.lang.String name,
                        java.lang.String value)

Add a variable with the specified name and value, shadowing previous definitions of the variable.

Parameters:

name - name of the variable

value - value of the variable

Throws:

java.lang.IllegalArgumentException - if the name is already used for a built-in property

setVariable

public void setVariable(java.lang.String name,
                        java.lang.String value)

Mutate the value of a variable with the specified name.

Parameters:

name - name of the variable

value - new value of the variable

Throws:

java.lang.IllegalArgumentException - if a variable with name does not exist

removeVariable

public void removeVariable(java.lang.String name)

Remove the variable with the specified name, unshadowing previous definitions of the variable.

Parameters:

name - of the variable

Throws:

java.lang.IllegalArgumentException - if no variable with that name exists

clone

public PropertyMaps clone()
                   throws java.lang.CloneNotSupportedException

Clone this PropertyMaps object.

Overrides:

clone in class java.lang.Object

Returns:

cloned object

Throws:

java.lang.CloneNotSupportedException