com.google.auto.common

Enum Visibility

java.lang.Object

java.lang.Enum<Visibility>

com.google.auto.common.Visibility

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Visibility>

public enum Visibility
extends java.lang.Enum<Visibility>

Represents the visibility of a given Element: public, protected, private or default/package-private.

The constants for this enum are ordered according by increasing visibility.

Author:

Gregory Kick

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT
PRIVATE
PROTECTED
PUBLIC

Method Summary

Modifier and Type	Method and Description
static Visibility	effectiveVisibilityOfElement(javax.lang.model.element.Element element) Returns effective visibility of the given element meaning that it takes into account the visibility of its enclosing elements.
static Visibility	ofElement(javax.lang.model.element.Element element) Returns the visibility of the given Element.
static Visibility	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static 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

PRIVATE

public static final Visibility PRIVATE

DEFAULT

public static final Visibility DEFAULT

PROTECTED

public static final Visibility PROTECTED

PUBLIC

public static final Visibility PUBLIC

Method Detail

values

public static 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 (Visibility c : 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 Visibility valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

ofElement

public static Visibility ofElement(javax.lang.model.element.Element element)

Returns the visibility of the given Element. While package and module elements don't technically have a visibility associated with them, this method returns PUBLIC for them.

effectiveVisibilityOfElement

public static Visibility effectiveVisibilityOfElement(javax.lang.model.element.Element element)

Returns effective visibility of the given element meaning that it takes into account the visibility of its enclosing elements.