Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ClassTypeParameterNameCheck |
|
| 1.0;1 |
1 | //////////////////////////////////////////////////////////////////////////////// | |
2 | // checkstyle: Checks Java source code for adherence to a set of rules. | |
3 | // Copyright (C) 2001-2014 Oliver Burn | |
4 | // | |
5 | // This library is free software; you can redistribute it and/or | |
6 | // modify it under the terms of the GNU Lesser General Public | |
7 | // License as published by the Free Software Foundation; either | |
8 | // version 2.1 of the License, or (at your option) any later version. | |
9 | // | |
10 | // This library is distributed in the hope that it will be useful, | |
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | // Lesser General Public License for more details. | |
14 | // | |
15 | // You should have received a copy of the GNU Lesser General Public | |
16 | // License along with this library; if not, write to the Free Software | |
17 | // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
18 | //////////////////////////////////////////////////////////////////////////////// | |
19 | package com.puppycrawl.tools.checkstyle.checks.naming; | |
20 | ||
21 | import com.puppycrawl.tools.checkstyle.api.TokenTypes; | |
22 | ||
23 | /** | |
24 | * <p> | |
25 | * Checks that class type parameter names conform to a format specified | |
26 | * by the format property. The format is a | |
27 | * {@link java.util.regex.Pattern regular expression} and defaults to | |
28 | * <strong>^[A-Z]$</strong>. | |
29 | * </p> | |
30 | * <p> | |
31 | * An example of how to configure the check is: | |
32 | * </p> | |
33 | * <pre> | |
34 | * <module name="ClassTypeParameterName"/> | |
35 | * </pre> | |
36 | * <p> | |
37 | * An example of how to configure the check for names that are only a single | |
38 | * letter is | |
39 | * </p> | |
40 | * <pre> | |
41 | * <module name="ClassTypeParameterName"> | |
42 | * <property name="format" value="^[a-zA-Z]$"/> | |
43 | * </module> | |
44 | * </pre> | |
45 | * | |
46 | * @author Travis Schneeberger | |
47 | * @version 1.0 | |
48 | */ | |
49 | public class ClassTypeParameterNameCheck | |
50 | extends AbstractTypeParameterNameCheck | |
51 | { | |
52 | /** Creates a new <code>ClassTypeParameterNameCheck</code> instance. */ | |
53 | public ClassTypeParameterNameCheck() | |
54 | { | |
55 | 2 | super("^[A-Z]$"); |
56 | 2 | } |
57 | ||
58 | @Override | |
59 | protected final int getLocation() | |
60 | { | |
61 | 2 | return TokenTypes.CLASS_DEF; |
62 | } | |
63 | } |