org.schmant.task.template.jdk.javadoc
Enum JavadocVisibilityLevel

java.lang.Object
  java.lang.Enum<JavadocVisibilityLevel>
      org.schmant.task.template.jdk.javadoc.JavadocVisibilityLevel

All Implemented Interfaces:

Serializable, Comparable<JavadocVisibilityLevel>

public enum JavadocVisibilityLevel
extends Enum<JavadocVisibilityLevel>

Enumeration over the different visibility levels for the Javadoc documentation. A visibility level decides the minimum visibility of elements included in the documentation.

Since:

0.5

Author:

Karl Gustafsson

Enum Constant Summary

PACKAGE

PRIVATE

PROTECTED

PUBLIC

Method Summary

static JavadocVisibilityLevel	getFromString(String s) Parse the string ("private", "package", "protected" or "public") and return the corresponding visibility level.
String	toString()
static JavadocVisibilityLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static JavadocVisibilityLevel[]	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

PRIVATE

public static final JavadocVisibilityLevel PRIVATE

PACKAGE

public static final JavadocVisibilityLevel PACKAGE

PROTECTED

public static final JavadocVisibilityLevel PROTECTED

PUBLIC

public static final JavadocVisibilityLevel PUBLIC

Method Detail

values

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

Returns:

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

valueOf

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

getFromString

public static JavadocVisibilityLevel getFromString(String s)

Parse the string ("private", "package", "protected" or "public") and return the corresponding visibility level.

Parameters:

s - The string.

Returns:

The visibility level.

toString

public String toString()

Overrides:

toString in class Enum<JavadocVisibilityLevel>