org.argouml.application.configuration
Class ConfigurationKeyImpl

java.lang.Object
  org.argouml.application.configuration.ConfigurationKeyImpl

All Implemented Interfaces:

ConfigurationKey

public class ConfigurationKeyImpl

extends Object

implements ConfigurationKey

This class provides definition and manipulation of configuration keys. All keys in the configuration system will be accessed using the ConfigurationKey wrapper.

Since:

ARGO0.9.4

Field Summary

private String

key The string value for the key.

Constructor Summary

ConfigurationKeyImpl(ConfigurationKey ck, String k1)
Create a sub-component of an existing configuration key.

ConfigurationKeyImpl(String k1)
Create a single component configuration key.

ConfigurationKeyImpl(String k1, String k2)
Create a two-component configuration key.

ConfigurationKeyImpl(String k1, String k2, String k3)
Create a three-component configuration key.

ConfigurationKeyImpl(String k1, String k2, String k3, String k4)
Create a four-component configuration key.

ConfigurationKeyImpl(String k1, String k2, String k3, String k4, String k5)
Create a five-component configuration key.

Method Summary

String	getKey() Return the actual key used to access the configuration.
boolean	isChangedProperty(PropertyChangeEvent pce) Compare the configuration key to a string.
String	toString() Returns a formatted key.

Methods inherited from class java.lang.Object

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

Field Detail

key

private String key

The string value for the key.

Constructor Detail

ConfigurationKeyImpl

public ConfigurationKeyImpl(String k1)

Create a single component configuration key.

Parameters:

k1 - key component.

ConfigurationKeyImpl

public ConfigurationKeyImpl(ConfigurationKey ck,
                            String k1)

Create a sub-component of an existing configuration key.

Parameters:

ck - configuration key

k1 - additional key component.

ConfigurationKeyImpl

public ConfigurationKeyImpl(String k1,
                            String k2)

Create a two-component configuration key.

Parameters:

k1 - key component 1.

k2 - key component 2.

ConfigurationKeyImpl

public ConfigurationKeyImpl(String k1,
                            String k2,
                            String k3)

Create a three-component configuration key.

Parameters:

k1 - key component 1.

k2 - key component 2.

k3 - key component 3.

ConfigurationKeyImpl

public ConfigurationKeyImpl(String k1,
                            String k2,
                            String k3,
                            String k4)

Create a four-component configuration key.

Parameters:

k1 - key component 1.

k2 - key component 2.

k3 - key component 3.

k4 - key component 4.

ConfigurationKeyImpl

public ConfigurationKeyImpl(String k1,
                            String k2,
                            String k3,
                            String k4,
                            String k5)

Create a five-component configuration key.

Parameters:

k1 - key component 1.

k2 - key component 2.

k3 - key component 3.

k4 - key component 4.

k5 - key component 5.

Method Detail

getKey

public final String getKey()

Return the actual key used to access the configuration.

Specified by:

getKey in interface ConfigurationKey

Returns:

the key

isChangedProperty

public boolean isChangedProperty(PropertyChangeEvent pce)

Compare the configuration key to a string.

Specified by:

isChangedProperty in interface ConfigurationKey

Parameters:

pce - PropertyChangeEvent to check

Returns:

true if the changed property is for the key.

toString

public String toString()

Returns a formatted key.

Returns:

a formatted key string.