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 * Checks that interface type parameter names conform to a format specified 028 * by the format property. The format is a 029 * {@link java.util.regex.Pattern regular expression} and defaults to 030 * <strong>^[A-Z]$</strong>. 031 * </p> 032 * <p> 033 * An example of how to configure the check is: 034 * </p> 035 * <pre> 036 * <module name="InterfaceTypeParameterName"/> 037 * </pre> 038 * <p> 039 * An example of how to configure the check for names that are only a single 040 * letter is 041 * </p> 042 * <pre> 043 * <module name="InterfaceTypeParameterName"> 044 * <property name="format" value="^[a-zA-Z]$"/> 045 * </module> 046 * </pre> 047 * 048 * @author maxvetrenko 049 */ 050public class InterfaceTypeParameterNameCheck 051 extends AbstractNameCheck { 052 053 /** Creates a new {@code InterfaceTypeParameterNameCheck} instance. */ 054 public InterfaceTypeParameterNameCheck() { 055 super("^[A-Z]$"); 056 } 057 058 @Override 059 public int[] getDefaultTokens() { 060 return getRequiredTokens(); 061 } 062 063 @Override 064 public int[] getAcceptableTokens() { 065 return getRequiredTokens(); 066 } 067 068 @Override 069 public int[] getRequiredTokens() { 070 return new int[] { 071 TokenTypes.TYPE_PARAMETER, 072 }; 073 } 074 075 @Override 076 protected final boolean mustCheckName(DetailAST ast) { 077 final DetailAST location = 078 ast.getParent().getParent(); 079 return location.getType() == TokenTypes.INTERFACE_DEF; 080 } 081 082}