001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 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
022/**
023 * Value object for storing data about an invalid Javadoc validTags.
024 * @author Oliver Burn
025 */
026public final class InvalidJavadocTag {
027    /** The line in which the invalid tag occurs. */
028    private final int line;
029    /** The column in which the invalid tag occurs. */
030    private final int col;
031    /** The name of the invalid tag. */
032    private final String name;
033
034    /**
035     * Creates an instance.
036     * @param line the line of the tag
037     * @param col the column of the tag
038     * @param name the name of the invalid tag
039     */
040    public InvalidJavadocTag(int line, int col, String name) {
041        this.line = line;
042        this.col = col;
043        this.name = name;
044    }
045
046    /**
047     *  Getter for line field.
048     *  @return line field
049     */
050    public int getLine() {
051        return line;
052    }
053
054    /**
055     *  Getter for col field.
056     *  @return col field
057     */
058    public int getCol() {
059        return col;
060    }
061
062    /**
063     *  Getter for name field.
064     *  @return name field
065     */
066    public String getName() {
067        return name;
068    }
069}