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.naming;
021
022import com.puppycrawl.tools.checkstyle.api.DetailAST;
023import com.puppycrawl.tools.checkstyle.api.TokenTypes;
024
025/**
026 * <p>
027 * Abstract class for checking if a class/method type parameter's name
028 * conforms to a format specified by the format property.
029 * </p>
030 *
031 * <p>This class extends {@link AbstractNameCheck}</p>
032 * @deprecated Checkstyle will not support abstract checks anymore. Use
033 *             {@link AbstractNameCheck} instead.
034 * @noinspection AbstractClassNeverImplemented
035 */
036@Deprecated
037public abstract class AbstractTypeParameterNameCheck
038    extends AbstractNameCheck {
039
040    /**
041     * Creates a new {@code AbstractTypeParameterNameCheck} instance.
042     * @param format format to check with
043     */
044    protected AbstractTypeParameterNameCheck(String format) {
045        super(format);
046    }
047
048    /**
049     * This method must be overridden to specify the
050     * location of the type parameter to check.
051     *
052     * @return {@code TokenTypes.CLASS_DEF }
053     *     or {@code TokenTypes.METHOD_DEF }
054     */
055    protected abstract int getLocation();
056
057    @Override
058    public final int[] getDefaultTokens() {
059        return new int[] {
060            TokenTypes.TYPE_PARAMETER,
061        };
062    }
063
064    @Override
065    public final int[] getAcceptableTokens() {
066        return new int[] {
067            TokenTypes.TYPE_PARAMETER,
068        };
069    }
070
071    @Override
072    protected final boolean mustCheckName(DetailAST ast) {
073        final DetailAST location =
074            ast.getParent().getParent();
075        return location.getType() == getLocation();
076    }
077
078}