org.bedework.util.config

Class ConfigBase<T extends ConfigBase>

java.lang.Object

org.bedework.util.config.ConfigBase<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable, Comparable<T>

Direct Known Subclasses:

HibernateConfigBase

public abstract class ConfigBase<T extends ConfigBase>
extends Object
implements Comparable<T>, Serializable

This class is used as a basis for configuration of system modules. The classes extending this MUST be annotated appropriately with ConfInfo and require setters and getters for all configuration fields.

The class itself requires an element name annotation
@ConfInfo(elementName="example-conf", type="defining-class")

The type parameter is optional. If not specified the annotated class is the defining class otherwise it is the named class or interface

The defining class specifies the getters and setters for the configuration fields. The actual class may have other getters and setters but these will not be dumped or restored.

Collection fields MUST be either Set or List and the element class MUST be specified. For example:
private List props;

Also collection getters require a name for the collection element
@ConfInfo(collectionElementName = "prop")
public List getProps() {

The ConfInfo annotation @ConfInfo(dontSave = true) allows for getters and setters of values used internally only.

The dumped XML will have start elements with a type attribute. The value of that attribute is the actual class being dumped/restored.

An example:

   public interface MyConf extends Serializable {
     ...
     void setMaxLength(final Integer val);
     ...
    @MBeanInfo("Max length")
     Integer getLength();
     ...
   }

   @ConfInfo(elementName = "my-conf",
           type = "my.package.MyConf")
  public class MyConfImpl extends ConfigBase
        implements MyConf {
    ...
  }
 

Author:

Mike Douglass

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ns The default namespace for the XML elements.

Constructor Summary

Constructors

Constructor and Description
ConfigBase()

Method Summary

Modifier and Type	Method and Description
<L extends List> L	addListProperty(L list, String name, String val)
int	compareTo(ConfigBase that)
static ConfigBase	fromXml(InputStream is)
static ConfigBase	fromXml(InputStream is, Class cl)
long	getLastChanged()
String	getName() Name for the configuration.
String	getProperty(Collection<String> col, String name) Get a property stored as a String name = val
int	hashCode()
void	markChanged()
void	removeProperty(Collection<String> col, String name) Remove a property stored as a String name = val
<L extends List> L	setListProperty(L list, String name, String val) Set a property
void	setName(String val)
static Properties	toProperties(List<String> vals)
String	toString()
void	toStringSegment(ToString ts) Add our stuff to the StringBuilder
void	toXml(Writer wtr) Output to a writer

Methods inherited from class java.lang.Object

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

Field Detail

ns

public static final String ns

The default namespace for the XML elements.

See Also:

Constant Field Values

Constructor Detail

ConfigBase

public ConfigBase()

Method Detail

setName

public void setName(String val)

Parameters:

val - the name

getName

public String getName()

Name for the configuration.

Returns:

String

markChanged

public void markChanged()

getLastChanged

public long getLastChanged()

toStringSegment

public void toStringSegment(ToString ts)

Add our stuff to the StringBuilder

Parameters:

ts - ToString for result

compareTo

public int compareTo(ConfigBase that)

Specified by:

compareTo in interface Comparable<T extends ConfigBase>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

addListProperty

public <L extends List> L addListProperty(L list,
                                          String name,
                                          String val)

Parameters:

list -

name -

val -

Returns:

possibly newly created list

getProperty

public String getProperty(Collection<String> col,
                          String name)

Get a property stored as a String name = val

Parameters:

col - of property name+val

name -

Returns:

value or null

removeProperty

public void removeProperty(Collection<String> col,
                           String name)

Remove a property stored as a String name = val

Parameters:

col -

name -

setListProperty

public <L extends List> L setListProperty(L list,
                                          String name,
                                          String val)

Set a property

Parameters:

list - the list - possibly null

name - of property

val - of property

Returns:

possibly newly created list

toProperties

public static Properties toProperties(List<String> vals)

Parameters:

vals - to be converted to a Properties object

Returns:

the Properties

toXml

public void toXml(Writer wtr)
           throws ConfigException

Output to a writer

Parameters:

wtr -

Throws:

ConfigException

fromXml

public static ConfigBase fromXml(InputStream is)
                          throws ConfigException

Parameters:

is -

Returns:

parsed notification or null

Throws:

ConfigException

fromXml

public static ConfigBase fromXml(InputStream is,
                                 Class cl)
                          throws ConfigException

Parameters:

is -

cl -

Returns:

parsed notification or null

Throws:

ConfigException