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

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 final List<InvalidJavadocTag>	invalidTags	Invalid validTags.
private final List<JavadocTag>	validTags	Valid validTags.

Constructor Summary

Constructors

Constructor	Description
JavadocTags(Collection<JavadocTag> tags, Collection<InvalidJavadocTag> invalidTags)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
List<InvalidJavadocTag>	getInvalidTags()	Getter for invalidTags field.
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 Details

validTags

private final List<JavadocTag> validTags

Valid validTags.

invalidTags

private final List<InvalidJavadocTag> invalidTags

Invalid validTags.

Constructor Details

JavadocTags

public JavadocTags(Collection<JavadocTag> tags,
 Collection<InvalidJavadocTag> invalidTags)

Creates an instance.

Parameters:

tags - valid tags

invalidTags - invalid tags

Method Details

getValidTags

public List<JavadocTag> getValidTags()

Getter for validTags field.

Returns:

validTags field

getInvalidTags

public List<InvalidJavadocTag> getInvalidTags()

Getter for invalidTags field.

Returns:

invalidTags field