org.kepler.configuration

Class ConfigurationProperty

java.lang.Object

org.kepler.configuration.ConfigurationProperty

Direct Known Subclasses:

RootConfigurationProperty

public class ConfigurationProperty
extends java.lang.Object

Class that represents a configuration property within kepler

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigurationNamespace	namespaceDefault

Constructor Summary

Constructors

Constructor and Description
ConfigurationProperty(org.kepler.build.modules.Module module, java.lang.String name) constructor to build a configuration property for a module with a name but with no value or nested property list.
ConfigurationProperty(org.kepler.build.modules.Module module, java.lang.String name, ConfigurationNamespace namespace, java.util.List<ConfigurationProperty> propertiesList) constructor to build a configuration property for a module with a name, namespace and a list of properties to nest within it
ConfigurationProperty(org.kepler.build.modules.Module module, java.lang.String name, ConfigurationNamespace namespace, java.util.List<ConfigurationProperty> propertiesList, boolean notifyListeners) constructor to build a configuration property for a module with a name, namespace and a list of properties to nest within it
ConfigurationProperty(org.kepler.build.modules.Module module, java.lang.String name, ConfigurationNamespace namespace, java.lang.String value) constructor to build a configuration property for a module with a name and a single value
ConfigurationProperty(org.kepler.build.modules.Module module, java.lang.String name, ConfigurationProperty property) create a configuration property with one nested property
ConfigurationProperty(org.kepler.build.modules.Module module, java.lang.String name, java.util.List<ConfigurationProperty> propertiesList) constructor to build a configuration property for a module with a name and a list of properties to load
ConfigurationProperty(org.kepler.build.modules.Module module, java.lang.String name, java.lang.String value) constructor to build a configuration property for a module with a name and a single value

Method Summary

Modifier and Type	Method and Description
void	addProperty(ConfigurationProperty property) add a nested property to this configuration property
void	addProperty(ConfigurationProperty property, boolean notifyListeners) add a nested property to this configuration property
protected void	addProperty(ConfigurationProperty property, boolean ignoreMutable, boolean notifyListeners, boolean setDirty) add a nested property to this configuration property.
void	addProperty(org.kepler.build.modules.Module module, java.lang.String name, ConfigurationNamespace namespace, ConfigurationProperty property) add a new property for a given module with a given name that has the given property nested within it.
void	addProperty(org.kepler.build.modules.Module module, java.lang.String name, ConfigurationProperty property) add a new property for a given module with a given name that has the given property nested within it.
void	addPropertyAtIndex(int index, ConfigurationProperty propertyToAdd) add propertyToAdd before the beforeProperty in the ordering of the list of properties for this property
void	addPropertyIfNotThere(ConfigurationProperty propertyToAdd) add a nested property if the contents are not already present, ignoring: namespaces, modules, originmodules.
void	addPropertyIfNotThere(ConfigurationProperty propertyToAdd, boolean setDirty)
void	addPropertyIfNotThereAtIndex(int index, ConfigurationProperty propertyToAdd) add a nested property at index if the contents are not already present, ignoring: namespaces, modules, originmodules.
boolean	containsProperty(ConfigurationProperty nestedProperty) returns true if this property contains a nested property, ignoring: namespaces, modules, originmodules.
boolean	containsProperty(java.lang.String name, boolean recursive) return true if this ConfigurationProperty contains a property with the given name..
boolean	equalsContents(ConfigurationProperty property) returns true if the property contents are identical to this one, ignoring: namespaces, modules, originmodules.
static java.util.List<ConfigurationProperty>	findProperties(ConfigurationProperty property, java.lang.String name, java.lang.String value, boolean recursive) return a list of properties that have a name that matches name and a value that matches value within property.
static java.util.List<ConfigurationProperty>	findProperties(java.util.List<ConfigurationProperty> properties, java.lang.String name, java.lang.String value, boolean recursive) Search a list of properties for properties that contain a name and a value
java.util.List<ConfigurationProperty>	findProperties(java.lang.String name, java.lang.String value) returns a list of properties within this property that have a specific name and value.
java.util.List<ConfigurationProperty>	findProperties(java.lang.String name, java.lang.String value, boolean recursive) returns a list of properties within this property that have a specific name and value.
java.lang.String	getFullName() returns a fully qualified name including the module and namespace
org.kepler.build.modules.Module	getModule() return the module associated with this property
java.lang.String	getName() return the name of this property
ConfigurationNamespace	getNamespace() return the namepace
org.kepler.build.modules.Module	getOriginModule()
ConfigurationProperty	getParent() returns the parent propert of this property.
java.util.List<ConfigurationProperty>	getProperties() return a list of nested properties within this property
static java.util.List<ConfigurationProperty>	getProperties(ConfigurationProperty cp, java.lang.String name, boolean recursive) get properties from a configurationProperty with a given name.
java.util.List<ConfigurationProperty>	getProperties(java.lang.String name) return a list of nested properties that have a specific name.
java.util.List<ConfigurationProperty>	getProperties(java.lang.String name, boolean recursive) do a recursive get through this ConfigurationProperty
protected static java.util.List<ConfigurationProperty>	getPropertiesWithPath(ConfigurationProperty property, java.lang.String[] s, boolean returnChildren) recursively return all properties with a path denoted in s.
ConfigurationProperty	getProperty(int index) get the property with the given index in the current list of properties
ConfigurationProperty	getProperty(java.lang.String name) if there are more than one property with the same name, just return the first one.
ConfigurationProperty	getProperty(java.lang.String name, int index) return a property with a given name at the specified index.
java.lang.String	getValue() return the value of this property.
static java.util.List<java.lang.String>	getValueList(java.util.List<ConfigurationProperty> propList, java.lang.String propertyName, boolean recursive) return a list of strings of the values of a property with a given name in the list of properties
java.lang.String	getXML() return the xml version of this property
boolean	hasLeafValue() return true if this property has a string value
boolean	hasNestedProperties() return true if this property has nested properties
boolean	isDirty() returns this congifuration property's dirty flag
boolean	isDirty(boolean recursive) returns true if this property has changed since it was last saved
boolean	isMutable() returns true if this propert is mutable.
boolean	overrideProperty(ConfigurationProperty originalProperty, ConfigurationProperty newProperty, boolean overrideNamespace) override originalProperty with newProperty.
void	prettyPrint() print this configurationProperty nicely showing the hierarchy
static void	prettyPrintList(java.util.List<ConfigurationProperty> l) pretty print a list of configuration properties
protected static java.lang.String[]	processName(java.lang.String name) process a name with . notations into a string array
boolean	removeProperty(ConfigurationProperty propertyToRemove) remove the given property
protected void	resetDirty(boolean recursive) reset the dirty flag
void	setDirty(boolean dirty) set dirty. generally other classes shouldn't call this but it's a good way to force serialization when nothing has actually changed.
protected void	setMutable(boolean mutable) set whether this property is mutable.
void	setNamespace(boolean notifyListeners, ConfigurationNamespace namespace) set the namespace of this property
void	setNamespace(ConfigurationNamespace namespace) set the namespace of this property
void	setNamespace(ConfigurationNamespace namespace, boolean recursive) sets the namespace.
void	setNamespace(ConfigurationNamespace namespace, boolean recursive, boolean notifyListeners) sets the namespace.
static void	setNamespace(ConfigurationProperty cp, ConfigurationNamespace namespace, boolean recursive) set the namespace on a configurationProperty
static void	setNamespace(ConfigurationProperty cp, ConfigurationNamespace namespace, boolean recursive, boolean notifyListeners) set the namespace on a configurationProperty
void	setOriginModule(org.kepler.build.modules.Module m)
void	setParent(ConfigurationProperty property) set the parent property of this property
void	setValue(java.lang.String value) set the value of this property
static void	simplePrintList(java.util.List<ConfigurationProperty> l)
java.lang.String	toString() return a string representation of this property
java.lang.String	toString(boolean recursive)
java.lang.String	toString(boolean recursive, boolean includeNamespace, boolean includeModule, boolean includeOriginModule) returns a string representation of this property
java.lang.String	toStringContents() Returns the string contents of this property without the namespace, module name, and origin module name (if present).

Methods inherited from class java.lang.Object

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

Field Detail

namespaceDefault

public static final ConfigurationNamespace namespaceDefault

Constructor Detail

ConfigurationProperty

public ConfigurationProperty(org.kepler.build.modules.Module module,
                             java.lang.String name,
                             java.util.List<ConfigurationProperty> propertiesList)

constructor to build a configuration property for a module with a name and a list of properties to load

ConfigurationProperty

public ConfigurationProperty(org.kepler.build.modules.Module module,
                             java.lang.String name,
                             ConfigurationNamespace namespace,
                             java.util.List<ConfigurationProperty> propertiesList)

constructor to build a configuration property for a module with a name, namespace and a list of properties to nest within it

ConfigurationProperty

public ConfigurationProperty(org.kepler.build.modules.Module module,
                             java.lang.String name,
                             ConfigurationNamespace namespace,
                             java.util.List<ConfigurationProperty> propertiesList,
                             boolean notifyListeners)

constructor to build a configuration property for a module with a name, namespace and a list of properties to nest within it

ConfigurationProperty

public ConfigurationProperty(org.kepler.build.modules.Module module,
                             java.lang.String name,
                             java.lang.String value)

constructor to build a configuration property for a module with a name and a single value

ConfigurationProperty

public ConfigurationProperty(org.kepler.build.modules.Module module,
                             java.lang.String name,
                             ConfigurationNamespace namespace,
                             java.lang.String value)

constructor to build a configuration property for a module with a name and a single value

ConfigurationProperty

public ConfigurationProperty(org.kepler.build.modules.Module module,
                             java.lang.String name)

constructor to build a configuration property for a module with a name but with no value or nested property list.

ConfigurationProperty

public ConfigurationProperty(org.kepler.build.modules.Module module,
                             java.lang.String name,
                             ConfigurationProperty property)
                      throws NamespaceException,
                             ConfigurationManagerException

create a configuration property with one nested property

Throws:

NamespaceException

ConfigurationManagerException

Method Detail

addProperty

public void addProperty(ConfigurationProperty property)
                 throws NamespaceException,
                        ConfigurationManagerException

add a nested property to this configuration property

Throws:

NamespaceException

ConfigurationManagerException

addProperty

public void addProperty(ConfigurationProperty property,
                        boolean notifyListeners)
                 throws NamespaceException,
                        ConfigurationManagerException

add a nested property to this configuration property

Throws:

NamespaceException

ConfigurationManagerException

addProperty

protected void addProperty(ConfigurationProperty property,
                           boolean ignoreMutable,
                           boolean notifyListeners,
                           boolean setDirty)
                    throws NamespaceException,
                           ConfigurationManagerException

add a nested property to this configuration property. if ignoreMutable is false, don't throw an exception if a property is mutable. this method is used by configuration readers to build the configuration and should not be used in normal api calls.

Throws:

NamespaceException

ConfigurationManagerException

addProperty

public void addProperty(org.kepler.build.modules.Module module,
                        java.lang.String name,
                        ConfigurationProperty property)
                 throws NamespaceException,
                        ConfigurationManagerException

add a new property for a given module with a given name that has the given property nested within it.

Throws:

NamespaceException

ConfigurationManagerException

addProperty

public void addProperty(org.kepler.build.modules.Module module,
                        java.lang.String name,
                        ConfigurationNamespace namespace,
                        ConfigurationProperty property)
                 throws NamespaceException,
                        ConfigurationManagerException

add a new property for a given module with a given name that has the given property nested within it.

Throws:

NamespaceException

ConfigurationManagerException

addPropertyAtIndex

public void addPropertyAtIndex(int index,
                               ConfigurationProperty propertyToAdd)
                        throws NamespaceException,
                               ConfigurationManagerException

add propertyToAdd before the beforeProperty in the ordering of the list of properties for this property

Parameters:

index - index in this property's property list to add propertyToAdd

propertyToAdd - the property to add

Throws:

NamespaceException

ConfigurationManagerException

addPropertyIfNotThere

public void addPropertyIfNotThere(ConfigurationProperty propertyToAdd)
                           throws NamespaceException,
                                  ConfigurationManagerException

add a nested property if the contents are not already present, ignoring: namespaces, modules, originmodules. NOTE: if the contents are the same, but in a different order, the property is added.

Throws:

NamespaceException

ConfigurationManagerException

addPropertyIfNotThere

public void addPropertyIfNotThere(ConfigurationProperty propertyToAdd,
                                  boolean setDirty)
                           throws NamespaceException,
                                  ConfigurationManagerException

Throws:

NamespaceException

ConfigurationManagerException

addPropertyIfNotThereAtIndex

public void addPropertyIfNotThereAtIndex(int index,
                                         ConfigurationProperty propertyToAdd)
                                  throws NamespaceException,
                                         ConfigurationManagerException

add a nested property at index if the contents are not already present, ignoring: namespaces, modules, originmodules. NOTE: if the contents are the same, but in a different order, the property is added.

Throws:

NamespaceException

ConfigurationManagerException

removeProperty

public boolean removeProperty(ConfigurationProperty propertyToRemove)

remove the given property

Parameters:

propertyToRemove - the property to remove

Returns:

true if propertiesList contained this property

getProperties

public java.util.List<ConfigurationProperty> getProperties()

return a list of nested properties within this property

getProperties

public java.util.List<ConfigurationProperty> getProperties(java.lang.String name)

return a list of nested properties that have a specific name. Use dots to separate path names. For example "some.config.path.value"

getProperties

public java.util.List<ConfigurationProperty> getProperties(java.lang.String name,
                                                           boolean recursive)

do a recursive get through this ConfigurationProperty

Parameters:

name - the name to look for

recursive -

getProperties

public static java.util.List<ConfigurationProperty> getProperties(ConfigurationProperty cp,
                                                                  java.lang.String name,
                                                                  boolean recursive)

get properties from a configurationProperty with a given name. If recursive is true, look through the entire structure of cp and return all properties with the given name.

Parameters:

cp - the ConfigurationProperty to get from

name - the name to look for

recursive - if true, look through the tree recursively.

getProperty

public ConfigurationProperty getProperty(java.lang.String name)

if there are more than one property with the same name, just return the first one. Return null if the property is not found

getProperty

public ConfigurationProperty getProperty(java.lang.String name,
                                         int index)

return a property with a given name at the specified index. Example: prop1 prop2=x prop2=y getProperty("prop2", 1).getValue() == y getProperty("prop2", 0).getValue() == x returns null if the property does not exist

getProperty

public ConfigurationProperty getProperty(int index)

get the property with the given index in the current list of properties

overrideProperty

public boolean overrideProperty(ConfigurationProperty originalProperty,
                                ConfigurationProperty newProperty,
                                boolean overrideNamespace)

override originalProperty with newProperty.

Parameters:

originalProperty - the property to override

newProperty - the property to take the place of originalProperty

overrideNamespace - true if you want to automatically set the namespace of newProperty (along with all of its subproperties) to that of originalProperty.

findProperties

public java.util.List<ConfigurationProperty> findProperties(java.lang.String name,
                                                            java.lang.String value,
                                                            boolean recursive)

returns a list of properties within this property that have a specific name and value. This will return the parent property of any properties found. Example: <a> <name>jim</name> <otherprop>XXX</otherprop> </a> <b> <name>bob</name> <otherprop>XXX</otherprop> </b> <c> <name>jim</name> <otherprop>XXX</otherprop> </c> a call to findProperties("name", "jim") would return elements <a> and <c> in the list. Note: the name parameter can NOT use the shorthand "dot" notation.

Parameters:

name - the name of the property to find

value - the value of the property to find

recursive - true if you want a recursive (deep) search

findProperties

public java.util.List<ConfigurationProperty> findProperties(java.lang.String name,
                                                            java.lang.String value)

returns a list of properties within this property that have a specific name and value. This will return the parent property of any properties found. Example: <a> <name>jim</name> <otherprop>XXX</otherprop> </a> <b> <name>bob</name> <otherprop>XXX</otherprop> </b> <c> <name>jim</name> <otherprop>XXX</otherprop> </c> a call to findProperties("name", "jim") would return elements <a> and <c> in the list. Note: the name parameter can NOT use the shorthand "dot" notation. Note: this method is non-recursive.

Parameters:

name - the name of the property to find

value - the value of the property to find

getValue

public java.lang.String getValue()

return the value of this property. if the value is not set this returns null

setValue

public void setValue(java.lang.String value)
              throws ConfigurationManagerException

set the value of this property

Throws:

ConfigurationManagerException

hasLeafValue

public boolean hasLeafValue()

return true if this property has a string value

hasNestedProperties

public boolean hasNestedProperties()

return true if this property has nested properties

getName

public java.lang.String getName()

return the name of this property

getModule

public org.kepler.build.modules.Module getModule()

return the module associated with this property

getNamespace

public ConfigurationNamespace getNamespace()

return the namepace

setDirty

public void setDirty(boolean dirty)

set dirty. generally other classes shouldn't call this but it's a good way to force serialization when nothing has actually changed.

setNamespace

public void setNamespace(boolean notifyListeners,
                         ConfigurationNamespace namespace)

set the namespace of this property

setNamespace

public void setNamespace(ConfigurationNamespace namespace)

set the namespace of this property

setNamespace

public void setNamespace(ConfigurationNamespace namespace,
                         boolean recursive)

sets the namespace. If recursive is true, set all subproperties' namespaces as well.

setNamespace

public void setNamespace(ConfigurationNamespace namespace,
                         boolean recursive,
                         boolean notifyListeners)

sets the namespace. If recursive is true, set all subproperties' namespaces as well.

getFullName

public java.lang.String getFullName()

returns a fully qualified name including the module and namespace

isMutable

public boolean isMutable()

returns true if this propert is mutable. A mutable property is one that can be changed and realized without restarting the application. Only mutable properties can be overwritten at runtime. A property is assumed to be mutable unless it is set not to be.

containsProperty

public boolean containsProperty(java.lang.String name,
                                boolean recursive)

return true if this ConfigurationProperty contains a property with the given name.. Set recursive to true if you want to search this property's nested structure.

Parameters:

property - the property

containsProperty

public boolean containsProperty(ConfigurationProperty nestedProperty)

returns true if this property contains a nested property, ignoring: namespaces, modules, originmodules. NOTE: if the contents are the same, but in a different order, returns false.

equalsContents

public boolean equalsContents(ConfigurationProperty property)

returns true if the property contents are identical to this one, ignoring: namespaces, modules, originmodules. NOTE: if the contents are the same, but in a different order, returns false.

getXML

public java.lang.String getXML()

return the xml version of this property

toString

public java.lang.String toString(boolean recursive)

toString

public java.lang.String toString()

return a string representation of this property

Overrides:

toString in class java.lang.Object

toStringContents

public java.lang.String toStringContents()

Returns the string contents of this property without the namespace, module name, and origin module name (if present).

toString

public java.lang.String toString(boolean recursive,
                                 boolean includeNamespace,
                                 boolean includeModule,
                                 boolean includeOriginModule)

returns a string representation of this property

Parameters:

recursive - if true, string includes all sub-properties

includeNamespace - if true, string includes the namespace

includeModule - if true, string include module name

includeOriginModule - if true, string includes originModule name

prettyPrint

public void prettyPrint()

print this configurationProperty nicely showing the hierarchy

isDirty

public boolean isDirty(boolean recursive)

returns true if this property has changed since it was last saved

Parameters:

recursive - true if the dirty flag should be searched for in any contained configuration property

isDirty

public boolean isDirty()

returns this congifuration property's dirty flag

getParent

public ConfigurationProperty getParent()

returns the parent propert of this property. null if this property does not have a parent.

setNamespace

public static void setNamespace(ConfigurationProperty cp,
                                ConfigurationNamespace namespace,
                                boolean recursive)

set the namespace on a configurationProperty

setNamespace

public static void setNamespace(ConfigurationProperty cp,
                                ConfigurationNamespace namespace,
                                boolean recursive,
                                boolean notifyListeners)

set the namespace on a configurationProperty

findProperties

public static java.util.List<ConfigurationProperty> findProperties(java.util.List<ConfigurationProperty> properties,
                                                                   java.lang.String name,
                                                                   java.lang.String value,
                                                                   boolean recursive)

Search a list of properties for properties that contain a name and a value

findProperties

public static java.util.List<ConfigurationProperty> findProperties(ConfigurationProperty property,
                                                                   java.lang.String name,
                                                                   java.lang.String value,
                                                                   boolean recursive)

return a list of properties that have a name that matches name and a value that matches value within property. If recursive is set to true, do a deep search of the property

prettyPrintList

public static void prettyPrintList(java.util.List<ConfigurationProperty> l)

pretty print a list of configuration properties

simplePrintList

public static void simplePrintList(java.util.List<ConfigurationProperty> l)

getValueList

public static java.util.List<java.lang.String> getValueList(java.util.List<ConfigurationProperty> propList,
                                                            java.lang.String propertyName,
                                                            boolean recursive)

return a list of strings of the values of a property with a given name in the list of properties

setOriginModule

public void setOriginModule(org.kepler.build.modules.Module m)

getOriginModule

public org.kepler.build.modules.Module getOriginModule()

setParent

public void setParent(ConfigurationProperty property)

set the parent property of this property

resetDirty

protected void resetDirty(boolean recursive)

reset the dirty flag

Parameters:

recursive - set to true if all properties that this property contains should also be reset

getPropertiesWithPath

protected static java.util.List<ConfigurationProperty> getPropertiesWithPath(ConfigurationProperty property,
                                                                             java.lang.String[] s,
                                                                             boolean returnChildren)

recursively return all properties with a path denoted in s. If returnChildren is true, return the found child nodes. If it is false, return the found parent nodes. For example, if you are getting a/b/c, if returnChildren is true, return a list of the c's. If returnChildren is false, return a list of the a's.

setMutable

protected void setMutable(boolean mutable)

set whether this property is mutable. A mutable property is one that can be changed and realized without restarting the application. Only mutable properties can be overwritten at runtime. A property is assumed to be mutable unless it is set not to be.

processName

protected static java.lang.String[] processName(java.lang.String name)

process a name with . notations into a string array