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.annotation Contains the Annotation 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 java.util.Map<java.lang.Integer,java.util.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 java.util.Map<java.lang.Integer,TextBlock>
FileContents. cppComments
Map of the C++ comments indexed on the first line of the comment.private java.util.Map<java.lang.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 com.google.common.collect.ImmutableMap<java.lang.Integer,java.util.List<TextBlock>>
FileContents. getBlockComments()
Returns a map of all block comments.com.google.common.collect.ImmutableMap<java.lang.Integer,java.util.List<TextBlock>>
FileContents. getCComments()
Deprecated.UseFileContents.getBlockComments()
instead.com.google.common.collect.ImmutableMap<java.lang.Integer,TextBlock>
FileContents. getCppComments()
Deprecated.UseFileContents.getSingleLineComments()
instead.com.google.common.collect.ImmutableMap<java.lang.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 java.util.Map<java.lang.Integer,java.util.List<TextBlock>>
AvoidEscapedUnicodeCharactersCheck. blockComments
C style comments.private java.util.Map<java.lang.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 boolean
TrailingCommentCheck. isLegalComment(TextBlock comment)
Checks if given comment is legal (single-line and matches to the pattern).private static boolean
AvoidEscapedUnicodeCharactersCheck. isTrailingBlockComment(TextBlock comment, java.lang.String line)
Whether the C style comment is trailing. -
Uses of TextBlock in com.puppycrawl.tools.checkstyle.checks.annotation
Methods in com.puppycrawl.tools.checkstyle.checks.annotation with parameters of type TextBlock Modifier and Type Method Description private boolean
MissingDeprecatedCheck. containsJavadocTag(TextBlock javadoc)
Checks to see if the text block contains a deprecated tag.private static boolean
MissingOverrideCheck. containsJavadocTag(TextBlock javadoc)
Checks to see if the text block contains a inheritDoc tag. -
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 java.util.Set<java.lang.String>
UnusedImportsCheck. collectReferencesFromJavadoc(TextBlock textBlock)
Process a javadocTextBlock
and return the set of classes referenced within.private static java.util.List<JavadocTag>
UnusedImportsCheck. getValidTags(TextBlock cmt, JavadocUtils.JavadocTagType tagType)
Returns the list of valid tags found in a javadocTextBlock
. -
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 java.util.List<JavadocTag>
JavadocTypeCheck. getJavadocTags(TextBlock textBlock)
Gets all standalone tags from a given javadoc.private static java.util.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(java.util.Collection<TextBlock> comments)
Appends the suppressions in a collection of comments to the full set of suppression tags.private void
SuppressWithNearbyCommentFilter. tagSuppressions(java.util.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
JavadocUtils. getJavadocTags(TextBlock textBlock, JavadocUtils.JavadocTagType tagType)
Gets validTags from a given piece of Javadoc.private static void
JavadocUtils. lookForInlineTags(TextBlock comment, int lineNumber, java.util.List<JavadocTag> validTags, java.util.List<InvalidJavadocTag> invalidTags)
Looks for inline tags in comment and adds them to the proper tags collection.
-