Uses of Interface
com.puppycrawl.tools.checkstyle.api.DetailNode

Packages that use DetailNode

Package	Description
com.puppycrawl.tools.checkstyle	Contains the implementation of the Checkstyle framework.
com.puppycrawl.tools.checkstyle.api	Contains the core API to be used to implement checks.
com.puppycrawl.tools.checkstyle.checks.annotation	Contains the Annotation checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.javadoc	Contains the Javadoc checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.gui	User interface classes for CheckStyle.
com.puppycrawl.tools.checkstyle.meta	Contains module metadata generation classes for checkstyle.
com.puppycrawl.tools.checkstyle.site	Contains classes for generating the Checkstyle website.
com.puppycrawl.tools.checkstyle.utils	Contains utils classes for checkstyle.

Uses of DetailNode in com.puppycrawl.tools.checkstyle

Fields in com.puppycrawl.tools.checkstyle declared as DetailNode

Modifier and Type	Field	Description
private DetailNode	JavadocDetailNodeParser.ParseStatus.tree	DetailNode tree (is null if parsing fails).

Methods in com.puppycrawl.tools.checkstyle that return DetailNode

Modifier and Type	Method	Description
private DetailNode	JavadocDetailNodeParser.convertParseTreeToDetailNode(org.antlr.v4.runtime.tree.ParseTree parseTreeNode)	Converts ParseTree (that is generated by ANTLRv4) to DetailNode tree.
DetailNode	JavadocDetailNodeParser.ParseStatus.getTree()	Getter for DetailNode tree.
private static DetailNode	DetailNodeTreeStringPrinter.parseFile(File file)	Parse a file and return the parse tree.
static DetailNode	DetailNodeTreeStringPrinter.parseJavadocAsDetailNode(DetailAST blockComment)	Parse block comment DetailAST as Javadoc DetailNode tree.
private static DetailNode	DetailNodeTreeStringPrinter.parseJavadocAsDetailNode(String javadocComment)	Parse javadoc comment to DetailNode tree.

Methods in com.puppycrawl.tools.checkstyle with parameters of type DetailNode

Modifier and Type	Method	Description
private void	JavadocDetailNodeParser.adjustFirstLineToJavadocIndent(DetailNode tree, int javadocColumnNumber)	Adjust first line nodes to javadoc indent.
private JavadocNodeImpl[]	JavadocDetailNodeParser.createChildrenNodes(DetailNode parentJavadocNode, org.antlr.v4.runtime.tree.ParseTree parseTreeNode)	Creates children Javadoc nodes base on ParseTree node's children.
private JavadocNodeImpl	JavadocDetailNodeParser.createJavadocNode(org.antlr.v4.runtime.tree.ParseTree parseTree, DetailNode parent, int index)	Creates JavadocNodeImpl node on base of ParseTree node.
private static void	JavadocPropertiesGenerator.formatHtmlElement(StringBuilder builder, DetailNode node)	Concatenates the HTML text from AST of a JavadocTokenTypes.HTML_ELEMENT.
private static void	JavadocPropertiesGenerator.formatInlineCodeTag(StringBuilder builder, DetailNode inlineTag)	Converts inline code tag into HTML form.
private static String	JavadocPropertiesGenerator.getFirstJavadocSentence(DetailNode tree)	Extracts the first sentence as HTML formatted text from a DetailNode.
private static String	DetailNodeTreeStringPrinter.getIndentation(DetailNode node)	Get indentation for a node.
static String	DetailNodeTreeStringPrinter.printTree(DetailNode ast, String rootPrefix, String prefix)	Print AST.
void	JavadocDetailNodeParser.ParseStatus.setTree(DetailNode tree)	Sets DetailNode tree.

Uses of DetailNode in com.puppycrawl.tools.checkstyle.api

Methods in com.puppycrawl.tools.checkstyle.api that return DetailNode

Modifier and Type	Method	Description
DetailNode[]	DetailNode.getChildren()	Array of children.
DetailNode	DetailNode.getParent()	Parent node.

Uses of DetailNode in com.puppycrawl.tools.checkstyle.checks.annotation

Methods in com.puppycrawl.tools.checkstyle.checks.annotation with parameters of type DetailNode

Modifier and Type	Method	Description
private boolean	MissingDeprecatedCheck.containsDeprecatedTag(DetailNode javadoc)	Checks to see if the javadoc contains a deprecated tag.
void	MissingDeprecatedCheck.visitJavadocToken(DetailNode ast)

Uses of DetailNode in com.puppycrawl.tools.checkstyle.checks.javadoc

Classes in com.puppycrawl.tools.checkstyle.checks.javadoc that implement DetailNode

Modifier and Type	Class	Description
class	JavadocNodeImpl	Implementation of DetailNode interface that is mutable.

Fields in com.puppycrawl.tools.checkstyle.checks.javadoc declared as DetailNode

Modifier and Type	Field	Description
private DetailNode[]	JavadocNodeImpl.children	Array of child nodes.
private DetailNode	JavadocNodeImpl.parent	Parent node.

Methods in com.puppycrawl.tools.checkstyle.checks.javadoc that return DetailNode

Modifier and Type	Method	Description
private static DetailNode	JavadocParagraphCheck.findFirstHtmlElementAfter(DetailNode tag)	Finds and returns first html element after the tag.
DetailNode[]	JavadocNodeImpl.getChildren()
private static DetailNode	SummaryJavadocCheck.getInlineTagNodeForAst(DetailNode ast)	Returns an inline javadoc tag node that is within a html tag.
private static DetailNode	JavadocParagraphCheck.getNearestEmptyLine(DetailNode node)	Finds and returns nearest empty line in javadoc.
private static DetailNode	JavadocParagraphCheck.getNearestNode(DetailNode node)	Returns nearest node.
private static DetailNode	JavadocMissingLeadingAsteriskCheck.getNextNode(DetailNode detailNode)	Gets next node in the ast (sibling or parent sibling for the last node).
private static DetailNode	JavadocParagraphCheck.getNextSibling(DetailNode tag)	Custom getNextSibling method to handle different types of paragraph tag.
DetailNode	JavadocNodeImpl.getParent()

Methods in com.puppycrawl.tools.checkstyle.checks.javadoc that return types with arguments of type DetailNode

Modifier and Type	Method	Description
private static List<DetailNode>	JavadocTagContinuationIndentationCheck.getAllNewlineNodes(DetailNode descriptionNode)	Finds and collects all NEWLINE nodes inside DESCRIPTION node.
private static Optional<DetailNode>	SummaryJavadocCheck.getInlineTagNode(DetailNode javadoc)	Gets the node for the inline tag if present.

Methods in com.puppycrawl.tools.checkstyle.checks.javadoc with parameters of type DetailNode

Modifier and Type	Method	Description
void	AbstractJavadocCheck.beginJavadocTree(DetailNode rootAst)	Called before the starting to process a tree.
void	JavadocLeadingAsteriskAlignCheck.beginJavadocTree(DetailNode rootAst)
private void	JavadocParagraphCheck.checkEmptyLine(DetailNode newline)	Determines whether or not the next line after empty line has paragraph tag in the beginning.
private void	AtclauseOrderCheck.checkOrderInTagSection(DetailNode javadoc)	Checks order of atclauses in tag section node.
private void	JavadocParagraphCheck.checkParagraphTag(DetailNode tag)	Determines whether or not the line with paragraph tag has previous empty line.
private static void	SummaryJavadocCheck.extractInlineTagContent(DetailNode node, StringBuilder customTagContent)	Extracts the content of inline custom tag recursively.
private static DetailNode	JavadocParagraphCheck.findFirstHtmlElementAfter(DetailNode tag)	Finds and returns first html element after the tag.
private static String	JavadocParagraphCheck.findFollowedBlockTagName(DetailNode tag)	Determines whether or not the paragraph tag is followed by block tag.
void	AbstractJavadocCheck.finishJavadocTree(DetailNode rootAst)	Called after finished processing a tree.
void	JavadocLeadingAsteriskAlignCheck.finishJavadocTree(DetailNode rootAst)
private static List<DetailNode>	JavadocTagContinuationIndentationCheck.getAllNewlineNodes(DetailNode descriptionNode)	Finds and collects all NEWLINE nodes inside DESCRIPTION node.
static String	SummaryJavadocCheck.getContentOfInlineCustomTag(DetailNode inlineTag)	Gets the content of inline custom tag.
private static Optional<String>	SummaryJavadocCheck.getFirstSentence(DetailNode ast, String period)	Finds the first sentence.
private static String	JavadocParagraphCheck.getHtmlElementName(DetailNode htmlElement)	Finds and returns first block-level html element name.
private static Optional<DetailNode>	SummaryJavadocCheck.getInlineTagNode(DetailNode javadoc)	Gets the node for the inline tag if present.
private static DetailNode	SummaryJavadocCheck.getInlineTagNodeForAst(DetailNode ast)	Returns an inline javadoc tag node that is within a html tag.
private static DetailNode	JavadocParagraphCheck.getNearestEmptyLine(DetailNode node)	Finds and returns nearest empty line in javadoc.
private static DetailNode	JavadocParagraphCheck.getNearestNode(DetailNode node)	Returns nearest node.
private static DetailNode	JavadocMissingLeadingAsteriskCheck.getNextNode(DetailNode detailNode)	Gets next node in the ast (sibling or parent sibling for the last node).
private static DetailNode	JavadocParagraphCheck.getNextSibling(DetailNode tag)	Custom getNextSibling method to handle different types of paragraph tag.
private static String	SummaryJavadocCheck.getStringInsideTag(String result, DetailNode detailNode)	Get concatenated string within text of html tags.
private static String	SummaryJavadocCheck.getSummarySentence(DetailNode ast)	Finds and returns summary sentence.
private static boolean	RequireEmptyLineBeforeBlockTagGroupCheck.hasInsufficientConsecutiveNewlines(DetailNode tagNode)	Returns true when there are not enough empty lines before the provided tagNode.
private boolean	SingleLineJavadocCheck.hasJavadocInlineTags(DetailNode javadocRoot)	Checks if comment has in-line tags which are not ignored.
private boolean	SingleLineJavadocCheck.hasJavadocTags(DetailNode javadocRoot)	Checks if comment has javadoc tags which are not ignored.
private static boolean	NonEmptyAtclauseDescriptionCheck.hasOnlyEmptyText(DetailNode description)	Tests if description node is empty (has only new lines and blank strings).
private static boolean	RequireEmptyLineBeforeBlockTagGroupCheck.isAnotherTagBefore(DetailNode tagNode)	Returns true when there is a javadoc tag before the provided tagNode.
private static boolean	JavadocTagContinuationIndentationCheck.isBlockDescription(DetailNode description)	Checks if the given description node is part of a block Javadoc tag.
private static boolean	JavadocBlockTagLocationCheck.isCommentOrInlineTag(DetailNode node)	Checks if the node can contain an unescaped block tag without violation.
private static boolean	SummaryJavadocCheck.isDefinedFirst(DetailNode inlineSummaryTag)	Whether the {@summary} tag is defined first in the javadoc.
private static boolean	JavadocParagraphCheck.isEmptyLine(DetailNode newLine)	Determines whether or not the line is empty line.
private static boolean	NonEmptyAtclauseDescriptionCheck.isEmptyTag(DetailNode tagNode)	Tests if block tag is empty.
private static boolean	JavadocParagraphCheck.isFirstParagraph(DetailNode paragraphTag)	Determines whether or not the line with paragraph tag is first line in javadoc.
private static boolean	JavadocParagraphCheck.isImmediatelyFollowedByNewLine(DetailNode tag)	Tests whether the paragraph tag is immediately followed by the new line.
private static boolean	JavadocParagraphCheck.isImmediatelyFollowedByText(DetailNode tag)	Tests whether the paragraph tag is immediately followed by the text.
private static boolean	JavadocTagContinuationIndentationCheck.isInlineDescription(DetailNode description)	Checks, if description node is a description of in-line tag.
private static boolean	SummaryJavadocCheck.isInlineReturnTag(DetailNode javadocInlineTag)	Checks if the first tag inside ast is {@return} tag.
private static boolean	SummaryJavadocCheck.isInlineTagPresent(DetailNode ast)	Checks if the inline tag node is present.
private static boolean	SummaryJavadocCheck.isInlineTagWithName(DetailNode javadocInlineTag, String name)	Checks if the first tag inside ast is a tag with the given name.
private static boolean	JavadocMissingLeadingAsteriskCheck.isLastLine(DetailNode detailNode)	Checks whether this node is the end of a Javadoc comment, optionally preceded by blank text.
private static boolean	JavadocMissingLeadingAsteriskCheck.isLeadingAsterisk(DetailNode detailNode)	Checks whether the given node is a leading asterisk.
private static boolean	JavadocParagraphCheck.isNestedParagraph(DetailNode tag)	Determines whether the paragraph tag is nested.
private static boolean	RequireEmptyLineBeforeBlockTagGroupCheck.isOnlyTagInWholeJavadoc(DetailNode tagNode)	Returns true when there are is only whitespace and asterisks before the provided tagNode.
private static boolean	SummaryJavadocCheck.isSummaryTag(DetailNode javadocInlineTag)	Checks if the javadoc inline tag is {@summary} tag.
private boolean	SingleLineJavadocCheck.isTagIgnored(DetailNode javadocTagSection)	Checks if list of ignored tags contains javadocTagSection's javadoc tag.
static boolean	SummaryJavadocCheck.isTextPresentInsideHtmlTag(DetailNode node)	Whether some text is present inside the HTML element or tag.
private boolean	JavadocTagContinuationIndentationCheck.isViolation(DetailNode textNode)	Checks if a text node meets the criteria for a violation.
void	AbstractJavadocCheck.leaveJavadocToken(DetailNode ast)	Called after all the child nodes have been process.
private void	AbstractJavadocCheck.processTree(DetailNode root)	Processes JavadocAST tree notifying Check.
void	JavadocNodeImpl.setChildren(DetailNode... children)	Sets array of child nodes.
void	JavadocNodeImpl.setParent(DetailNode parent)	Sets parent node.
private boolean	AbstractJavadocCheck.shouldBeProcessed(DetailNode curNode)	Checks whether the current node should be processed by the check.
private static boolean	SummaryJavadocCheck.startsWithInheritDoc(DetailNode root)	Checks if the node starts with an {@inheritDoc}.
private static Stream<String>	SummaryJavadocCheck.streamTextParts(DetailNode node)	Streams through all the text under the given node.
private void	SummaryJavadocCheck.validateInlineReturnTag(DetailNode inlineReturnTag)	Checks the inline return for forbidden fragments.
private void	SummaryJavadocCheck.validateSummaryTag(DetailNode inlineSummaryTag)	Checks the inline summary (if present) for period at end and forbidden fragments.
private void	SummaryJavadocCheck.validateUntaggedSummary(DetailNode ast)	Checks the javadoc text for period at end and forbidden fragments.
abstract void	AbstractJavadocCheck.visitJavadocToken(DetailNode ast)	Called to process a Javadoc token.
void	AtclauseOrderCheck.visitJavadocToken(DetailNode ast)
void	JavadocBlockTagLocationCheck.visitJavadocToken(DetailNode ast)
void	JavadocLeadingAsteriskAlignCheck.visitJavadocToken(DetailNode ast)
void	JavadocMissingLeadingAsteriskCheck.visitJavadocToken(DetailNode detailNode)
void	JavadocMissingWhitespaceAfterAsteriskCheck.visitJavadocToken(DetailNode detailNode)
void	JavadocParagraphCheck.visitJavadocToken(DetailNode ast)
void	JavadocTagContinuationIndentationCheck.visitJavadocToken(DetailNode ast)
void	NonEmptyAtclauseDescriptionCheck.visitJavadocToken(DetailNode ast)
void	RequireEmptyLineBeforeBlockTagGroupCheck.visitJavadocToken(DetailNode tagNode)	Logs when there is no empty line before the tag.
void	SingleLineJavadocCheck.visitJavadocToken(DetailNode ast)
void	SummaryJavadocCheck.visitJavadocToken(DetailNode ast)
private void	AbstractJavadocCheck.walk(DetailNode root)	Processes a node calling Check at interested nodes.

Uses of DetailNode in com.puppycrawl.tools.checkstyle.gui

Fields in com.puppycrawl.tools.checkstyle.gui with type parameters of type DetailNode

Modifier and Type	Field	Description
private final Map<DetailAST,DetailNode>	ParseTreeTablePresentation.blockCommentToJavadocTree	Cache to store already parsed Javadoc comments.

Methods in com.puppycrawl.tools.checkstyle.gui that return DetailNode

Modifier and Type	Method	Description
private DetailNode	ParseTreeTablePresentation.getJavadocTree(DetailAST blockComment)	Gets Javadoc (DetailNode) tree of specified block comments.
private static DetailNode	ParseTreeTablePresentation.parseJavadocTree(DetailAST blockComment)	Parses Javadoc (DetailNode) tree of specified block comments.

Methods in com.puppycrawl.tools.checkstyle.gui with parameters of type DetailNode

Modifier and Type	Method	Description
private int	CodeSelectorPresentation.findLastPosition(DetailNode detailNode)	Finds the last position of node without children.
private void	CodeSelectorPresentation.findSelectionPositions(DetailNode detailNode)	Find start and end selection positions from DetailNode line and Column.
private static Object	ParseTreeTablePresentation.getValueAtDetailNode(DetailNode node, int column)	Gets a value for DetailNode object.

Constructors in com.puppycrawl.tools.checkstyle.gui with parameters of type DetailNode

Modifier	Constructor	Description
	CodeSelectorPresentation(DetailNode node, List<Integer> lines2position)	Constructor.

Uses of DetailNode in com.puppycrawl.tools.checkstyle.meta

Fields in com.puppycrawl.tools.checkstyle.meta declared as DetailNode

Modifier and Type	Field	Description
private DetailNode	JavadocMetadataScraper.rootNode	DetailNode pointing to the root node of the class level javadoc of the class.

Methods in com.puppycrawl.tools.checkstyle.meta that return types with arguments of type DetailNode

Modifier and Type	Method	Description
private static Optional<DetailNode>	JavadocMetadataScraper.getFirstChildOfMatchingText(DetailNode node, Pattern pattern)	Get first child of parent node matching the provided pattern.
private static Optional<DetailNode>	JavadocMetadataScraper.getFirstChildOfType(DetailNode node, int tokenType, int offset)	Returns the first child node which matches the provided TokenType and has the children index after the offset value.

Methods in com.puppycrawl.tools.checkstyle.meta with parameters of type DetailNode

Modifier and Type	Method	Description
private static String	JavadocMetadataScraper.adjustCodeInlineTagChildToHtml(DetailNode codeChild)	Adjusts child of @code Javadoc inline tag to html format.
void	JavadocMetadataScraper.beginJavadocTree(DetailNode rootAst)
static String	JavadocMetadataScraper.constructSubTreeText(DetailNode node, int childLeftLimit, int childRightLimit)	Performs a DFS of the subtree with a node as the root and constructs the text of that tree, ignoring JavadocToken texts.
private static ModulePropertyDetails	JavadocMetadataScraper.createProperties(DetailNode nodeLi)	Create the modulePropertyDetails content.
void	JavadocMetadataScraper.finishJavadocTree(DetailNode rootAst)
private static Optional<DetailNode>	JavadocMetadataScraper.getFirstChildOfMatchingText(DetailNode node, Pattern pattern)	Get first child of parent node matching the provided pattern.
private static Optional<DetailNode>	JavadocMetadataScraper.getFirstChildOfType(DetailNode node, int tokenType, int offset)	Returns the first child node which matches the provided TokenType and has the children index after the offset value.
static int	JavadocMetadataScraper.getParentIndexOf(DetailNode node)	Traverse parents until we reach the root node (@code{JavadocTokenTypes.JAVADOC}) child and return its index.
private static String	JavadocMetadataScraper.getParentText(DetailNode nodeParagraph)	Get module parent text from paragraph javadoc node.
private static String	JavadocMetadataScraper.getPropertyDefaultText(DetailNode nodeLi, DetailNode defaultValueNode)	Create property default text, which is either normal property value or list of tokens.
private static String	JavadocMetadataScraper.getTagTextFromProperty(DetailNode nodeLi, DetailNode propertyMeta)	Get tag text from property data.
private static String	JavadocMetadataScraper.getText(DetailNode parentNode)	Get joined text from all text children nodes.
private static String	JavadocMetadataScraper.getTextFromTag(DetailNode nodeTag)	Get text from JavadocTokenTypes.JAVADOC_INLINE_TAG.
private static String	JavadocMetadataScraper.getViolationMessages(DetailNode nodeLi)	Get the violation message text for a specific key from the list item.
static boolean	JavadocMetadataScraper.isChildNodeTextMatches(DetailNode ast, Pattern pattern)	Checks whether the first child JavadocTokenType.TEXT node matches given pattern.
private static boolean	JavadocMetadataScraper.isContentToWrite(DetailNode detailNode)	Checks whether selected Javadoc node is considered as something to write.
private static boolean	JavadocMetadataScraper.isExamplesText(DetailNode ast)	Checks whether the paragraph node corresponds to the example section.
static boolean	JavadocMetadataScraper.isParentText(DetailNode nodeParagraph)	Checks whether the JavadocTokenType.PARAGRAPH node is referring to the parent javadoc segment.
private static boolean	JavadocMetadataScraper.isPropertyList(DetailNode nodeLi)	Checks whether the list item node is part of a property list.
private static boolean	JavadocMetadataScraper.isViolationMessagesText(DetailNode nodeParagraph)	Checks whether the JavadocTokenType.PARAGRAPH node is referring to the violation message keys javadoc segment.
private void	JavadocMetadataScraper.scrapeContent(DetailNode ast)	Method containing the core logic of scraping.
void	JavadocMetadataScraper.visitJavadocToken(DetailNode ast)

Uses of DetailNode in com.puppycrawl.tools.checkstyle.site

Fields in com.puppycrawl.tools.checkstyle.site with type parameters of type DetailNode

Modifier and Type	Field	Description
private static final Map<String,DetailNode>	ClassAndPropertiesSettersJavadocScraper.JAVADOC_FOR_MODULE_OR_PROPERTY	Map of scraped javadocs - name of property, javadoc detail node.
private static final Map<String,DetailNode>	SiteUtil.SUPER_CLASS_PROPERTIES_JAVADOCS	Map of all superclasses properties and their javadocs.

Methods in com.puppycrawl.tools.checkstyle.site that return DetailNode

Modifier and Type	Method	Description
private static DetailNode	SiteUtil.getSinceJavadocTag(DetailNode javadoc)	Find the since Javadoc tag node in the given Javadoc.

Methods in com.puppycrawl.tools.checkstyle.site that return types with arguments of type DetailNode

Modifier and Type	Method	Description
private static List<DetailNode>	SiteUtil.DescriptionExtractor.getDescriptionNodes(DetailNode javadoc)	Extracts description nodes from javadoc.
static Map<String,DetailNode>	ClassAndPropertiesSettersJavadocScraper.getJavadocsForModuleOrProperty()	Get the module or property javadocs map.
static Optional<DetailNode>	ModuleJavadocParsingUtil.getLiTagNode(DetailNode htmlElement)	Gets the node of Li HTML tag.
static Map<String,DetailNode>	SiteUtil.getPropertiesJavadocs(Set<String> properties, String moduleName, Path modulePath)	Get the javadocs of the properties of the module.
static Optional<DetailNode>	SiteUtil.getPropertyJavadocNodeInModule(String propertyName, DetailNode moduleJavadoc)	Gets the javadoc node part of the property from the javadoc of the module.

Methods in com.puppycrawl.tools.checkstyle.site with parameters of type DetailNode

Modifier and Type	Method	Description
private static int	DescriptionMacro.getDescriptionEndIndex(DetailNode moduleJavadoc, Set<String> propertyNamesSet)	Gets the end index of the description.
private static String	SiteUtil.DescriptionExtractor.getDescriptionFromJavadoc(DetailNode javadoc, String moduleName)	Extracts the description from the javadoc detail node.
private static List<DetailNode>	SiteUtil.DescriptionExtractor.getDescriptionNodes(DetailNode javadoc)	Extracts description nodes from javadoc.
static Optional<DetailNode>	ModuleJavadocParsingUtil.getLiTagNode(DetailNode htmlElement)	Gets the node of Li HTML tag.
private static int	NotesMacro.getNotesEndIndex(DetailNode moduleJavadoc, Set<String> propertyNamesSet)	Gets the end index of the Notes.
static int	ModuleJavadocParsingUtil.getNotesSectionStartIndex(DetailNode moduleJavadoc)	Gets the start index of the Notes section.
static int	ModuleJavadocParsingUtil.getParentSectionStartIndex(DetailNode moduleJavadoc)	Gets the starting index of the "Parent is" paragraph in module's javadoc.
static String	SiteUtil.getPropertyDescription(String propertyName, DetailNode javadoc, String moduleName)	Get the description of the property.
static Optional<DetailNode>	SiteUtil.getPropertyJavadocNodeInModule(String propertyName, DetailNode moduleJavadoc)	Gets the javadoc node part of the property from the javadoc of the module.
static int	ModuleJavadocParsingUtil.getPropertySectionStartIndex(DetailNode moduleJavadoc, Set<String> propertyNames)	Gets the start index of property section in module's javadoc.
private static DetailNode	SiteUtil.getSinceJavadocTag(DetailNode javadoc)	Find the since Javadoc tag node in the given Javadoc.
static String	SiteUtil.getSinceVersion(String moduleName, DetailNode moduleJavadoc, String propertyName, DetailNode propertyJavadoc)	Get the since version of the property.
private static String	SiteUtil.getSinceVersionFromJavadoc(DetailNode javadoc)	Extract the since version from the Javadoc.
private static Optional<String>	SiteUtil.getSpecifiedPropertyVersion(String propertyName, DetailNode moduleJavadoc)	Gets the specifically indicated version of module's property from the javadoc of module.
private static boolean	SiteUtil.DescriptionExtractor.isEndOfDescription(DetailNode child)	Determines if the given child index is the end of the description.
private static boolean	ModuleJavadocParsingUtil.isStartOfNotesSection(DetailNode htmlElement)	Determines whether the given HTML node marks the start of the "Notes" section.
void	ClassAndPropertiesSettersJavadocScraper.visitJavadocToken(DetailNode ast)
private static void	PropertiesMacro.writePropertyDescriptionCell(org.apache.maven.doxia.sink.Sink sink, String propertyName, DetailNode propertyJavadoc)	Writes a table cell with the property description.
private static void	PropertiesMacro.writePropertyRow(org.apache.maven.doxia.sink.Sink sink, String propertyName, DetailNode propertyJavadoc, Object instance, DetailNode moduleJavadoc)	Writes a table row with 5 columns for the given property - name, description, type, default value, since.
private static void	PropertiesMacro.writePropertySinceVersionCell(org.apache.maven.doxia.sink.Sink sink, String propertyName, DetailNode moduleJavadoc, DetailNode propertyJavadoc)	Writes a table cell with the property since version.

Method parameters in com.puppycrawl.tools.checkstyle.site with type arguments of type DetailNode

Modifier and Type	Method	Description
private static void	SiteUtil.assertAllPropertySetterJavadocsAreFound(Set<String> properties, String moduleName, Map<String,DetailNode> javadocs)	Assert that each property has a corresponding setter javadoc that is not null.

Uses of DetailNode in com.puppycrawl.tools.checkstyle.utils

Methods in com.puppycrawl.tools.checkstyle.utils that return DetailNode

Modifier and Type	Method	Description
static DetailNode	JavadocUtil.findFirstToken(DetailNode detailNode, int type)	Returns the first child token that has a specified type.
static DetailNode	JavadocUtil.getFirstChild(DetailNode node)	Gets first child node of specified node.
static DetailNode	JavadocUtil.getNextSibling(DetailNode node)	Gets next sibling of specified node.
static DetailNode	JavadocUtil.getNextSibling(DetailNode node, int tokenType)	Gets next sibling of specified node with the specified type.
static DetailNode	JavadocUtil.getPreviousSibling(DetailNode node)	Gets previous sibling of specified node.

Methods in com.puppycrawl.tools.checkstyle.utils with parameters of type DetailNode

Modifier and Type	Method	Description
static DetailNode	JavadocUtil.findFirstToken(DetailNode detailNode, int type)	Returns the first child token that has a specified type.
static DetailNode	JavadocUtil.getFirstChild(DetailNode node)	Gets first child node of specified node.
static DetailNode	JavadocUtil.getNextSibling(DetailNode node)	Gets next sibling of specified node.
static DetailNode	JavadocUtil.getNextSibling(DetailNode node, int tokenType)	Gets next sibling of specified node with the specified type.
static DetailNode	JavadocUtil.getPreviousSibling(DetailNode node)	Gets previous sibling of specified node.
static String	JavadocUtil.getTagName(DetailNode javadocTagSection)	Gets tag name from javadocTagSection.