Class Transaction

java.lang.Object

Transaction

All Implemented Interfaces:

java.lang.Comparable<Transaction>

public final class Transaction
extends java.lang.Object
implements java.lang.Comparable<Transaction>

This class encapsulates a financial transaction, with a date, details, and an amount. To ensure a transaction cannot be altered, this class is immutable. To prevent privacy leaks, this class aggregates the date via a composition.

Constructor Summary

Constructors

Constructor and Description
Transaction(java.util.Date date, java.lang.String details, double amount) Initializes this object based on the passed parameters.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Transaction other) Compares this transaction to another one.
boolean	equals(java.lang.Object obj) Determines if this object is equal to the specified object.
double	getAmount() Returns the amount of this transaction.
java.util.Date	getDate() Returns the date of this transaction.
java.lang.String	getDetails() Returns the details of this transaction.
java.lang.String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Transaction

public Transaction(java.util.Date date,
           java.lang.String details,
           double amount)

Initializes this object based on the passed parameters.

Parameters:

date - The date of the transaction.

details - The details of the transaction.

amount - The amount of the transaction. To facilitate precise currency conversions, the values need not be rounded to two decimal places.

Method Detail

getDate

public java.util.Date getDate()

Returns the date of this transaction.

Returns:

The date of this transaction.

getDetails

public java.lang.String getDetails()

Returns the details of this transaction.

Returns:

The details of this transaction.

getAmount

public double getAmount()

Returns the amount of this transaction.

Returns:

The amount of this transaction.

compareTo

public int compareTo(Transaction other)

Compares this transaction to another one. Transactions are sorted in ascending order by date. If the dates are the same, they are sorted by details, then by amount.

Specified by:

compareTo in interface java.lang.Comparable<Transaction>

Parameters:

other - The other Transaction object to compare.

Returns:

-1, 0, 1 if this object comes before, is equal to, or comes after the other object, respectively.

equals

public boolean equals(java.lang.Object obj)

Determines if this object is equal to the specified object.

Overrides:

equals in class java.lang.Object

Returns:

true if the specified object is not null, a Transaction object, and has all attributes identical to this object, false otherwise.

toString

public java.lang.String toString()

Returns a string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

A string with the date, details, and amount (rounded to two decimal places). E.g.: Wed May 22 15:12:08 EDT 2013 A deposit $200.00