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 * &lt;module name="TypeName"/&gt;
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 * &lt;module name="TypeName"&gt;
044 *    &lt;property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
045 * &lt;/module&gt;
046 * </pre>
047 */
048public class TypeNameCheck
049    extends AbstractAccessControlNameCheck {
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} instance.
058     */
059    public TypeNameCheck() {
060        super(DEFAULT_PATTERN);
061    }
062
063    @Override
064    public int[] getDefaultTokens() {
065        return getAcceptableTokens();
066    }
067
068    @Override
069    public int[] getAcceptableTokens() {
070        return new int[] {TokenTypes.CLASS_DEF,
071                          TokenTypes.INTERFACE_DEF,
072                          TokenTypes.ENUM_DEF,
073                          TokenTypes.ANNOTATION_DEF,
074        };
075    }
076
077    @Override
078    public int[] getRequiredTokens() {
079        return CommonUtils.EMPTY_INT_ARRAY;
080    }
081
082}