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 interface type parameter 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]$</strong>.
029 * </p>
030 * <p>
031 * An example of how to configure the check is:
032 * </p>
033 * <pre>
034 * &lt;module name="InterfaceTypeParameterName"/&gt;
035 * </pre>
036 * <p>
037 * An example of how to configure the check for names that are only a single
038 * letter is
039 * </p>
040 * <pre>
041 * &lt;module name="InterfaceTypeParameterName"&gt;
042 *    &lt;property name="format" value="^[a-zA-Z]$"/&gt;
043 * &lt;/module&gt;
044 * </pre>
045 *
046 * @author maxvetrenko
047 */
048public class InterfaceTypeParameterNameCheck
049    extends AbstractTypeParameterNameCheck
050{
051    /** Creates a new <code>InterfaceTypeParameterNameCheck</code> instance. */
052    public InterfaceTypeParameterNameCheck()
053    {
054        super("^[A-Z]$");
055    }
056
057    @Override
058    protected final int getLocation()
059    {
060        return TokenTypes.INTERFACE_DEF;
061    }
062}