Package net.sourceforge.pmd.properties
Class PropertyBuilder<B extends PropertyBuilder<B,T>,T>
- java.lang.Object
-
- net.sourceforge.pmd.properties.PropertyBuilder<B,T>
-
- Type Parameters:
B
- Concrete type of this builder instanceT
- Type of values the property handles
- Direct Known Subclasses:
PropertyBuilder.GenericCollectionPropertyBuilder
,PropertyBuilder.GenericPropertyBuilder
,PropertyBuilder.RegexPropertyBuilder
public abstract class PropertyBuilder<B extends PropertyBuilder<B,T>,T> extends Object
Base class for generic property builders. Property builders are obtained from thePropertyFactory
, and are used to buildPropertyDescriptor
s.All properties must specify the following attributes to build properly:
- A name: filled-in when obtaining the builder
- A description: see
desc(String)
- A default value: see
defaultValue(Object)
The
PropertyDescriptor
may be built after those required steps by callingbuild()
.A property builder may throw
IllegalArgumentException
at any stage during the build process to indicate invalid input. It usually tries to do so as early as possible, rather than waiting for the call tobuild()
.Note: from 7.0.0 on, all property builders will extend this class instead of
PropertyDescriptorBuilder
.- Since:
- 6.10.0
- Author:
- Clément Fournier
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PropertyBuilder.GenericCollectionPropertyBuilder<V,C extends Collection<V>>
Generic builder for a collection-valued property.static class
PropertyBuilder.GenericPropertyBuilder<T>
Generic builder for a single-value property.static class
PropertyBuilder.RegexPropertyBuilder
Specialized builder for regex properties.
-
Field Summary
Fields Modifier and Type Field Description protected boolean
isDefinedExternally
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract PropertyDescriptor<T>
build()
Builds the descriptor and returns it.B
defaultValue(T val)
Specify a default value.B
desc(String desc)
Specify the description of the property.String
getName()
Returns the name of the property to be built.B
require(PropertyConstraint<? super T> constraint)
Add a constraint on the values that this property may take.
-
-
-
Method Detail
-
desc
public B desc(String desc)
Specify the description of the property. This is used for documentation. Please describe precisely how the property may change the behaviour of the rule. Providing complete information should be preferred over being concise.Calling this method is required for
build()
to succeed.- Parameters:
desc
- The description- Returns:
- The same builder
- Throws:
IllegalArgumentException
- If the description is null or whitespace
-
require
public B require(PropertyConstraint<? super T> constraint)
Add a constraint on the values that this property may take. The validity of values will be checked when parsing the XML, and invalid values will be reported. A rule will never be run if some of its properties violate some constraints.- Parameters:
constraint
- The constraint- Returns:
- The same builder
- See Also:
NumericConstraints
-
defaultValue
public B defaultValue(T val)
Specify a default value. Some subclasses provide convenient related methods, see e.g.PropertyBuilder.GenericCollectionPropertyBuilder.defaultValues(Object, Object[])
. Using the null value is prohibited.Calling this method is required for
build()
to succeed.- Parameters:
val
- Default value- Returns:
- The same builder
- Throws:
IllegalArgumentException
- If the argument is null
-
build
public abstract PropertyDescriptor<T> build()
Builds the descriptor and returns it.- Returns:
- The built descriptor
- Throws:
IllegalArgumentException
- if the description or default value were not provided, or if the default value doesn't satisfy the given constraints
-
getName
public String getName()
Returns the name of the property to be built.
-
-