Skip navigation links

org.eclipse.persistence.jpa.jpql.spi
Enum IJPAVersion

java.lang.Object
java.lang.Enum<IJPAVersion>
org.eclipse.persistence.jpa.jpql.spi.IJPAVersion

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IJPAVersion>

public enum IJPAVersion

extends java.lang.Enum<IJPAVersion>

An enumeration listing the various released versions of the Java Persistence specification.

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Enum Constant Summary

DEFAULT_VERSION
The constant for the default version used by the parsing system, which is always the latest version of the Java Persistence functional specification.

VERSION_1_0
The constant for the Java Persistence version 1.0.

VERSION_2_0
The constant for the Java Persistence version 2.0.

Field Summary

private double

version The real version number.

Method Summary

java.lang.String	getVersion() Returns the real version this constant represents.
boolean	isNewerThan(IJPAVersion version) Determines whether this constant represents a version that is newer than the given version.
boolean	isNewerThanOrEqual(IJPAVersion version) Determines whether this constant represents a version that is newer than the given version or if it's the same version.
boolean	isOlderThan(IJPAVersion version) Determines whether this constant represents a version that is older than the given version.
boolean	isOlderThanOrEqual(IJPAVersion version) Determines whether this constant represents a version that is older than the given version or if it's the same version.
IJPAVersion	toCurrentVersion() Converts the current constant to one of the known versions, this means if the constant is DEFAULT_VERSION, then it will be converted into the actual constant representing that version.
java.lang.String	toString()
static IJPAVersion	value(java.lang.String value) Retrieves the enumeration constant for the given value.
static IJPAVersion	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IJPAVersion[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static IJPAVersion[]	versions() Returns the list of IJPAVersions excluding DEFAULT_VERSION.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT_VERSION

public static final IJPAVersion DEFAULT_VERSION

The constant for the default version used by the parsing system, which is always the latest version of the Java Persistence functional specification.

VERSION_1_0

public static final IJPAVersion VERSION_1_0

The constant for the Java Persistence version 1.0.

VERSION_2_0

public static final IJPAVersion VERSION_2_0

The constant for the Java Persistence version 2.0.

Field Detail

version

private double version

The real version number.

Method Detail

values

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

Returns:

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

valueOf

public static IJPAVersion valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

value

public static IJPAVersion value(java.lang.String value)

Retrieves the enumeration constant for the given value. If the value is not known, then DEFAULT_VERSION will be returned.

Parameters:

value - The value to retrieve its constant version

Returns:

The constant version of the given value

versions

public static IJPAVersion[] versions()

Returns the list of IJPAVersions excluding DEFAULT_VERSION.

Returns:

The list of unique constants

getVersion

public java.lang.String getVersion()

Returns the real version this constant represents.

Returns:

The string value of the version

isNewerThan

public boolean isNewerThan(IJPAVersion version)

Determines whether this constant represents a version that is newer than the given version.

Parameters:

version - The constant to verify if it's representing a version that is older than this one

Returns:

true if this constant represents a newer version and the given constant represents a version that is older; false if the given constant represents a newer and this constant represents an older version

isNewerThanOrEqual

public boolean isNewerThanOrEqual(IJPAVersion version)

Determines whether this constant represents a version that is newer than the given version or if it's the same version.

Parameters:

version - The constant to verify if it's representing a version that is older than this one or if it's the same than this one

Returns:

true if this constant represents a newer version and the given constant represents a version that is older or if it's the same constant; false if the given constant represents a newer and this constant represents an older version

isOlderThan

public boolean isOlderThan(IJPAVersion version)

Determines whether this constant represents a version that is older than the given version.

Parameters:

jpaVersion - The constant to verify if it's representing a version that is more recent than this one

Returns:

true if this constant represents an earlier version and the given constant represents a version that is more recent; false if the given constant represents an earlier version and this constant represents a more recent version

isOlderThanOrEqual

public boolean isOlderThanOrEqual(IJPAVersion version)

Determines whether this constant represents a version that is older than the given version or if it's the same version.

Parameters:

version - The constant to verify if it's representing a version that is more recent than this one or if it's the same than this one

Returns:

true if this constant represents an earlier version and the given constant represents a version that is more recent or if it's the same constant; false if the given constant represents an earlier version and this constant represents a more recent version

toCurrentVersion

public IJPAVersion toCurrentVersion()

Converts the current constant to one of the known versions, this means if the constant is DEFAULT_VERSION, then it will be converted into the actual constant representing that version.

Returns:

Either this same constant or the actual version constant

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<IJPAVersion>

Skip navigation links