Coverage Report - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTags
 
Classes in this File Line Coverage Branch Coverage Complexity
JavadocTags
100%
8/8
N/A
1
 
 1  
 ////////////////////////////////////////////////////////////////////////////////
 2  
 // checkstyle: Checks Java source code for adherence to a set of rules.
 3  
 // Copyright (C) 2001-2017 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.ArrayList;
 23  
 import java.util.Collections;
 24  
 import java.util.List;
 25  
 
 26  
 /**
 27  
  * Value object for combining the list of valid validTags with information
 28  
  * about invalid validTags encountered in a certain Javadoc comment.
 29  
  * @author Oliver Burn
 30  
  */
 31  
 public final class JavadocTags {
 32  
     /** Valid validTags. */
 33  
     private final List<JavadocTag> validTags;
 34  
     /** Invalid validTags. */
 35  
     private final List<InvalidJavadocTag> invalidTags;
 36  
 
 37  
     /**
 38  
      * Creates an instance.
 39  
      * @param tags the list of valid tags
 40  
      * @param invalidTags the list of invalid tags
 41  
      */
 42  120
     public JavadocTags(List<JavadocTag> tags, List<InvalidJavadocTag> invalidTags) {
 43  120
         final List<JavadocTag> validTagsCopy = new ArrayList<>(tags);
 44  120
         validTags = Collections.unmodifiableList(validTagsCopy);
 45  120
         final List<InvalidJavadocTag> invalidTagsCopy = new ArrayList<>(invalidTags);
 46  120
         this.invalidTags = Collections.unmodifiableList(invalidTagsCopy);
 47  120
     }
 48  
 
 49  
     /**
 50  
      *  Getter for validTags field.
 51  
      *  @return validTags field
 52  
      */
 53  
     public List<JavadocTag> getValidTags() {
 54  120
         return Collections.unmodifiableList(validTags);
 55  
     }
 56  
 
 57  
     /**
 58  
      *  Getter for invalidTags field.
 59  
      *  @return invalidTags field
 60  
      */
 61  
     public List<InvalidJavadocTag> getInvalidTags() {
 62  75
         return Collections.unmodifiableList(invalidTags);
 63  
     }
 64  
 }