jgnash.engine
Enum TransactionTag

java.lang.Object
  extended by java.lang.Enum<TransactionTag>
      extended by jgnash.engine.TransactionTag
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<TransactionTag>

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

Tagging enumeration for special transaction types

Version:
$Id$
Author:
Craig Cavanaugh

Enum Constant Summary
BANK
           
DIVIDEND
           
GAIN_LOSS
           
GAINS_OFFSET
           
INVESTMENT
           
INVESTMENT_CASH_TRANSFER
           
INVESTMENT_FEE
           
VAT
           
 
Field Summary
private  java.lang.String description
           
 
Method Summary
 java.lang.String toString()
           
static TransactionTag valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static TransactionTag[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

BANK

public static final TransactionTag BANK

DIVIDEND

public static final TransactionTag DIVIDEND

GAIN_LOSS

public static final TransactionTag GAIN_LOSS

GAINS_OFFSET

public static final TransactionTag GAINS_OFFSET

INVESTMENT

public static final TransactionTag INVESTMENT

INVESTMENT_FEE

public static final TransactionTag INVESTMENT_FEE

INVESTMENT_CASH_TRANSFER

public static final TransactionTag INVESTMENT_CASH_TRANSFER

VAT

public static final TransactionTag VAT
Field Detail

description

private transient java.lang.String description
Method Detail

values

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

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

valueOf

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

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Enum<TransactionTag>