View Javadoc
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  /**
23   * Value object for storing data about an invalid Javadoc validTags.
24   * @author Oliver Burn
25   */
26  public final class InvalidJavadocTag {
27      /** The line in which the invalid tag occurs. */
28      private final int line;
29      /** The column in which the invalid tag occurs. */
30      private final int col;
31      /** The name of the invalid tag. */
32      private final String name;
33  
34      /**
35       * Creates an instance.
36       * @param line the line of the tag
37       * @param col the column of the tag
38       * @param name the name of the invalid tag
39       */
40      public InvalidJavadocTag(int line, int col, String name) {
41          this.line = line;
42          this.col = col;
43          this.name = name;
44      }
45  
46      /**
47       *  Getter for line field.
48       *  @return line field
49       */
50      public int getLine() {
51          return line;
52      }
53  
54      /**
55       *  Getter for col field.
56       *  @return col field
57       */
58      public int getCol() {
59          return col;
60      }
61  
62      /**
63       *  Getter for name field.
64       *  @return name field
65       */
66      public String getName() {
67          return name;
68      }
69  }