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.TokenTypes; 023import com.puppycrawl.tools.checkstyle.utils.CommonUtils; 024 025/** 026 * <p> 027 * Checks that type 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][a-zA-Z0-9]*$</strong>. 031 * </p> 032 * <p> 033 * An example of how to configure the check is: 034 * </p> 035 * <pre> 036 * <module name="TypeName"/> 037 * </pre> 038 * <p> 039 * An example of how to configure the check for names that begin with 040 * a lower case letter, followed by letters, digits, and underscores is: 041 * </p> 042 * <pre> 043 * <module name="TypeName"> 044 * <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/> 045 * </module> 046 * </pre> 047 * @author Oliver Burn 048 */ 049public class TypeNameCheck 050 extends AbstractAccessControlNameCheck { 051 052 /** 053 * Default pattern for type name. 054 */ 055 public static final String DEFAULT_PATTERN = "^[A-Z][a-zA-Z0-9]*$"; 056 057 /** 058 * Creates a new {@code TypeNameCheck} instance. 059 */ 060 public TypeNameCheck() { 061 super(DEFAULT_PATTERN); 062 } 063 064 @Override 065 public int[] getDefaultTokens() { 066 return getAcceptableTokens(); 067 } 068 069 @Override 070 public int[] getAcceptableTokens() { 071 return new int[] {TokenTypes.CLASS_DEF, 072 TokenTypes.INTERFACE_DEF, 073 TokenTypes.ENUM_DEF, 074 TokenTypes.ANNOTATION_DEF, 075 }; 076 } 077 078 @Override 079 public int[] getRequiredTokens() { 080 return CommonUtils.EMPTY_INT_ARRAY; 081 } 082 083}