ro.sync.annotations.api
Enum SourceType

java.lang.Object
  java.lang.Enum<SourceType>
      ro.sync.annotations.api.SourceType

All Implemented Interfaces:

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

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

An API element source code availability. The constants of this enumerated type state whether the source code of the annotated API element should be made available to to end users.

These constants are used with the API annotation type.

Enum Constant Summary

PRIVATE
Source code not available to end users.

PUBLIC
Source code available to end users.

Method Summary

static SourceType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SourceType[]	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 SourceType PUBLIC

Source code available to end users.

PRIVATE

public static final SourceType PRIVATE

Source code not available to end users.

Method Detail

values

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

Returns:

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

valueOf

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