| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| JavadocTags |
|
| 1.0;1 |
| 1 | //////////////////////////////////////////////////////////////////////////////// | |
| 2 | // checkstyle: Checks Java source code for adherence to a set of rules. | |
| 3 | // Copyright (C) 2001-2014 Oliver Burn | |
| 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 | package com.puppycrawl.tools.checkstyle.checks.javadoc; | |
| 20 | ||
| 21 | import java.util.List; | |
| 22 | ||
| 23 | /** | |
| 24 | * Value object for combining the list of valid validTags with information | |
| 25 | * about invalid validTags encountered in a certain Javadoc comment. | |
| 26 | * @author Oliver Burn | |
| 27 | */ | |
| 28 | public final class JavadocTags | |
| 29 | { | |
| 30 | /** Valid validTags. */ | |
| 31 | private final List<JavadocTag> mValidTags; | |
| 32 | /** Invalid validTags. */ | |
| 33 | private final List<InvalidJavadocTag> mInvalidTags; | |
| 34 | ||
| 35 | /** | |
| 36 | * Creates an instance. | |
| 37 | * @param aTags the list of valid tags | |
| 38 | * @param aInvalidTags the list of invalid tags | |
| 39 | */ | |
| 40 | public JavadocTags(List<JavadocTag> aTags, | |
| 41 | List<InvalidJavadocTag> aInvalidTags) | |
| 42 | 82 | { |
| 43 | 82 | mValidTags = aTags; |
| 44 | 82 | mInvalidTags = aInvalidTags; |
| 45 | 82 | } |
| 46 | ||
| 47 | public List<JavadocTag> getValidTags() | |
| 48 | { | |
| 49 | 82 | return mValidTags; |
| 50 | } | |
| 51 | ||
| 52 | public List<InvalidJavadocTag> getInvalidTags() | |
| 53 | { | |
| 54 | 63 | return mInvalidTags; |
| 55 | } | |
| 56 | } |