1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2020 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 java.util.Locale;
23
24 /**
25 * This enum represents access modifiers.
26 * Access modifiers names are taken from JLS:
27 * https://docs.oracle.com/javase/specs/jls/se8/html/jls-6.html#jls-6.6
28 *
29 */
30 public enum AccessModifierOption {
31
32 /** Public access modifier. */
33 PUBLIC,
34 /** Protected access modifier. */
35 PROTECTED,
36 /** Package access modifier. */
37 PACKAGE,
38 /** Private access modifier. */
39 PRIVATE;
40
41 @Override
42 public String toString() {
43 return getName();
44 }
45
46 private String getName() {
47 return name().toLowerCase(Locale.ENGLISH);
48 }
49
50 /**
51 * Factory method which returns an AccessModifier instance that corresponds to the
52 * given access modifier name represented as a {@link String}.
53 * The access modifier name can be formatted both as lower case or upper case string.
54 * For example, passing PACKAGE or package as a modifier name
55 * will return {@link AccessModifierOption#PACKAGE}.
56 *
57 * @param modifierName access modifier name represented as a {@link String}.
58 * @return the AccessModifier associated with given access modifier name.
59 */
60 public static AccessModifierOption getInstance(String modifierName) {
61 return valueOf(AccessModifierOption.class, modifierName.trim().toUpperCase(Locale.ENGLISH));
62 }
63
64 }