org.multiverse.api
Enum TransactionStatus

java.lang.Object
  java.lang.Enum<TransactionStatus>
      org.multiverse.api.TransactionStatus

All Implemented Interfaces:

Serializable, Comparable<TransactionStatus>

public enum TransactionStatus
extends Enum<TransactionStatus>

An enumeration containing the different states a Transaction can be in. Every transaction always start with the active status. If the transaction committed successfully, the status will change to committed. Or when it is is aborted, the status will change to aborted.

If in the future an unstarted state is wanted, please fill in a request for enhancement or go to the mailinglist to place your question.

Author:

Peter Veentjer.

See Also:

Transaction.getStatus()

Enum Constant Summary

aborted

active

committed

prepared

Method Summary

abstract boolean	isDead() Checks if the TransactionStatus belongs to a dead (committed or aborted) transaction.
static TransactionStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static TransactionStatus[]	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

active

public static final TransactionStatus active

prepared

public static final TransactionStatus prepared

committed

public static final TransactionStatus committed

aborted

public static final TransactionStatus aborted

Method Detail

values

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

Returns:

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

valueOf

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

isDead

public abstract boolean isDead()

Checks if the TransactionStatus belongs to a dead (committed or aborted) transaction.

Returns:

true if dead, false otherwise.