001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2023 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 */
025public final class InvalidJavadocTag {
026
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     *
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     *
050     *  @return line field
051     */
052    public int getLine() {
053        return line;
054    }
055
056    /**
057     *  Getter for col field.
058     *
059     *  @return col field
060     */
061    public int getCol() {
062        return col;
063    }
064
065    /**
066     *  Getter for name field.
067     *
068     *  @return name field
069     */
070    public String getName() {
071        return name;
072    }
073
074}