Module org.eclipse.persistence.jpars.server

Package org.eclipse.persistence.jpa.rs.features

Enum ServiceVersion

java.lang.Object

java.lang.Enum<ServiceVersion>

org.eclipse.persistence.jpa.rs.features.ServiceVersion

All Implemented Interfaces:

Serializable, Comparable<ServiceVersion>, java.lang.constant.Constable

public enum ServiceVersion
extends Enum<ServiceVersion>

JPARS service version.

Since:

EclipseLink 2.6.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LATEST	The latest version.
VERSION_1_0	Version 1.0.
VERSION_2_0	Version 2.0.

Method Summary

Modifier and Type	Method	Description
static ServiceVersion	fromCode(String version)	Returns enumeration value by version number as it appears in URI.
String	getCode()	Returns the version as in appears in URI.
FeatureSet	getFeatureSet()	Gets a FeatureSet related to this service version.
static boolean	hasCode(String code)	Checks if ServiceVersion with given code exists.
static ServiceVersion	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ServiceVersion[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

VERSION_1_0

public static final ServiceVersion VERSION_1_0

Version 1.0. Legacy.

VERSION_2_0

public static final ServiceVersion VERSION_2_0

Version 2.0. Supports pagination and other new features.

LATEST

public static final ServiceVersion LATEST

The latest version.

Method Details

values

public static ServiceVersion[] values()

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

Returns:

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

valueOf

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

getCode

public String getCode()

Returns the version as in appears in URI.

Returns:

the version.

fromCode

public static ServiceVersion fromCode(String version)
                               throws IllegalArgumentException

Returns enumeration value by version number as it appears in URI.

Parameters:

version - version as it appears in URI.

Returns:

ServiceVersion.

Throws:

IllegalArgumentException - in case that the passed code does not match any enumeration value.

getFeatureSet

public FeatureSet getFeatureSet()

Gets a FeatureSet related to this service version.

Returns:

FeatureSet related to this version.

hasCode

public static boolean hasCode(String code)

Checks if ServiceVersion with given code exists.

Parameters:

code - Code to check.

Returns:

true if exists, false if not.