1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
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
20 package com.puppycrawl.tools.checkstyle.checks.naming;
21
22 import com.puppycrawl.tools.checkstyle.api.DetailAST;
23 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
24
25 /**
26 * <div>
27 * Checks that {@code catch} parameter names conform to a specified pattern.
28 * </div>
29 *
30 * <p>
31 * Default pattern has the following characteristic:
32 * </p>
33 * <ul>
34 * <li>allows names beginning with two lowercase letters followed by at least one uppercase or
35 * lowercase letter</li>
36 * <li>allows {@code e} abbreviation (suitable for exceptions end errors)</li>
37 * <li>allows {@code ex} abbreviation (suitable for exceptions)</li>
38 * <li>allows {@code t} abbreviation (suitable for throwables)</li>
39 * <li>allows {@code _} for unnamed catch parameters</li>
40 * <li>prohibits numbered abbreviations like {@code e1} or {@code t2}</li>
41 * <li>prohibits one letter prefixes like {@code pException}</li>
42 * <li>prohibits two letter abbreviations like {@code ie} or {@code ee}</li>
43 * <li>prohibits any other characters than letters</li>
44 * </ul>
45 * <ul>
46 * <li>
47 * Property {@code format} - Sets the pattern to match valid identifiers.
48 * Type is {@code java.util.regex.Pattern}.
49 * Default value is {@code "^(e|t|ex|[a-z][a-z][a-zA-Z]+|_)$"}.
50 * </li>
51 * </ul>
52 *
53 * <p>
54 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
55 * </p>
56 *
57 * <p>
58 * Violation Message Keys:
59 * </p>
60 * <ul>
61 * <li>
62 * {@code name.invalidPattern}
63 * </li>
64 * </ul>
65 *
66 * @since 6.14
67 */
68 public class CatchParameterNameCheck extends AbstractNameCheck {
69
70 /**
71 * Creates a new {@code CatchParameterNameCheck} instance.
72 */
73 public CatchParameterNameCheck() {
74 super("^(e|t|ex|[a-z][a-z][a-zA-Z]+|_)$");
75 }
76
77 @Override
78 public int[] getDefaultTokens() {
79 return getRequiredTokens();
80 }
81
82 @Override
83 public int[] getAcceptableTokens() {
84 return getRequiredTokens();
85 }
86
87 @Override
88 public int[] getRequiredTokens() {
89 return new int[] {TokenTypes.PARAMETER_DEF};
90 }
91
92 @Override
93 protected boolean mustCheckName(DetailAST ast) {
94 return ast.getParent().getType() == TokenTypes.LITERAL_CATCH;
95 }
96
97 }