001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2014 Oliver Burn 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//////////////////////////////////////////////////////////////////////////////// 019package com.puppycrawl.tools.checkstyle.checks.naming; 020 021import com.puppycrawl.tools.checkstyle.api.TokenTypes; 022 023/** 024 * <p> 025 * Checks that type names conform to a format specified 026 * by the format property. The format is a 027 * {@link java.util.regex.Pattern regular expression} and defaults to 028 * <strong>^[A-Z][a-zA-Z0-9]*$</strong>. 029 * </p> 030 * <p> 031 * An example of how to configure the check is: 032 * </p> 033 * <pre> 034 * <module name="TypeName"/> 035 * </pre> 036 * <p> 037 * An example of how to configure the check for names that begin with 038 * a lower case letter, followed by letters, digits, and underscores is: 039 * </p> 040 * <pre> 041 * <module name="TypeName"> 042 * <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/> 043 * </module> 044 * </pre> 045 * @author Oliver Burn 046 */ 047public class TypeNameCheck 048 extends AbstractAccessControlNameCheck 049{ 050 051 /** 052 * default pattern for type name. 053 */ 054 public static final String DEFAULT_PATTERN = "^[A-Z][a-zA-Z0-9]*$"; 055 056 /** 057 * Creates a new <code>TypeNameCheck</code> instance. 058 */ 059 public TypeNameCheck() 060 { 061 super(DEFAULT_PATTERN); 062 } 063 064 /** {@inheritDoc} */ 065 @Override 066 public int[] getDefaultTokens() 067 { 068 return new int[] {TokenTypes.CLASS_DEF, 069 TokenTypes.INTERFACE_DEF, 070 TokenTypes.ENUM_DEF, 071 TokenTypes.ANNOTATION_DEF, 072 }; 073 } 074}