Package nl.talsmasoftware.umldoclet.configuration

Enum Visibility

java.lang.Object

java.lang.Enum<Visibility>

nl.talsmasoftware.umldoclet.configuration.Visibility

All Implemented Interfaces:

Serializable, Comparable<Visibility>

public enum Visibility
extends Enum<Visibility>

The visibility values for classes, methods and fields.

See Access Control description in the official Oracle documentation. In the UML Doclet, the visibility is used for two purposes:

1. To represent the visibility of classes, methods and fields in the internal model for rendered diagrams.
2. To 'ask' the configuration whether a particular diagram should render classes, methods or fields with a particular visibility.

Author:

Sjoerd Talsma

Enum Constant Summary

Enum Constants

Enum Constant	Description
PACKAGE_PRIVATE	The visibility corresponding with the Java default Modifier.
PRIVATE	The visibility corresponding with the Java private modifier.
PROTECTED	The visibility corresponding with the Java protected modifier.
PUBLIC	The visibility corresponding with the Java public modifier.

Method Summary

Modifier and Type	Method	Description
static Visibility	valueOf(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 Details

PRIVATE

public static final Visibility PRIVATE

The visibility corresponding with the Java private modifier.

PROTECTED

public static final Visibility PROTECTED

The visibility corresponding with the Java protected modifier.

PACKAGE_PRIVATE

public static final Visibility PACKAGE_PRIVATE

The visibility corresponding with the Java default Modifier.

PUBLIC

public static final Visibility PUBLIC

The visibility corresponding with the Java public modifier.

Method Details

values

public static Visibility[] values()

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

Returns:

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

valueOf

public static 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