Enum Class UpgradeType

java.lang.Object

java.lang.Enum<UpgradeType>

org.apache.cayenne.project.upgrade.UpgradeType

All Implemented Interfaces:

Serializable, Comparable<UpgradeType>, Constable

public enum UpgradeType
extends Enum<UpgradeType>

An enum indicating what type of upgrade, if any, is needed and possible to bring the project configuration format in sync with the current Cayenne runtime.

Since:

3.1

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOWNGRADE_NEEDED	The project configuration format is from a newer version of Cayenne, and the current runtime can't work with it.
INTERMEDIATE_UPGRADE_NEEDED	The project configuration format is from an older version of Cayenne, and it can be upgraded to the current Cayenne version, however some information may get lost during the upgrade.
UPGRADE_NEEDED	The project configuration format is from an older version of Cayenne, and it can be fully upgraded to the current Cayenne version.
UPGRADE_NOT_NEEDED	The project configuration is current and can be used with the enclosing Cayenne runtime.

Method Summary

Modifier and Type	Method	Description
static UpgradeType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UpgradeType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UPGRADE_NOT_NEEDED

public static final UpgradeType UPGRADE_NOT_NEEDED

The project configuration is current and can be used with the enclosing Cayenne runtime.

UPGRADE_NEEDED

public static final UpgradeType UPGRADE_NEEDED

The project configuration format is from an older version of Cayenne, and it can be fully upgraded to the current Cayenne version.

INTERMEDIATE_UPGRADE_NEEDED

public static final UpgradeType INTERMEDIATE_UPGRADE_NEEDED

The project configuration format is from an older version of Cayenne, and it can be upgraded to the current Cayenne version, however some information may get lost during the upgrade. A user may still chose to upgrade, however a recommended upgrade path is to do an intermediary upgrade using previous versions of Cayenne.

DOWNGRADE_NEEDED

public static final UpgradeType DOWNGRADE_NEEDED

The project configuration format is from a newer version of Cayenne, and the current runtime can't work with it.

Method Details

values

public static UpgradeType[] values()

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

Returns:

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

valueOf

public static UpgradeType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null