Class JavadocTags
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTags
-
public final class JavadocTags extends Object
Value object for combining the list of valid validTags with information about invalid validTags encountered in a certain Javadoc comment.
-
-
Field Summary
Fields Modifier and Type Field Description private List<InvalidJavadocTag>
invalidTags
Invalid validTags.private List<JavadocTag>
validTags
Valid validTags.
-
Constructor Summary
Constructors Constructor Description JavadocTags(Collection<JavadocTag> tags, Collection<InvalidJavadocTag> invalidTags)
Creates an instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<InvalidJavadocTag>
getInvalidTags()
Getter for invalidTags field.List<JavadocTag>
getValidTags()
Getter for validTags field.
-
-
-
Field Detail
-
validTags
private final List<JavadocTag> validTags
Valid validTags.
-
invalidTags
private final List<InvalidJavadocTag> invalidTags
Invalid validTags.
-
-
Constructor Detail
-
JavadocTags
public JavadocTags(Collection<JavadocTag> tags, Collection<InvalidJavadocTag> invalidTags)
Creates an instance.- Parameters:
tags
- valid tagsinvalidTags
- invalid tags
-
-
Method Detail
-
getValidTags
public List<JavadocTag> getValidTags()
Getter for validTags field.- Returns:
- validTags field
-
getInvalidTags
public List<InvalidJavadocTag> getInvalidTags()
Getter for invalidTags field.- Returns:
- invalidTags field
-
-