com.twofortyfouram.annotation

Enum VisibleForTesting.Visibility

java.lang.Object

java.lang.Enum<VisibleForTesting.Visibility>

com.twofortyfouram.annotation.VisibleForTesting.Visibility

All Implemented Interfaces:

Serializable, Comparable<VisibleForTesting.Visibility>

Enclosing class:

VisibleForTesting

public static enum VisibleForTesting.Visibility
extends Enum<VisibleForTesting.Visibility>

Documents the intended visibility.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PACKAGE The visibility is intended to be package.
PRIVATE The visibility is intended to be private.
PROTECTED The visibility is intended to be protected.
PUBLIC The visibility is intended to be public.
TEST The code's sole purpose is for testing and wouldn't exist otherwise.

Method Summary

Methods

Modifier and Type	Method and Description
static VisibleForTesting.Visibility	valueOf(String name) Returns the enum constant of this type with the specified name.
static VisibleForTesting.Visibility[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PUBLIC

public static final VisibleForTesting.Visibility PUBLIC

The visibility is intended to be public.

PACKAGE

public static final VisibleForTesting.Visibility PACKAGE

The visibility is intended to be package.

PROTECTED

public static final VisibleForTesting.Visibility PROTECTED

The visibility is intended to be protected.

PRIVATE

public static final VisibleForTesting.Visibility PRIVATE

The visibility is intended to be private.

TEST

public static final VisibleForTesting.Visibility TEST

The code's sole purpose is for testing and wouldn't exist otherwise.

For example, some objects may expose a test constructor to make injecting special values easier at test time.

Method Detail

values

public static VisibleForTesting.Visibility[] 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 (VisibleForTesting.Visibility c : VisibleForTesting.Visibility.values())
    System.out.println(c);

Returns:

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

valueOf

public static VisibleForTesting.Visibility 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