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

Class InlineTagUtil

java.lang.Object

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

public final class InlineTagUtil
extends Object

Tools for extracting inline tags from Javadoc comments.

Field Summary

Fields

Modifier and Type	Field	Description
private static final char	CARRIAGE_RETURN	Carriage return character.
private static final Pattern	INLINE_TAG_PATTERN	Inline tag pattern.
private static final Pattern	JAVADOC_PREFIX_PATTERN	Pattern to recognize leading "*" characters in Javadoc.
private static final char	LINE_FEED	Line feed character.
private static final Pattern	NEWLINE_PATTERN	Pattern matching a newline.
private static final Pattern	WHITESPACE_PATTERN	Pattern matching whitespace, used by collapseWhitespace(String).

Constructor Summary

Constructors

Modifier	Constructor	Description
private	InlineTagUtil()	Prevent instantiation.

Method Summary

Modifier and Type	Method	Description
private static String	collapseWhitespace(String str)	Collapse whitespaces.
private static String	convertLinesToString(String... lines)	Convert array of string to single String.
static List<TagInfo>	extractInlineTags(String... lines)	Extract inline Javadoc tags from the given comment.
private static LineColumn	getLineColumnOfIndex(String source, int index)	Get LineColumn from string till index.
private static String	removeLeadingJavaDoc(String source)	Remove leading JavaDoc.

Methods inherited from class java.lang.Object

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

Field Details

INLINE_TAG_PATTERN

private static final Pattern INLINE_TAG_PATTERN

Inline tag pattern.

JAVADOC_PREFIX_PATTERN

private static final Pattern JAVADOC_PREFIX_PATTERN

Pattern to recognize leading "*" characters in Javadoc.

WHITESPACE_PATTERN

private static final Pattern WHITESPACE_PATTERN

Pattern matching whitespace, used by collapseWhitespace(String).

NEWLINE_PATTERN

private static final Pattern NEWLINE_PATTERN

Pattern matching a newline.

LINE_FEED

private static final char LINE_FEED

Line feed character.

See Also:

• Constant Field Values

CARRIAGE_RETURN

private static final char CARRIAGE_RETURN

Carriage return character.

See Also:

• Constant Field Values

Constructor Details

InlineTagUtil

private InlineTagUtil()

Prevent instantiation.

Method Details

extractInlineTags

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

Extract inline Javadoc tags from the given comment.

Parameters:

lines - The Javadoc comment (as lines).

Returns:

The extracted inline Javadoc tags.

Throws:

IllegalArgumentException - when comment lines contain newlines

convertLinesToString

private static String convertLinesToString(String... lines)

Convert array of string to single String.

Parameters:

lines - A number of lines, in order.

Returns:

The lines, joined together with newlines, as a single string.

getLineColumnOfIndex

private static LineColumn getLineColumnOfIndex(String source,
 int index)

Get LineColumn from string till index.

Parameters:

source - Source string.

index - An index into the string.

Returns:

A position in the source representing what line and column that index appears on.

collapseWhitespace

private static String collapseWhitespace(String str)

Collapse whitespaces.

Parameters:

str - Source string.

Returns:

The given string with all whitespace collapsed.

removeLeadingJavaDoc

private static String removeLeadingJavaDoc(String source)

Remove leading JavaDoc.

Parameters:

source - A string to remove leading Javadoc from.

Returns:

The given string with leading Javadoc "*" characters from each line removed.