org.jboss.logmanager.config

Interface PropertyConfigurable

All Known Subinterfaces:

ErrorManagerConfiguration, FilterConfiguration, FormatterConfiguration, HandlerConfiguration

public interface PropertyConfigurable

An object which is configurable via object properties.

Author:

David M. Lloyd

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getConstructorProperties() Returns a collection of the constructor properties.
List<String>	getPropertyNames() Get the names of the configured properties in order.
String	getPropertyValueString(String propertyName) Get the string property value with the given name.
boolean	hasConstructorProperty(String propertyName) Determine whether the given property name is a constructor property.
boolean	hasProperty(String propertyName) Determine whether the given property name is configured.
boolean	removeProperty(String propertyName) Remove a configured property.
void	setPropertyValueString(String propertyName, String value) Set a property value from a string.

Method Detail

setPropertyValueString

void setPropertyValueString(String propertyName,
                          String value)
                            throws IllegalArgumentException

Set a property value from a string.

Parameters:

propertyName - the property name

value - the property value

Throws:

IllegalArgumentException - if the given value is not acceptable for this property

getPropertyValueString

String getPropertyValueString(String propertyName)

Get the string property value with the given name.

Parameters:

propertyName - the property name

Returns:

the property value string

hasProperty

boolean hasProperty(String propertyName)

Determine whether the given property name is configured.

Parameters:

propertyName - the property name to test

Returns:

true if the name is configured, false otherwise

removeProperty

boolean removeProperty(String propertyName)

Remove a configured property. Does not affect the underlying configured value; just removes it from the configuration.

Parameters:

propertyName - the property name

Returns:

true if the property name was removed, false if it was not present

getPropertyNames

List<String> getPropertyNames()

Get the names of the configured properties in order.

Returns:

the property names

hasConstructorProperty

boolean hasConstructorProperty(String propertyName)

Determine whether the given property name is a constructor property.

Parameters:

propertyName - the name of the property to check.

Returns:

true if the property should be used as a construction property, otherwise false.

getConstructorProperties

List<String> getConstructorProperties()

Returns a collection of the constructor properties.

Returns:

a collection of the constructor properties.