Package com.puppycrawl.tools.checkstyle.checks.javadoc.utils

Class BlockTagUtil

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.javadoc.utils.BlockTagUtil

public final class BlockTagUtil
extends Object

Tools for parsing block tags from a Javadoc comment.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Pattern	BLOCK_TAG_PATTERN	Block tag pattern.
private static final Pattern	BLOCK_TAG_PATTERN_FIRST_LINE	Block tag pattern for a first line.
private static final String	JAVADOC_CLOSING_TAG	Closing tag.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BlockTagUtil()	Prevent instantiation.

Method Summary

Modifier and Type	Method	Description
static List<TagInfo>	extractBlockTags(String... lines)	Extract the block tags from a Javadoc comment.

Methods inherited from class java.lang.Object

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

Field Details

BLOCK_TAG_PATTERN_FIRST_LINE

private static final Pattern BLOCK_TAG_PATTERN_FIRST_LINE

Block tag pattern for a first line.

BLOCK_TAG_PATTERN

private static final Pattern BLOCK_TAG_PATTERN

Block tag pattern.

JAVADOC_CLOSING_TAG

private static final String JAVADOC_CLOSING_TAG

Closing tag.

See Also:

• Constant Field Values

Constructor Details

BlockTagUtil

private BlockTagUtil()

Prevent instantiation.

Method Details

extractBlockTags

public static List<TagInfo> extractBlockTags(String... lines)

Extract the block tags from a Javadoc comment.

Parameters:

lines - The text of the comment, as separate lines.

Returns:

The tags extracted from the block.