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

Packages that use TextBlock

Package	Description
com.puppycrawl.tools.checkstyle.api	Contains the core API to be used to implement checks.
com.puppycrawl.tools.checkstyle.checks	Contains the checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.imports	Contains the Imports 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.filters	Contains the filters that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.utils	Contains utils classes for checkstyle.

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

Classes in com.puppycrawl.tools.checkstyle.api that implement TextBlock

Modifier and Type	Class	Description
class	Comment	Representation of the comment block.

Fields in com.puppycrawl.tools.checkstyle.api with type parameters of type TextBlock

Modifier and Type	Field	Description
private final Map<Integer,List<TextBlock>>	FileContents.clangComments	Map of the C comments indexed on the first line of the comment to a list of comments on that line.
private final Map<Integer,TextBlock>	FileContents.cppComments	Map of the C++ comments indexed on the first line of the comment.
private final Map<Integer,TextBlock>	FileContents.javadocComments	Map of the Javadoc comments indexed on the last line of the comment.

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

Modifier and Type	Method	Description
TextBlock	FileContents.getJavadocBefore(int lineNoBefore)	Returns the Javadoc comment before the specified line.

Methods in com.puppycrawl.tools.checkstyle.api that return types with arguments of type TextBlock

Modifier and Type	Method	Description
Map<Integer,List<TextBlock>>	FileContents.getBlockComments()	Returns a map of all block comments.
Map<Integer,TextBlock>	FileContents.getSingleLineComments()	Returns a map of all the single-line comments.

Uses of TextBlock in com.puppycrawl.tools.checkstyle.checks

Fields in com.puppycrawl.tools.checkstyle.checks with type parameters of type TextBlock

Modifier and Type	Field	Description
private Map<Integer,List<TextBlock>>	AvoidEscapedUnicodeCharactersCheck.blockComments	C style comments.
private Map<Integer,TextBlock>	AvoidEscapedUnicodeCharactersCheck.singlelineComments	Cpp style comments.

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

Modifier and Type	Method	Description
private static boolean	AvoidEscapedUnicodeCharactersCheck.isTrailingBlockComment(TextBlock comment, int... codePoints)	Whether the C style comment is trailing.

Uses of TextBlock in com.puppycrawl.tools.checkstyle.checks.imports

Methods in com.puppycrawl.tools.checkstyle.checks.imports with parameters of type TextBlock

Modifier and Type	Method	Description
private static Set<String>	UnusedImportsCheck.collectReferencesFromJavadoc(TextBlock textBlock)	Process a javadoc TextBlock and return the set of classes referenced within.
private static List<JavadocTag>	UnusedImportsCheck.getValidTags(TextBlock cmt, JavadocUtil.JavadocTagType tagType)	Returns the list of valid tags found in a javadoc TextBlock.

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

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

Modifier and Type	Method	Description
private void	JavadocMethodCheck.checkComment(DetailAST ast, TextBlock comment)	Checks the Javadoc for a method.
private void	JavadocStyleCheck.checkComment(DetailAST ast, TextBlock comment)	Performs the various checks against the Javadoc comment.
private void	JavadocStyleCheck.checkFirstSentenceEnding(DetailAST ast, TextBlock comment)	Checks that the first sentence ends with proper punctuation.
private void	JavadocStyleCheck.checkHtmlTags(DetailAST ast, TextBlock comment)	Checks the comment for HTML tags that do not have a corresponding close tag or a close tag that has no previous open tag.
private void	JavadocStyleCheck.checkJavadocIsNotEmpty(TextBlock comment)	Checks that the Javadoc is not empty.
private List<JavadocTag>	JavadocTypeCheck.getJavadocTags(TextBlock textBlock)	Gets all standalone tags from a given javadoc.
private static List<JavadocTag>	JavadocMethodCheck.getMethodTags(TextBlock comment)	Returns the tags in a javadoc comment.

Uses of TextBlock in com.puppycrawl.tools.checkstyle.filters

Method parameters in com.puppycrawl.tools.checkstyle.filters with type arguments of type TextBlock

Modifier and Type	Method	Description
private void	SuppressionCommentFilter.tagSuppressions(Collection<TextBlock> comments)	Appends the suppressions in a collection of comments to the full set of suppression tags.
private void	SuppressWithNearbyCommentFilter.tagSuppressions(Collection<TextBlock> comments)	Appends the suppressions in a collection of comments to the full set of suppression tags.

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

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

Modifier and Type	Method	Description
static JavadocTags	JavadocUtil.getJavadocTags(TextBlock textBlock, JavadocUtil.JavadocTagType tagType)	Gets validTags from a given piece of Javadoc.