View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2018 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  
28      /** The line in which the invalid tag occurs. */
29      private final int line;
30      /** The column in which the invalid tag occurs. */
31      private final int col;
32      /** The name of the invalid tag. */
33      private final String name;
34  
35      /**
36       * Creates an instance.
37       * @param line the line of the tag
38       * @param col the column of the tag
39       * @param name the name of the invalid tag
40       */
41      public InvalidJavadocTag(int line, int col, String name) {
42          this.line = line;
43          this.col = col;
44          this.name = name;
45      }
46  
47      /**
48       *  Getter for line field.
49       *  @return line field
50       */
51      public int getLine() {
52          return line;
53      }
54  
55      /**
56       *  Getter for col field.
57       *  @return col field
58       */
59      public int getCol() {
60          return col;
61      }
62  
63      /**
64       *  Getter for name field.
65       *  @return name field
66       */
67      public String getName() {
68          return name;
69      }
70  
71  }