Package com.puppycrawl.tools.checkstyle.site

Class SiteUtil.DescriptionTraversalState

java.lang.Object

com.puppycrawl.tools.checkstyle.site.SiteUtil.DescriptionTraversalState

Enclosing class:

SiteUtil

private static final class SiteUtil.DescriptionTraversalState
extends Object

Mutable state bag used during DFS traversal in SiteUtil.getDescriptionFromJavadocForXdoc(DetailNode, String). Extracting these flags into a dedicated class reduces the cyclomatic complexity of the traversal method without changing any logic.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	inCodeLiteral	Whether we are currently inside a @code ... inline tag.
private boolean	inHrefAttribute	Whether the next ATTRIBUTE_VALUE token is the value of an href attribute.
private boolean	inHtmlElement	Whether we are currently inside an HTML element.
private boolean	inLiteralTag	Whether we are currently inside a {@literal ...} inline tag.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DescriptionTraversalState()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

inCodeLiteral

private boolean inCodeLiteral

Whether we are currently inside a @code ... inline tag.

inLiteralTag

private boolean inLiteralTag

Whether we are currently inside a {@literal ...} inline tag.

inHtmlElement

private boolean inHtmlElement

Whether we are currently inside an HTML element.

inHrefAttribute

private boolean inHrefAttribute

Whether the next ATTRIBUTE_VALUE token is the value of an href attribute.

Constructor Details

DescriptionTraversalState

private DescriptionTraversalState()