Class PropertyDetails.Builder

java.lang.Object

com.puppycrawl.tools.checkstyle.site.PropertyDetails.Builder

Enclosing class:

PropertyDetails

public static final class PropertyDetails.Builder
extends Object

Builder for PropertyDetails.

Field Summary

Fields

Modifier and Type	Field	Description
private List<String>	buildConfigurableTokens	The configurable token names.
private String	buildDefaultValue	The default value string.
private List<String>	buildDefaultValueTokens	The default value token names.
private String	buildDescription	The xdoc-safe HTML description.
private String	buildName	The property name.
private String	buildSinceVersion	The since version string.
private PropertyDetails.TokenPropertyType	buildTokenPropertyType	The token property type; defaults to STANDARD.
private String	buildType	The resolved type string.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PropertyDetails	build()	Builds and returns the PropertyDetails.
PropertyDetails.Builder	configurableTokens(Collection<String> val)	Sets the configurable token names.
PropertyDetails.Builder	defaultValue(String val)	Sets the default value string.
PropertyDetails.Builder	defaultValueTokens(Collection<String> val)	Sets the default value token names.
PropertyDetails.Builder	description(String val)	Sets the xdoc-safe HTML description.
PropertyDetails.Builder	name(String val)	Sets the property name.
PropertyDetails.Builder	sinceVersion(String val)	Sets the since version string.
PropertyDetails.Builder	tokenPropertyType(PropertyDetails.TokenPropertyType val)	Sets the token property type.
PropertyDetails.Builder	type(String val)	Sets the resolved type string.

Methods inherited from class Object

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

Field Details

buildName

private String buildName

The property name.

buildDescription

private String buildDescription

The xdoc-safe HTML description.

buildType

private String buildType

The resolved type string.

buildTokenPropertyType

private PropertyDetails.TokenPropertyType buildTokenPropertyType

The token property type; defaults to STANDARD.

buildConfigurableTokens

private List<String> buildConfigurableTokens

The configurable token names.

buildDefaultValue

private String buildDefaultValue

The default value string.

buildDefaultValueTokens

private List<String> buildDefaultValueTokens

The default value token names.

buildSinceVersion

private String buildSinceVersion

The since version string.

Constructor Details

Builder

public Builder()

Method Details

name

public PropertyDetails.Builder name(String val)

Sets the property name.

Parameters:

val - the property name.

Returns:

this builder.

description

public PropertyDetails.Builder description(String val)

Sets the xdoc-safe HTML description.

Parameters:

val - the description.

Returns:

this builder.

type

public PropertyDetails.Builder type(String val)

Sets the resolved type string.

Parameters:

val - the type string.

Returns:

this builder.

tokenPropertyType

public PropertyDetails.Builder tokenPropertyType(PropertyDetails.TokenPropertyType val)

Sets the token property type.

Parameters:

val - the token property type.

Returns:

this builder.

configurableTokens

public PropertyDetails.Builder configurableTokens(Collection<String> val)

Sets the configurable token names.

Parameters:

val - the list of token names.

Returns:

this builder.

defaultValue

public PropertyDetails.Builder defaultValue(String val)

Sets the default value string.

Parameters:

val - the default value string.

Returns:

this builder.

defaultValueTokens

public PropertyDetails.Builder defaultValueTokens(Collection<String> val)

Sets the default value token names.

Parameters:

val - the list of token names.

Returns:

this builder.

sinceVersion

public PropertyDetails.Builder sinceVersion(String val)

Sets the since version string.

Parameters:

val - the since version.

Returns:

this builder.

build

public PropertyDetails build()

Builds and returns the PropertyDetails.

Returns:

a new PropertyDetails instance.