com.speedment.runtime.core.util

Enum FeatureReadinessLevel

java.lang.Object

java.lang.Enum<FeatureReadinessLevel>

com.speedment.runtime.core.util.FeatureReadinessLevel

All Implemented Interfaces:

Serializable, Comparable<FeatureReadinessLevel>

public enum FeatureReadinessLevel
extends Enum<FeatureReadinessLevel>

Enumeration of the readiness of a particular feature. This is used internally by Speedment to print an appropriate message on launch.

Since:

3.0.21

Author:

Per Minborg

Enum Constant Summary

Enum Constants

Enum Constant and Description
API_STABLE The feature has undergone testing and the API is unlikely to undergo anything else than minor changes.
EXPERIMENTAL The feature is pure experimental whereby the API is likely to change, there are no or limited test coverage and the feature is likely to exhibit unpredictable behavior including erratic results, memory leaks, lingering resource allocations and complete JVM crashes.
PREVIEW The feature has undergone limited testing and the API is likely to change but likely not in a material way.
RELEASE_CANDIDATE The feature has undergone regular testing and the API is stable.

Method Summary

Modifier and Type	Method and Description
void	assertAtLeast(FeatureReadinessLevel requiredLevel) Throw a SpeedmentException if the required FeatureReadinessLevel has not been met.
static FeatureReadinessLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static FeatureReadinessLevel[]	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

EXPERIMENTAL

public static final FeatureReadinessLevel EXPERIMENTAL

The feature is pure experimental whereby the API is likely to change, there are no or limited test coverage and the feature is likely to exhibit unpredictable behavior including erratic results, memory leaks, lingering resource allocations and complete JVM crashes. The feature may also be removed at any time without prior notice.

THE USE OF THE FEATURE IN PRODUCTION SYSTEM IS DISALLOWED.

PREVIEW

public static final FeatureReadinessLevel PREVIEW

The feature has undergone limited testing and the API is likely to change but likely not in a material way. The feature may exhibit unpredictable behavior including erratic results, memory leaks, lingering resource allocations.

THE USE OF THE FEATURE IN PRODUCTION SYSTEM IS HIGHLY DISCOURAGED.

API_STABLE

public static final FeatureReadinessLevel API_STABLE

The feature has undergone testing and the API is unlikely to undergo anything else than minor changes. The feature might exhibit unpredictable behavior including erratic results, memory leaks, lingering resource allocations.

THE USE OF THE FEATURE IN PRODUCTION SYSTEM IS DISCOURAGED.

RELEASE_CANDIDATE

public static final FeatureReadinessLevel RELEASE_CANDIDATE

The feature has undergone regular testing and the API is stable. The feature is unlikely to exhibit unpredictable behavior such as erratic results, memory leaks, lingering resource allocations.

THE USE OF THE FEATURE IN PRODUCTION SYSTEM IS NOT RECOMMENDED.

Method Detail

values

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

Returns:

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

valueOf

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

assertAtLeast

public void assertAtLeast(FeatureReadinessLevel requiredLevel)
                   throws SpeedmentException

Throw a SpeedmentException if the required FeatureReadinessLevel has not been met.

Parameters:

requiredLevel - the required readiness level

Throws:

SpeedmentException - if not met