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