001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2022 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks.javadoc;
021
022import java.util.ArrayList;
023import java.util.Collections;
024import java.util.List;
025
026/**
027 * Value object for combining the list of valid validTags with information
028 * about invalid validTags encountered in a certain Javadoc comment.
029 */
030public final class JavadocTags {
031
032    /** Valid validTags. */
033    private final List<JavadocTag> validTags;
034    /** Invalid validTags. */
035    private final List<InvalidJavadocTag> invalidTags;
036
037    /**
038     * Creates an instance.
039     *
040     * @param tags the list of valid tags
041     * @param invalidTags the list of invalid tags
042     */
043    public JavadocTags(List<JavadocTag> tags, List<InvalidJavadocTag> invalidTags) {
044        final List<JavadocTag> validTagsCopy = new ArrayList<>(tags);
045        validTags = Collections.unmodifiableList(validTagsCopy);
046        final List<InvalidJavadocTag> invalidTagsCopy = new ArrayList<>(invalidTags);
047        this.invalidTags = Collections.unmodifiableList(invalidTagsCopy);
048    }
049
050    /**
051     *  Getter for validTags field.
052     *
053     *  @return validTags field
054     */
055    public List<JavadocTag> getValidTags() {
056        return Collections.unmodifiableList(validTags);
057    }
058
059    /**
060     *  Getter for invalidTags field.
061     *
062     *  @return invalidTags field
063     */
064    public List<InvalidJavadocTag> getInvalidTags() {
065        return Collections.unmodifiableList(invalidTags);
066    }
067
068}