org.cyclos.model.banking.transactions

Enum TransactionSubjects

java.lang.Object

java.lang.Enum<TransactionSubjects>

org.cyclos.model.banking.transactions.TransactionSubjects

All Implemented Interfaces:

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

public enum TransactionSubjects
extends java.lang.Enum<TransactionSubjects>

Reference to none, one of (from or to) or both subjects of a transaction (or transfer)

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH Reference to both from and to subjects of the transaction
FROM Reference to the transaction from
NONE Reference to none of the transaction subjects
TO Reference to the transaction to

Method Summary

Modifier and Type	Method and Description
boolean	isFrom() Returns whether the from subject is referenced
boolean	isTo() Returns whether the to subject is referenced
static TransactionSubjects	of(boolean from, boolean to)
static TransactionSubjects	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TransactionSubjects[]	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

NONE

public static final TransactionSubjects NONE

Reference to none of the transaction subjects

FROM

public static final TransactionSubjects FROM

Reference to the transaction from

TO

public static final TransactionSubjects TO

Reference to the transaction to

BOTH

public static final TransactionSubjects BOTH

Reference to both from and to subjects of the transaction

Method Detail

values

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

Returns:

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

valueOf

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

of

public static TransactionSubjects of(boolean from,
                                     boolean to)

isFrom

public boolean isFrom()

Returns whether the from subject is referenced

isTo

public boolean isTo()

Returns whether the to subject is referenced