ro.sync.annotations.api
Enum APIType

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

All Implemented Interfaces:

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

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

An API element type. The constants of this enumerated type provide a simple classification of the Java types (classes / interfaces / enums / annotation types) that are intended to be exposed as public API.

These constants are used with the API annotation type to specify the type of the annotated API element.

Enum Constant Summary

EXTENDABLE
API element intended to be extended / implemented by the developers.

INTERNAL
API element intended for internal use - not accessible to developers.

NOT_EXTENDABLE
API element intended for use-only purposes, not for inheritance.

Field Summary

int	priority The priority of this api type constant.

Method Summary

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

EXTENDABLE

public static final APIType EXTENDABLE

API element intended to be extended / implemented by the developers.

NOT_EXTENDABLE

public static final APIType NOT_EXTENDABLE

API element intended for use-only purposes, not for inheritance.

INTERNAL

public static final APIType INTERNAL

API element intended for internal use - not accessible to developers.

Field Detail

priority

public int priority

The priority of this api type constant.

Method Detail

values

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

Returns:

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

valueOf

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