Enum Class TransactionDirection

java.lang.Object

java.lang.Enum<TransactionDirection>

com.bluebell.greenhouse.platform.enums.transaction.TransactionDirection

All Implemented Interfaces:

GenericEnum<TransactionDirection>, Serializable, Comparable<TransactionDirection>, Constable

public enum TransactionDirection
extends Enum<TransactionDirection>
implements GenericEnum<TransactionDirection>

Direction in which a transaction changes an account balance.

Version:

3.0.4

Author:

Stephen Prizio

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREDIT
DEBIT

Method Summary

Modifier and Type	Method	Description
double	apply(double amount)	Applies this direction to the supplied amount.
static TransactionDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TransactionDirection[]	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

Methods inherited from interface GenericEnum

getCode, getEnum, getLabel

Enum Constant Details

CREDIT

public static final TransactionDirection CREDIT

DEBIT

public static final TransactionDirection DEBIT

Method Details

values

public static TransactionDirection[] 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 TransactionDirection 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

apply

public double apply(double amount)

Applies this direction to the supplied amount.

Parameters:

amount - transaction amount

Returns:

signed transaction amount