org.apache.hudi

Enum ApiMaturityLevel

java.lang.Object

java.lang.Enum<ApiMaturityLevel>

org.apache.hudi.ApiMaturityLevel

All Implemented Interfaces:

Serializable, Comparable<ApiMaturityLevel>

public enum ApiMaturityLevel
extends Enum<ApiMaturityLevel>

Indicates how stable a given API method/class is, so user's can plan and set their expectations accordingly.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEPRECATED New things are born, old things fade away.
EVOLVING New APIs start out in this state.
STABLE Enough applications/users have picked up the API and we deem it stable.

Method Summary

Modifier and Type	Method and Description
static ApiMaturityLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static ApiMaturityLevel[]	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

EVOLVING

public static final ApiMaturityLevel EVOLVING

New APIs start out in this state. Although enough thought will be given to avoid breaking changes to the API in the future, sometimes it might need to change based on feedback.

STABLE

public static final ApiMaturityLevel STABLE

Enough applications/users have picked up the API and we deem it stable. We will strive to never break the stability of such APIs within a given major version release.

DEPRECATED

public static final ApiMaturityLevel DEPRECATED

New things are born, old things fade away. This holds true for APIs also. Once an API has been marked as deprecated, new APIs replacing them (if need be) would be in stable state for users to migrate to.

Method Detail

values

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

Returns:

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

valueOf

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