public interface PropertySource
PropertySource
.
These are e.g. Rules and Renderers.Modifier and Type | Method and Description |
---|---|
void |
definePropertyDescriptor(PropertyDescriptor<?> propertyDescriptor)
Define a new property via a PropertyDescriptor.
|
String |
dysfunctionReason()
Returns a description of why the receiver may be dysfunctional.
|
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.
|
void definePropertyDescriptor(PropertyDescriptor<?> propertyDescriptor) throws IllegalArgumentException
propertyDescriptor
- The property descriptor.IllegalArgumentException
- If there is already a property defined the same name.PropertyDescriptor<?> getPropertyDescriptor(String name)
name
- The name of the property.null
if there is no such property defined.List<PropertyDescriptor<?>> getPropertyDescriptors()
<T> T getProperty(PropertyDescriptor<T> propertyDescriptor)
T
- The underlying type of the property descriptor.propertyDescriptor
- The property descriptor.<T> void setProperty(PropertyDescriptor<T> propertyDescriptor, T value)
T
- The underlying type of the property descriptor.propertyDescriptor
- The property descriptor.value
- The value to set.Map<PropertyDescriptor<?>,Object> getPropertiesByPropertyDescriptor()
boolean hasDescriptor(PropertyDescriptor<?> descriptor)
descriptor
- The PropertyDescriptor for which to check.true
if the descriptor is present,
false
otherwise.boolean usesDefaultValues()
true
if the properties all have default
values, false
otherwise.void useDefaultValueFor(PropertyDescriptor<?> desc)
desc
- the property to clear outSet<PropertyDescriptor<?>> ignoredProperties()
String dysfunctionReason()
Copyright © 2002–2017 PMD. All rights reserved.