Package net.sourceforge.pmd.properties

Class FileProperty

java.lang.Object

net.sourceforge.pmd.properties.FileProperty

All Implemented Interfaces:

Comparable<PropertyDescriptor<?>>, PropertyDescriptor<File>, SingleValuePropertyDescriptor<File>

@Deprecated
public final class FileProperty
extends Object

Deprecated.

Will be removed with 7.0.0 with no scheduled replacement

Property taking a File object as its value.

Version:

Refactored June 2017 (6.0.0)

Author:

Brian Remedios

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileProperty.FilePBuilder	Deprecated.

Constructor Summary

Constructors

Constructor	Description
FileProperty(String theName, String theDescription, File theDefault, float theUIOrder)	Deprecated. Constructor for file property.

Method Summary

Modifier and Type	Method	Description
protected void	addAttributesTo(Map<PropertyDescriptorField,String> attributes)	Adds this property's attributes to the map.
String	asDelimitedString(T value)	Deprecated. Formats the object onto a string suitable for storage within the property map.
protected String	asString(T value)	Deprecated. Returns a string representation of the value, even if it's null.
Map<PropertyDescriptorField,String>	attributeValuesById()	Returns a map representing all the property attributes of the receiver in string form.
int	compareTo(PropertyDescriptor<?> otherProperty)
File	createFrom(String propertyString)	Deprecated. Parse a string and returns an instance of a value.
protected String	defaultAsString()	Deprecated. Returns a string representation of the default value.
T	defaultValue()	Deprecated. Default value to use when the user hasn't specified one or when they wish to revert to a known-good state.
String	description()	Describes the property and the role it plays within the rule it is specified for.
boolean	equals(Object obj)
String	errorFor(T value)	Deprecated. Validation function that returns a diagnostic error message for a sample property value.
int	hashCode()
boolean	isDefinedExternally()	True if this descriptor was defined in the ruleset xml.
boolean	isMultiValue()	Deprecated. Returns whether the property is multi-valued, i.e.
String	name()	The name of the property without spaces as it serves as the key into the property map.
static FileProperty.FilePBuilder	named(String name)	Deprecated.
int	preferredRowCount()	If the datatype is a String then return the preferred number of rows to allocate in the text widget, returns a value of one for all other types.
String	propertyErrorFor(Rule rule)	Deprecated. A convenience method that returns an error string if the rule holds onto a property value that has a problem.
String	toString()
Class<File>	type()	Deprecated. Denotes the value datatype.
float	uiOrder()	Denotes the relative order the property field should occupy if we are using an auto-generated UI to display and edit property values.
protected String	valueErrorFor(T value)	Deprecated. Checks the value for an error.
T	valueFrom(String valueString)	Deprecated. Returns the value represented by this string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sourceforge.pmd.properties.PropertyDescriptor

attributeValuesById, compareTo, description, isDefinedExternally, name, preferredRowCount, uiOrder

Constructor Detail

FileProperty

public FileProperty(String theName,
                    String theDescription,
                    File theDefault,
                    float theUIOrder)

Deprecated.

Constructor for file property.

Parameters:

theName - Name of the property

theDescription - Description

theDefault - Default value

theUIOrder - UI order

Method Detail

type

public Class<File> type()

Deprecated.

Description copied from interface: PropertyDescriptor

Denotes the value datatype. For multi value properties, this is not the List class but the list's component class.

Returns:

Class literal of the value type

createFrom

public File createFrom(String propertyString)

Deprecated.

Parse a string and returns an instance of a value.

Parameters:

propertyString - String to parse

Returns:

An instance of a value

named

public static FileProperty.FilePBuilder named(String name)

Deprecated.

defaultValue

public final T defaultValue()

Deprecated.

Description copied from interface: PropertyDescriptor

Default value to use when the user hasn't specified one or when they wish to revert to a known-good state.

Specified by:

defaultValue in interface PropertyDescriptor<T>

Returns:

Object

isMultiValue

public final boolean isMultiValue()

Deprecated.

Description copied from interface: PropertyDescriptor

Returns whether the property is multi-valued, i.e. an array of strings,

As unary property rule properties will return a value of one, you must use the get/setProperty accessors when working with the actual values. When working with multi-value properties then the get/setProperties accessors must be used.

Specified by:

isMultiValue in interface PropertyDescriptor<T>

Returns:

boolean

asDelimitedString

public String asDelimitedString(T value)

Deprecated.

Description copied from interface: PropertyDescriptor

Formats the object onto a string suitable for storage within the property map.

Specified by:

asDelimitedString in interface PropertyDescriptor<T>

Parameters:

value - Object

Returns:

String

asString

protected String asString(T value)

Deprecated.

Returns a string representation of the value, even if it's null.

Parameters:

value - The value to describe

Returns:

A string representation of the value

propertyErrorFor

public String propertyErrorFor(Rule rule)

Deprecated.

Description copied from interface: PropertyDescriptor

A convenience method that returns an error string if the rule holds onto a property value that has a problem. Returns null otherwise.

Specified by:

propertyErrorFor in interface PropertyDescriptor<T>

Parameters:

rule - Rule

Returns:

String

errorFor

public String errorFor(T value)

Deprecated.

Description copied from interface: PropertyDescriptor

Validation function that returns a diagnostic error message for a sample property value. Returns null if the value is acceptable.

Specified by:

errorFor in interface PropertyDescriptor<T>

Parameters:

value - The value to check.

Returns:

A diagnostic message.

valueErrorFor

protected String valueErrorFor(T value)

Deprecated.

Checks the value for an error.

Parameters:

value - Value to check

Returns:

A diagnostic error message, or null if there's no problem

defaultAsString

protected final String defaultAsString()

Deprecated.

Returns a string representation of the default value.

Returns:

A string representation of the default value.

valueFrom

public final T valueFrom(String valueString)
                  throws IllegalArgumentException

Deprecated.

Description copied from interface: PropertyDescriptor

Returns the value represented by this string.

Specified by:

valueFrom in interface PropertyDescriptor<T>

Parameters:

valueString - The string to parse

Returns:

The value represented by the string

Throws:

IllegalArgumentException - if the given string cannot be parsed

description

public String description()

Description copied from interface: PropertyDescriptor

Describes the property and the role it plays within the rule it is specified for. Could be used in a tooltip.

Specified by:

description in interface PropertyDescriptor<T>

Returns:

String

uiOrder

public float uiOrder()

Description copied from interface: PropertyDescriptor

Denotes the relative order the property field should occupy if we are using an auto-generated UI to display and edit property values. If the value returned has a non-zero fractional part then this is can be used to place adjacent fields on the same row.

Specified by:

uiOrder in interface PropertyDescriptor<T>

Returns:

The relative order compared to other properties of the same rule

compareTo

public final int compareTo(PropertyDescriptor<?> otherProperty)

Specified by:

compareTo in interface Comparable<T>

Specified by:

compareTo in interface PropertyDescriptor<T>

preferredRowCount

public int preferredRowCount()

Description copied from interface: PropertyDescriptor

If the datatype is a String then return the preferred number of rows to allocate in the text widget, returns a value of one for all other types. Useful for multi-line XPATH editors.

Specified by:

preferredRowCount in interface PropertyDescriptor<T>

Returns:

int

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

name

public String name()

Description copied from interface: PropertyDescriptor

The name of the property without spaces as it serves as the key into the property map.

Specified by:

name in interface PropertyDescriptor<T>

Returns:

String

attributeValuesById

public final Map<PropertyDescriptorField,String> attributeValuesById()

Description copied from interface: PropertyDescriptor

Returns a map representing all the property attributes of the receiver in string form.

Specified by:

attributeValuesById in interface PropertyDescriptor<T>

Returns:

map

addAttributesTo

protected void addAttributesTo(Map<PropertyDescriptorField,String> attributes)

Adds this property's attributes to the map. Subclasses can override this to add more PropertyDescriptorField.

Parameters:

attributes - The map to fill

isDefinedExternally

public boolean isDefinedExternally()

Description copied from interface: PropertyDescriptor

True if this descriptor was defined in the ruleset xml. This precision is necessary for the RuleSetWriter to write out the property correctly: if it was defined externally, then its definition must be written out, otherwise only its value.

Specified by:

isDefinedExternally in interface PropertyDescriptor<T>

Returns:

True if the descriptor was defined in xml