Package com.github.tadukoo.java

Enum Class Visibility

java.lang.Object

java.lang.Enum<Visibility>

com.github.tadukoo.java.Visibility

All Implemented Interfaces:

JavaTokens, Serializable, Comparable<Visibility>, Constable

public enum Visibility
extends Enum<Visibility>
implements JavaTokens

Visibility represents the visibility of a given Java class, method, etc.

Since:

Alpha v.0.2

Version:

Beta v.0.5

Author:

Logan Ferree (Tadukoo)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	Used when there's no specified visibility (e.g.
PRIVATE	Used for private visibility - only the current class can see it
PROTECTED	Used for protected visibility - only the current class and subclasses can see it
PUBLIC	Used for public visibility - anything can see it

Field Summary

Fields inherited from interface com.github.tadukoo.java.JavaTokens

ABSTRACT_MODIFIER, ANNOTATION_START_TOKEN, ASSIGNMENT_OPERATOR_TOKEN, BLOCK_CLOSE_TOKEN, BLOCK_OPEN_TOKEN, CLASS_TOKEN, EXTENDS_TOKEN, FINAL_MODIFIER, IMPLEMENTS_TOKEN, IMPORT_TOKEN, JAVADOC_AUTHOR_TOKEN, JAVADOC_LINE_TOKEN, JAVADOC_PARAM_TOKEN, JAVADOC_RETURN_TOKEN, JAVADOC_SINCE_TOKEN, JAVADOC_START_TOKEN, JAVADOC_VERSION_TOKEN, LIST_SEPARATOR_TOKEN, MODIFIERS, MULTI_LINE_COMMENT_CLOSE_TOKEN, MULTI_LINE_COMMENT_START_TOKEN, PACKAGE_TOKEN, PARAMETER_CLOSE_TOKEN, PARAMETER_OPEN_TOKEN, PRIVATE_MODIFIER, PROTECTED_MODIFIER, PUBLIC_MODIFIER, SEMICOLON, SINGLE_LINE_COMMENT_TOKEN, STATIC_MODIFIER, THROWS_TOKEN, VISIBILITY_MODIFIERS

Method Summary

Modifier and Type	Method	Description
static Visibility	fromToken(String token)	Grabs the Visibility that corresponds to the given token
String	getToken()
static Visibility	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Visibility[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PUBLIC

public static final Visibility PUBLIC

Used for public visibility - anything can see it

PROTECTED

public static final Visibility PROTECTED

Used for protected visibility - only the current class and subclasses can see it

PRIVATE

public static final Visibility PRIVATE

Used for private visibility - only the current class can see it

NONE

public static final Visibility NONE

Used when there's no specified visibility (e.g. interface methods, where public is implied)

Method Details

values

public static Visibility[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Visibility valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getToken

public String getToken()

Returns:

The text to use for the visibility

fromToken

public static Visibility fromToken(String token)

Grabs the Visibility that corresponds to the given token

Parameters:

token - The token used for the visibility (to use in searching)

Returns:

The found Visibility, or null