001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2015 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.Collections; 023import java.util.List; 024 025import com.google.common.collect.ImmutableList; 026 027/** 028 * Value object for combining the list of valid validTags with information 029 * about invalid validTags encountered in a certain Javadoc comment. 030 * @author Oliver Burn 031 */ 032public final class JavadocTags { 033 /** Valid validTags. */ 034 private final List<JavadocTag> validTags; 035 /** Invalid validTags. */ 036 private final List<InvalidJavadocTag> invalidTags; 037 038 /** 039 * Creates an instance. 040 * @param tags the list of valid tags 041 * @param invalidTags the list of invalid tags 042 */ 043 public JavadocTags(List<JavadocTag> tags, 044 List<InvalidJavadocTag> invalidTags) { 045 validTags = ImmutableList.copyOf(tags); 046 this.invalidTags = ImmutableList.copyOf(invalidTags); 047 } 048 049 /** 050 * Getter for validTags field. 051 * @return validTags field 052 */ 053 public List<JavadocTag> getValidTags() { 054 return Collections.unmodifiableList(validTags); 055 } 056 057 /** 058 * Getter for invalidTags field. 059 * @return invalidTags field 060 */ 061 public List<InvalidJavadocTag> getInvalidTags() { 062 return Collections.unmodifiableList(invalidTags); 063 } 064}