net.sourceforge.pmd.properties.builders

Class PropertyDescriptorBuilderConversionWrapper<E,T extends PropertyDescriptorBuilder<E,T>>

java.lang.Object

net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper<E,T>

Type Parameters:

E - Value type of the descriptor

T - Concrete type of the underlying builder

All Implemented Interfaces:

PropertyDescriptorExternalBuilder<E>

Direct Known Subclasses:

PropertyDescriptorBuilderConversionWrapper.MultiValue, PropertyDescriptorBuilderConversionWrapper.SingleValue

public abstract class PropertyDescriptorBuilderConversionWrapper<E,T extends PropertyDescriptorBuilder<E,T>>
extends java.lang.Object
implements PropertyDescriptorExternalBuilder<E>

Wraps a property builder and maps its inputs from strings to the target types of the descriptor.

Since:

6.0.0

Author:

Clément Fournier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyDescriptorBuilderConversionWrapper.MultiValue<V,T extends MultiValuePropertyBuilder<V,T>> For multi-value properties.
static class	PropertyDescriptorBuilderConversionWrapper.SingleValue<E,T extends SingleValuePropertyBuilder<E,T>> For single-value properties.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyDescriptorBuilderConversionWrapper(java.lang.Class<?> valueType)

Method Summary

Modifier and Type	Method and Description
PropertyDescriptor<E>	build(java.util.Map<PropertyDescriptorField,java.lang.String> fields) Builds a descriptor.
abstract boolean	isMultiValue() Whether this descriptor is multi-valued.
protected static java.lang.String[]	legalPackageNamesIn(java.util.Map<PropertyDescriptorField,java.lang.String> valuesById, char delimiter)
protected abstract T	newBuilder(java.lang.String name)
protected void	populate(T builder, java.util.Map<PropertyDescriptorField,java.lang.String> fields) Populates the builder with extracted fields.
java.lang.Class<?>	valueType() Type of the values of the descriptor, or component type if this descriptor is multi-valued.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyDescriptorBuilderConversionWrapper

protected PropertyDescriptorBuilderConversionWrapper(java.lang.Class<?> valueType)

Method Detail

populate

protected void populate(T builder,
                        java.util.Map<PropertyDescriptorField,java.lang.String> fields)

Populates the builder with extracted fields. To be overridden.

isMultiValue

public abstract boolean isMultiValue()

Description copied from interface: PropertyDescriptorExternalBuilder

Whether this descriptor is multi-valued.

Specified by:

isMultiValue in interface PropertyDescriptorExternalBuilder<E>

Returns:

True if this descriptor is multi-valued

valueType

public java.lang.Class<?> valueType()

Description copied from interface: PropertyDescriptorExternalBuilder

Type of the values of the descriptor, or component type if this descriptor is multi-valued.

Specified by:

valueType in interface PropertyDescriptorExternalBuilder<E>

Returns:

Type of the values

newBuilder

protected abstract T newBuilder(java.lang.String name)

build

public PropertyDescriptor<E> build(java.util.Map<PropertyDescriptorField,java.lang.String> fields)

Description copied from interface: PropertyDescriptorExternalBuilder

Builds a descriptor. The descriptor returned is tagged as built externally.

Specified by:

build in interface PropertyDescriptorExternalBuilder<E>

Parameters:

fields - Key value pairs

Returns:

A builder

legalPackageNamesIn

protected static java.lang.String[] legalPackageNamesIn(java.util.Map<PropertyDescriptorField,java.lang.String> valuesById,
                                                        char delimiter)