public abstract class AbstractPropertySource extends Object implements PropertySource
| Modifier and Type | Field and Description |
|---|---|
protected List<PropertyDescriptor<?>> |
propertyDescriptors
The list of known properties that can be configured.
|
protected Map<PropertyDescriptor<?>,Object> |
propertyValuesByDescriptor
The values for each property.
|
| Constructor and Description |
|---|
AbstractPropertySource()
Creates a new empty property source.
|
| Modifier and Type | Method and Description |
|---|---|
protected List<PropertyDescriptor<?>> |
copyPropertyDescriptors()
Creates a copied list of the property descriptors and returns it.
|
protected Map<PropertyDescriptor<?>,Object> |
copyPropertyValues()
Creates a copied map of the values of the properties and returns it.
|
void |
definePropertyDescriptor(PropertyDescriptor<?> propertyDescriptor)
Define a new property via a PropertyDescriptor.
|
String |
dysfunctionReason()
Returns a description of why the receiver may be dysfunctional.
|
abstract String |
getName()
Gets the name of the property source.
|
Map<PropertyDescriptor<?>,Object> |
getPropertiesByPropertyDescriptor()
Returns all the current property values for the receiver or an immutable
empty map if none are specified.
|
<T> T |
getProperty(PropertyDescriptor<T> propertyDescriptor)
Get the typed value for the given property.
|
PropertyDescriptor<?> |
getPropertyDescriptor(String name)
Get the PropertyDescriptor for the given property name.
|
List<PropertyDescriptor<?>> |
getPropertyDescriptors()
Get the PropertyDescriptors for all defined properties.
|
boolean |
hasDescriptor(PropertyDescriptor<?> descriptor)
Returns whether this Rule has the specified PropertyDescriptor.
|
Set<PropertyDescriptor<?>> |
ignoredProperties()
Return the properties that are effectively ignored due to the
configuration of the rule and values held by other properties.
|
<T> void |
setProperty(PropertyDescriptor<T> propertyDescriptor,
T value)
Set the property value specified (will be type-checked)
|
void |
useDefaultValueFor(PropertyDescriptor<?> desc)
Clears out any user-specified value for the property allowing it to use
the default value in the descriptor.
|
boolean |
usesDefaultValues()
Returns whether this Rule uses default values for properties.
|
protected List<PropertyDescriptor<?>> propertyDescriptors
protected Map<PropertyDescriptor<?>,Object> propertyValuesByDescriptor
public AbstractPropertySource()
protected List<PropertyDescriptor<?>> copyPropertyDescriptors()
protected Map<PropertyDescriptor<?>,Object> copyPropertyValues()
public Set<PropertyDescriptor<?>> ignoredProperties()
ignoredProperties in interface PropertySourcepublic void definePropertyDescriptor(PropertyDescriptor<?> propertyDescriptor)
definePropertyDescriptor in interface PropertySourcepropertyDescriptor - The property descriptor.public abstract String getName()
public PropertyDescriptor<?> getPropertyDescriptor(String name)
getPropertyDescriptor in interface PropertySourcename - The name of the property.null
if there is no such property defined.public boolean hasDescriptor(PropertyDescriptor<?> descriptor)
hasDescriptor in interface PropertySourcedescriptor - The PropertyDescriptor for which to check.true if the descriptor is present,
false otherwise.public List<PropertyDescriptor<?>> getPropertyDescriptors()
getPropertyDescriptors in interface PropertySourcepublic <T> T getProperty(PropertyDescriptor<T> propertyDescriptor)
getProperty in interface PropertySourceT - The underlying type of the property descriptor.propertyDescriptor - The property descriptor.public <T> void setProperty(PropertyDescriptor<T> propertyDescriptor, T value)
setProperty in interface PropertySourceT - The underlying type of the property descriptor.propertyDescriptor - The property descriptor.value - The value to set.public Map<PropertyDescriptor<?>,Object> getPropertiesByPropertyDescriptor()
getPropertiesByPropertyDescriptor in interface PropertySourcepublic boolean usesDefaultValues()
usesDefaultValues in interface PropertySourcetrue if the properties all have default
values, false otherwise.public void useDefaultValueFor(PropertyDescriptor<?> desc)
useDefaultValueFor in interface PropertySourcedesc - the property to clear outpublic String dysfunctionReason()
dysfunctionReason in interface PropertySourceCopyright © 2002-2014 InfoEther. All Rights Reserved.