org.jconfig
Interface Category

All Known Implementing Classes:

DefaultCategory

public interface Category

This class is the result of countless discussions of what a Category should be. After determing that it should be another class, and that we can do something useful, we created this Category. A Category is a logical extension of the Configuration has Categories has Properties has Value frame-of-mind. The primary goal is to reduce redundancy in source code when using setter and getters that include Category information.

Since:

2.2

Author:

Andreas Mecky , Terry Dye

Method Summary

void	addCategoryListener(CategoryListener listener) Adds the specified category listener to receive category changed events from this category.
void	addPropertyListener(PropertyListener listener) Adds the given listener to the list that wish to receive the PropertyChangedEvent.
void	fireCategoryChangedEvent(CategoryChangedEvent event) Deliver category changed event to all listeners that are registered with our listener list.
void	firePropertyChangedEvent(PropertyChangedEvent event) Notifies all PropertyListeners of changes to the property (added, removed, changed).
java.lang.String[]	getArray(java.lang.String key)
java.lang.String[]	getArray(java.lang.String key, java.lang.String[] defaultValue)
boolean	getBooleanProperty(java.lang.String name, boolean defaultValue) Helper method to allow for strong-binding within Properties.
java.lang.String	getCategoryName() Returns the name of this category.
char	getCharProperty(java.lang.String name, char defaultValue) Helper method to allow for strong-binding within Properties.
java.lang.String	getConfigurationName() Getter for property configurationName.
double	getDoubleProperty(java.lang.String name, double defaultValue) Helper method to allow for strong-binding within Properties.
java.lang.String	getExtendsCategory()
int	getIntProperty(java.lang.String name, int defaultValue) Helper method to allow for strong-binding within Properties.
long	getLongProperty(java.lang.String name, long defaultValue) Helper method to allow for strong-binding within Properties.
java.util.Properties	getProperties() Return all properties related to this category
java.lang.String	getProperty(java.lang.String propertyName) Searches for the property with the specified key in this property list.
java.lang.String	getProperty(java.lang.String propertyName, java.lang.String defaultValue) Searches for the property with the specified key in this property list.
void	removeCategoryListener(CategoryListener listener) Removes the specified category listener from the category change events from this category.
void	removePropertyListener(PropertyListener listener) Removes the given listener to the list that wish to receive the PropertyChangedEvent.
void	setBooleanProperty(java.lang.String name, boolean value) Helper method to allow for strong-binding within Properties.
void	setCharProperty(java.lang.String key, char value) Helper method to allow for strong-binding within Properties.
void	setConfigurationName(java.lang.String configurationName) Setter for property configurationName.
void	setDoubleProperty(java.lang.String key, double value) Helper method to allow for strong-binding within Properties.
void	setExtendsCategory(java.lang.String extendsCategory)
void	setIntProperty(java.lang.String key, int value) Helper method to allow for strong-binding within Properties.
void	setLongProperty(java.lang.String key, long value) Helper method to allow for strong-binding within Properties.
Category	setProperty(java.lang.String propertyName, java.lang.String propertyValue) Sets the property with the value given.

Method Detail

setProperty

public Category setProperty(java.lang.String propertyName,
                            java.lang.String propertyValue)

Sets the property with the value given. This will override any existing property values if the property name is duplicated. This will create a new property if no property exists. Setting the value to <null> will remove the property from the Category;

Parameters:

propertyName -

propertyValue -

Returns:

Since:

2.2

getProperty

public java.lang.String getProperty(java.lang.String propertyName)

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns null if the property is not found.

Parameters:

key - the property key.

Returns:

the value in this property list with the specified key value.

Since:

2.2

getProperty

public java.lang.String getProperty(java.lang.String propertyName,
                                    java.lang.String defaultValue)

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.

Parameters:

propertyName - The property name.

defaultValue - The default value.

Returns:

the value in this property list with the specified key value or the defaultValue.

Since:

2.2

getCategoryName

public java.lang.String getCategoryName()

Returns the name of this category.

Returns:

The name of the category.

Since:

2.2

addCategoryListener

public void addCategoryListener(CategoryListener listener)

Adds the specified category listener to receive category changed events from this category.

Parameters:

listener - The ConfigurationListener

Since:

2.2

removeCategoryListener

public void removeCategoryListener(CategoryListener listener)

Removes the specified category listener from the category change events from this category.

Parameters:

listener - The ConfigurationListener

Since:

2.2

fireCategoryChangedEvent

public void fireCategoryChangedEvent(CategoryChangedEvent event)

Deliver category changed event to all listeners that are registered with our listener list.

Parameters:

event - The ConfigurationChangedEvent

Since:

2.2

getProperties

public java.util.Properties getProperties()

Return all properties related to this category

Returns:

The Properties

Since:

2.2

getArray

public java.lang.String[] getArray(java.lang.String key)

getArray

public java.lang.String[] getArray(java.lang.String key,
                                   java.lang.String[] defaultValue)

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name,
                                  boolean defaultValue)

Helper method to allow for strong-binding within Properties.

Parameters:

name - The name of the property

defaultValue - The default value

Returns:

If the String value can be converted to Boolean, the value will be return, otherwise the the default value.

Since:

2.2

setBooleanProperty

public void setBooleanProperty(java.lang.String name,
                               boolean value)

Helper method to allow for strong-binding within Properties.

Parameters:

name -

value -

Since:

2.2

getCharProperty

public char getCharProperty(java.lang.String name,
                            char defaultValue)

Helper method to allow for strong-binding within Properties.

Parameters:

name - The name of the property

defaultValue - The default value

Returns:

If the String value can be converted to Boolean, the value will be return, otherwise the the default value.

Since:

2.2

setCharProperty

public void setCharProperty(java.lang.String key,
                            char value)

Helper method to allow for strong-binding within Properties.

Parameters:

string -

c -

Since:

2.2

getDoubleProperty

public double getDoubleProperty(java.lang.String name,
                                double defaultValue)

Helper method to allow for strong-binding within Properties.

Parameters:

name - The name of the property

defaultValue - The default value

Returns:

If the String value can be converted to Boolean, the value will be return, otherwise the the default value.

Since:

2.2

getIntProperty

public int getIntProperty(java.lang.String name,
                          int defaultValue)

Helper method to allow for strong-binding within Properties.

Parameters:

name - The name of the property

defaultValue - The default value

Returns:

If the String value can be converted to Boolean, the value will be return, otherwise the the default value.

Since:

2.2

setIntProperty

public void setIntProperty(java.lang.String key,
                           int value)

Helper method to allow for strong-binding within Properties.

Parameters:

string -

i -

Since:

2.2

getLongProperty

public long getLongProperty(java.lang.String name,
                            long defaultValue)

Helper method to allow for strong-binding within Properties.

Parameters:

name - The name of the property

defaultValue - The default value

Returns:

If the String value can be converted to Boolean, the value will be return, otherwise the the default value.

Since:

2.2

setLongProperty

public void setLongProperty(java.lang.String key,
                            long value)

Helper method to allow for strong-binding within Properties.

Parameters:

string -

l -

Since:

2.2

getConfigurationName

public java.lang.String getConfigurationName()

Getter for property configurationName.

Returns:

Value of property configurationName.

Since:

2.2

setConfigurationName

public void setConfigurationName(java.lang.String configurationName)

Setter for property configurationName.

Parameters:

configurationName - New value of property configurationName.

Since:

2.2

setDoubleProperty

public void setDoubleProperty(java.lang.String key,
                              double value)

Helper method to allow for strong-binding within Properties.

Parameters:

key -

value -

Since:

2.2

addPropertyListener

public void addPropertyListener(PropertyListener listener)

Adds the given listener to the list that wish to receive the PropertyChangedEvent.

Parameters:

listener -

Since:

2.2

removePropertyListener

public void removePropertyListener(PropertyListener listener)

Removes the given listener to the list that wish to receive the PropertyChangedEvent.

Parameters:

listener -

Since:

2.2

firePropertyChangedEvent

public void firePropertyChangedEvent(PropertyChangedEvent event)

Notifies all PropertyListeners of changes to the property (added, removed, changed).

Parameters:

event -

setExtendsCategory

public void setExtendsCategory(java.lang.String extendsCategory)

getExtendsCategory

public java.lang.String getExtendsCategory()