PropertyDescriptorBuilder (PMD Core 6.10.0 API)

java.lang.Object
- net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder<E,T>

Type Parameters:

E - Value type of the built descriptor

T - Concrete type of this builder instance. Removes code duplication at the expense of a few unchecked casts. Everything goes well if this parameter's value is correctly set.

Direct Known Subclasses:

MultiValuePropertyBuilder, SingleValuePropertyBuilder
```
@Deprecated
public abstract class PropertyDescriptorBuilder<E,T extends PropertyDescriptorBuilder<E,T>>
extends java.lang.Object
```
Deprecated.
From 7.0.0 on, the only supported way to build properties will be through PropertyFactory. This class hierarchy is replaced by the newer PropertyBuilder.

Base class for property builders.

Since:

6.0.0

Author:

Clément Fournier

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.lang.String`	`description`	Deprecated.
`protected boolean`	`isDefinedInXML`	Deprecated.
`protected java.lang.String`	`name`	Deprecated.
`protected float`	`uiOrder`	Deprecated.

Constructor Summary

Constructors
Modifier Constructor Description

protected PropertyDescriptorBuilder(java.lang.String name)
Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`abstract PropertyDescriptor<E>`	`build()`	Deprecated. Builds the descriptor and returns it.
`T`	`desc(java.lang.String desc)`	Deprecated. Specify the description of the property.
`java.lang.String`	`getName()`	Deprecated. Returns the name of the property to be built.
`T`	`uiOrder(float f)`	Deprecated. See `PropertyDescriptor.uiOrder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
protected java.lang.String name
```
    Deprecated.
  - description
```
protected java.lang.String description
```
    Deprecated.
  - uiOrder
```
protected float uiOrder
```
    Deprecated.
  - isDefinedInXML
```
protected boolean isDefinedInXML
```
    Deprecated.
- Constructor Detail
  - PropertyDescriptorBuilder
```
protected PropertyDescriptorBuilder(java.lang.String name)
```
    Deprecated.
- Method Detail
  - desc
```
public T desc(java.lang.String desc)
```
    Deprecated.
    
    Specify the description of the property.
    
    Parameters:
    
    desc - The description
    
    Returns:
    
    The same builder
  - uiOrder
```
@Deprecated
public T uiOrder(float f)
```
    Deprecated.
    See PropertyDescriptor.uiOrder()
    
    Specify the UI order of the property.
    
    Parameters:
    
    f - The UI order
    
    Returns:
    
    The same builder
  - build
```
public abstract PropertyDescriptor<E> build()
```
    Deprecated.
    
    Builds the descriptor and returns it.
    
    Returns:
    
    The built descriptor
    
    Throws:
    
    java.lang.IllegalArgumentException - if parameters are incorrect
  - getName
```
public java.lang.String getName()
```
    Deprecated.
    
    Returns the name of the property to be built.