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