|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<StabilityLevel>
org.opends.server.types.StabilityLevel
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public enum StabilityLevel
This class implements an enumeration whose values may be used to
indicate the stability level of API classes and/or methods. Code
which is part of the OpenDS public API should be marked with a
COMMITTED
, UNCOMMITTED
, VOLAITLE
, or
OBSOLETE
stability level in order to indicate the relative
likelihood that the associated interface will be changed in an
incompatible way in the future.
Third-party developers are free to create code that introduces
dependencies on OpenDS APIs that are marked COMMITTED
,
UNCOMMITTED
, or VOLATILE
, with an understanding
that the less stable an OpenDS API is, the more likely that
third-party code which relies upon it may need to be altered in
order to work properly with future versions.
Changes to the stability level of a class or package should only be
made between major releases and must be denoted in the release
notes for all releases with that major version. If a public API
element that is marked COMMITTED
, UNCOMMITTED
, or
VOLATILE
is to be made private, it is strongly recommended
that it first be transitioned to OBSOLETE
before ultimately
being marked PRIVATE
.
New packages and classes introduced into the OpenDS code base may
be assigned any stability level. New methods introduced into
existing classes that are part of the public API may be created
with any stability level as long as the introduction of that method
is compliant with the stability level of the class. If a method
that is part of the OpenDS public API is not marked with an
explicit stability level, then it should be assumed that it has the
same stability level as the class that contains it.
Enum Constant Summary | |
---|---|
COMMITTED
The associated package, class, or method may be made available for third-party use, and the APIs that it exposes should be considered stable. |
|
OBSOLETE
The associated package, class, or method should be considered obsolete, and no new code should be created that depends on it. |
|
PRIVATE
The associated package, class, or method should be considered part of the OpenDS private API and should not be used by third-party code. |
|
UNCOMMITTED
The associated package, class, or method may be made available for third-party use, and the APIs that it exposes may be considered moderately stable. |
|
VOLATILE
The associated package, class, or method may be made available for third-party use, but the APIs that it exposes should not be considered stable. |
Method Summary | |
---|---|
static StabilityLevel |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static StabilityLevel[] |
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 static final StabilityLevel COMMITTED
public static final StabilityLevel UNCOMMITTED
public static final StabilityLevel VOLATILE
VOLATILE
, even if that
those incompatible changes are expected to occur between major
releases.
public static final StabilityLevel OBSOLETE
public static final StabilityLevel PRIVATE
PRIVATE
classification.
Method Detail |
---|
public static StabilityLevel[] values()
for (StabilityLevel c : StabilityLevel.values()) System.out.println(c);
public static StabilityLevel valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is null
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |