Package org.jboss.logmanager.config
Interface PropertyConfigurable
- All Known Subinterfaces:
ErrorManagerConfiguration
,FilterConfiguration
,FormatterConfiguration
,HandlerConfiguration
,PojoConfiguration
public interface PropertyConfigurable
An object which is configurable via object properties.
- Author:
- David M. Lloyd
-
Method Summary
Modifier and TypeMethodDescriptionboolean
addPostConfigurationMethod
(String methodName) Adds a method name to be invoked after all properties have been set.Returns a collection of the constructor properties.Returns a collection of the methods to be invoked after the properties have been set.Get the names of the configured properties in order.getPropertyValueExpression
(String propertyName) Get the property value.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
removePostConfigurationMethod
(String methodName) Removes the post configuration method.boolean
removeProperty
(String propertyName) Remove a configured property.void
setPostConfigurationMethods
(String... methodNames) Sets the method names to be invoked after the properties have been set.void
setPostConfigurationMethods
(List<String> methodNames) Sets the method names to be invoked after the properties have been set.void
setPropertyValueExpression
(String propertyName, String expression) Sets the expression value for the property.void
setPropertyValueExpression
(String propertyName, String expression, String value) Sets the expression value for the property.void
setPropertyValueString
(String propertyName, String value) Set a property value from a string.
-
Method Details
-
setPropertyValueString
Set a property value from a string.- Parameters:
propertyName
- the property namevalue
- the property value- Throws:
IllegalArgumentException
- if the given value is not acceptable for this property
-
getPropertyValueString
Get the string property value with the given name.- Parameters:
propertyName
- the property name- Returns:
- the property value string
-
getPropertyValueExpression
Get the property value.- Parameters:
propertyName
- the property name- Returns:
- the property value
-
setPropertyValueExpression
Sets the expression value for the property.- Parameters:
propertyName
- the name of the propertyexpression
- the expression used to resolve the value
-
setPropertyValueExpression
Sets the expression value for the property. This method will not parse the expression for the value and instead use thevalue
parameter for the value.- Parameters:
propertyName
- the name of the propertyexpression
- the expression used to resolve the valuevalue
- the value to use
-
hasProperty
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
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
Get the names of the configured properties in order.- Returns:
- the property names
-
hasConstructorProperty
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, otherwisefalse
.
-
getConstructorProperties
Returns a collection of the constructor properties.- Returns:
- a collection of the constructor properties.
-
addPostConfigurationMethod
Adds a method name to be invoked after all properties have been set.- Parameters:
methodName
- the name of the method- Returns:
true
if the method was successfully added, otherwisefalse
-
getPostConfigurationMethods
Returns a collection of the methods to be invoked after the properties have been set.- Returns:
- a collection of method names or an empty list
-
setPostConfigurationMethods
Sets the method names to be invoked after the properties have been set.- Parameters:
methodNames
- the method names to invoke
-
setPostConfigurationMethods
Sets the method names to be invoked after the properties have been set.- Parameters:
methodNames
- the method names to invoke
-
removePostConfigurationMethod
Removes the post configuration method.- Parameters:
methodName
- the method to remove- Returns:
true
if the method was removed, otherwisefalse
-