Package com.authlete.common.conf

Enum AuthleteApiVersion

java.lang.Object

java.lang.Enum<AuthleteApiVersion>

com.authlete.common.conf.AuthleteApiVersion

All Implemented Interfaces:

Serializable, Comparable<AuthleteApiVersion>

public enum AuthleteApiVersion
extends Enum<AuthleteApiVersion>

Authlete API version.

Since:

3.23

Enum Constant Summary

Enum Constants

Enum Constant	Description
V2
V3

Method Summary

Modifier and Type	Method	Description
static AuthleteApiVersion	parse(String version)	Parse the given string as AuthleteApiVersion.
static AuthleteApiVersion	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AuthleteApiVersion[]	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

V2

public static final AuthleteApiVersion V2

V3

public static final AuthleteApiVersion V3

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static AuthleteApiVersion parse(String version)

Parse the given string as AuthleteApiVersion.

When the given string is null or does not match any known version, this method returns null without throwing any exception.

Parameters:

version - A string representing a version. For example, "V2".

Returns:

An instance of AuthleteApiVersion, or null if the given string does not match any known version.