com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocTags

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTags

public final class JavadocTags
extends java.lang.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 and Description
private java.util.List<InvalidJavadocTag>	invalidTags Invalid validTags.
private java.util.List<JavadocTag>	validTags Valid validTags.

Constructor Summary

Constructors

Constructor and Description
JavadocTags(java.util.List<JavadocTag> tags, java.util.List<InvalidJavadocTag> invalidTags) Creates an instance.

Method Summary

Modifier and Type	Method and Description
java.util.List<InvalidJavadocTag>	getInvalidTags() Getter for invalidTags field.
java.util.List<JavadocTag>	getValidTags() Getter for validTags field.

Methods inherited from class java.lang.Object

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

Field Detail

validTags

private final java.util.List<JavadocTag> validTags

Valid validTags.

invalidTags

private final java.util.List<InvalidJavadocTag> invalidTags

Invalid validTags.

Constructor Detail

JavadocTags

public JavadocTags(java.util.List<JavadocTag> tags,
                   java.util.List<InvalidJavadocTag> invalidTags)

Creates an instance.

Parameters:

tags - the list of valid tags

invalidTags - the list of invalid tags

Method Detail

getValidTags

public java.util.List<JavadocTag> getValidTags()

Getter for validTags field.

Returns:

validTags field

getInvalidTags

public java.util.List<InvalidJavadocTag> getInvalidTags()

Getter for invalidTags field.

Returns:

invalidTags field