com.puppycrawl.tools.checkstyle.checks.naming

Enum AccessModifier

java.lang.Object

java.lang.Enum<AccessModifier>

com.puppycrawl.tools.checkstyle.checks.naming.AccessModifier

All Implemented Interfaces:

Serializable, Comparable<AccessModifier>

public enum AccessModifier
extends Enum<AccessModifier>

This enum represents access modifiers. Access modifiers names are taken from JLS: https://docs.oracle.com/javase/specs/jls/se8/html/jls-6.html#jls-6.6

Author:

Andrei Selkin

Enum Constant Summary

Enum Constants

Enum Constant and Description
PACKAGE Package access modifier.
PRIVATE Private access modifier.
PROTECTED Protected access modifier.
PUBLIC Public access modifier.

Method Summary

Modifier and Type	Method and Description
static AccessModifier	getInstance(String modifierName) Factory method which returns an AccessModifier instance that corresponds to the given access modifier name represented as a String.
String	getName()
String	toString()
static AccessModifier	valueOf(String name) Returns the enum constant of this type with the specified name.
static AccessModifier[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PUBLIC

public static final AccessModifier PUBLIC

Public access modifier.

PROTECTED

public static final AccessModifier PROTECTED

Protected access modifier.

PACKAGE

public static final AccessModifier PACKAGE

Package access modifier.

PRIVATE

public static final AccessModifier PRIVATE

Private access modifier.

Method Detail

values

public static AccessModifier[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AccessModifier c : AccessModifier.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AccessModifier valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<AccessModifier>

getName

public String getName()

getInstance

public static AccessModifier getInstance(String modifierName)

Factory method which returns an AccessModifier instance that corresponds to the given access modifier name represented as a String. The access modifier name can be formatted both as lower case or upper case string. For example, passing PACKAGE or package as a modifier name will return PACKAGE.

Parameters:

modifierName - access modifier name represented as a String.

Returns:

the AccessModifier associated with given access modifier name.