001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2015 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 *
033 * @author Travis Schneeberger
034 */
035public abstract class AbstractTypeParameterNameCheck
036    extends AbstractNameCheck {
037
038    /**
039     * Creates a new {@code AbstractTypeParameterNameCheck} instance.
040     * @param format format to check with
041     */
042    protected AbstractTypeParameterNameCheck(String format) {
043        super(format);
044    }
045
046    @Override
047    public final int[] getDefaultTokens() {
048        return new int[] {
049            TokenTypes.TYPE_PARAMETER,
050        };
051    }
052
053    @Override
054    public final int[] getAcceptableTokens() {
055        return new int[] {
056            TokenTypes.TYPE_PARAMETER,
057        };
058    }
059
060    @Override
061    protected final boolean mustCheckName(DetailAST ast) {
062        final DetailAST location =
063            ast.getParent().getParent();
064        return location.getType() == getLocation();
065    }
066
067    /**
068     * This method must be overridden to specify the
069     * location of the type parameter to check.
070     *
071     * @return {@code TokenTypes.CLASS_DEF }
072     *     or {@code TokenTypes.METHOD_DEF }
073     */
074    protected abstract int getLocation();
075}