Package com.puppycrawl.tools.checkstyle.site

Class PropertyDetails

java.lang.Object

com.puppycrawl.tools.checkstyle.site.PropertyDetails

public final class PropertyDetails
extends Object

Immutable data object holding all pre-computed details for a single module property. Built by SiteUtil.buildPropertyDetails(java.util.Set<java.lang.String>, java.lang.String, java.nio.file.Path, java.lang.Object); consumed by PropertiesMacro purely for formatting. No internal Checkstyle AST or Javadoc tree types appear here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PropertyDetails.Builder	Builder for PropertyDetails.
static enum	PropertyDetails.TokenPropertyType	Describes how the type cell and default-value cell should be rendered for token-related properties.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<String>	configurableTokens	The list of configurable token names used when tokenPropertyType is PropertyDetails.TokenPropertyType.TOKEN_SUBSET or PropertyDetails.TokenPropertyType.JAVADOC_TOKEN_SUBSET.
private final String	defaultValue	The pre-resolved default value string, e.g.
private final List<String>	defaultValueTokens	Pre-resolved list of token names used when the default-value cell must render each token as an individual link.
private final String	description	The human-readable description, already rendered as xdoc-safe HTML.
private final String	name	The property name.
private final String	sinceVersion	The "since" version string, e.g.
private final PropertyDetails.TokenPropertyType	tokenPropertyType	Determines how the type cell is rendered by PropertiesMacro.
private final String	type	The resolved type string, e.g.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PropertyDetails(PropertyDetails.Builder builder)	Creates a new PropertyDetails from the given builder.

Method Summary

Modifier and Type	Method	Description
List<String>	getConfigurableTokens()	Returns the list of configurable token names.
String	getDefaultValue()	Returns the pre-resolved default value string.
List<String>	getDefaultValueTokens()	Returns the list of token names to render as individual links in the default-value cell.
String	getDescription()	Returns the xdoc-safe HTML description.
String	getName()	Returns the property name.
String	getSinceVersion()	Returns the "since" version string.
PropertyDetails.TokenPropertyType	getTokenPropertyType()	Returns the rendering strategy for the type and default-value cells.
String	getType()	Returns the resolved type string.

Methods inherited from class java.lang.Object

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

Field Details

name

private final String name

The property name.

description

private final String description

The human-readable description, already rendered as xdoc-safe HTML. Produced by SiteUtil.getPropertyDescriptionForXdoc.

type

private final String type

The resolved type string, e.g. "boolean", "int", "subset of tokens TokenTypes". Meaningful only when tokenPropertyType is PropertyDetails.TokenPropertyType.STANDARD.

tokenPropertyType

private final PropertyDetails.TokenPropertyType tokenPropertyType

Determines how the type cell is rendered by PropertiesMacro. Defaults to PropertyDetails.TokenPropertyType.STANDARD.

configurableTokens

private final List<String> configurableTokens

The list of configurable token names used when tokenPropertyType is PropertyDetails.TokenPropertyType.TOKEN_SUBSET or PropertyDetails.TokenPropertyType.JAVADOC_TOKEN_SUBSET. Empty otherwise.

defaultValue

private final String defaultValue

The pre-resolved default value string, e.g. "{}", "true", "all files", "TokenTypes". When the default value cell must render individual token links, defaultValueTokens is used instead and this field is empty.

defaultValueTokens

private final List<String> defaultValueTokens

Pre-resolved list of token names used when the default-value cell must render each token as an individual link. Empty when defaultValue should be rendered verbatim.

sinceVersion

private final String sinceVersion

The "since" version string, e.g. "8.3".

Constructor Details

PropertyDetails

private PropertyDetails(PropertyDetails.Builder builder)

Creates a new PropertyDetails from the given builder.

Parameters:

builder - the builder to copy field values from.

Method Details

getName

public String getName()

Returns the property name.

Returns:

the property name.

getDescription

public String getDescription()

Returns the xdoc-safe HTML description.

Returns:

the description.

getType

public String getType()

Returns the resolved type string. Meaningful only when getTokenPropertyType() is PropertyDetails.TokenPropertyType.STANDARD.

Returns:

the type string, or null for token properties.

getTokenPropertyType

public PropertyDetails.TokenPropertyType getTokenPropertyType()

Returns the rendering strategy for the type and default-value cells.

Returns:

the token property type.

getConfigurableTokens

public List<String> getConfigurableTokens()

Returns the list of configurable token names. Non-empty only when getTokenPropertyType() is PropertyDetails.TokenPropertyType.TOKEN_SUBSET or PropertyDetails.TokenPropertyType.JAVADOC_TOKEN_SUBSET.

Returns:

an unmodifiable list of token names.

getDefaultValue

public String getDefaultValue()

Returns the pre-resolved default value string. Empty when getDefaultValueTokens() should be used instead.

Returns:

the default value string.

getDefaultValueTokens

public List<String> getDefaultValueTokens()

Returns the list of token names to render as individual links in the default-value cell. Empty when getDefaultValue() should be used instead.

Returns:

an unmodifiable list of token names.

getSinceVersion

public String getSinceVersion()

Returns the "since" version string.

Returns:

the since version.