1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.checks.javadoc;
21
22 import java.util.Collection;
23 import java.util.List;
24
25 /**
26 * Value object for combining the list of valid validTags with information
27 * about invalid validTags encountered in a certain Javadoc comment.
28 */
29 public final class JavadocTags {
30
31 /** Valid validTags. */
32 private final List<JavadocTag> validTags;
33 /** Invalid validTags. */
34 private final List<InvalidJavadocTag> invalidTags;
35
36 /**
37 * Creates an instance.
38 *
39 * @param tags valid tags
40 * @param invalidTags invalid tags
41 */
42 public JavadocTags(Collection<JavadocTag> tags, Collection<InvalidJavadocTag> invalidTags) {
43 validTags = List.copyOf(tags);
44 this.invalidTags = List.copyOf(invalidTags);
45 }
46
47 /**
48 * Getter for validTags field.
49 *
50 * @return validTags field
51 */
52 public List<JavadocTag> getValidTags() {
53 return validTags;
54 }
55
56 /**
57 * Getter for invalidTags field.
58 *
59 * @return invalidTags field
60 */
61 public List<InvalidJavadocTag> getInvalidTags() {
62 return invalidTags;
63 }
64
65 }