net.yapbam.data.Mode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yapbam-commons Show documentation

Commons Yapbam classes used by desktop and Android versions.

There is a newer version: 1.9.1

package net.yapbam.data;

import java.io.Serializable;

import net.yapbam.date.helpers.DateStepper;
import net.yapbam.util.NullUtils;

/** A payment mode (Blue card, check ...).
 */
public class Mode implements Serializable {
	private static final long serialVersionUID = 1L;
	
	/** Undefined mode (usable for receipts and expenses, the date value is the operation date). */ 
	public static final Mode UNDEFINED = new Mode("",DateStepper.IMMEDIATE, DateStepper.IMMEDIATE, false);
	
	private String name;
	private DateStepper receiptVDC;
	private DateStepper expenseVDC;
	private boolean useCheckBook;

	/** Constructor
	 * @param name The name (must not be null)
	 * @param receiptVDC A ValueDateComputer used to compute value date for receipts, or null if this mode
	 *  can't be used for receipts
	 * @param expenseVDC A ValueDateComputer used to compute value date for expenditures, or null if this mode
	 *  can't be used for receipts
	 * @param useCheckbook true if this mode use a checkbook
	 * @throws IllegalArgumentException if useCheckbook is true and vdcForExpenditure is false;
	 */
	public Mode(String name, DateStepper receiptVDC, DateStepper expenseVDC, boolean useCheckbook) {
		if (name==null) {
			throw new IllegalArgumentException();
		}
		if (useCheckbook && (expenseVDC==null)) {
			throw new IllegalArgumentException();
		}
		this.name = name;
		this.receiptVDC = receiptVDC;
		this.expenseVDC = expenseVDC;
		this.useCheckBook = useCheckbook;
	}

	public String getName() {
		return name;
	}

	public DateStepper getReceiptVdc() {
		return receiptVDC;
	}

	public DateStepper getExpenseVdc() {
		return expenseVDC;
	}

	public boolean isUseCheckBook() {
		return useCheckBook;
	}
	
	public boolean isUsableForReceipt() {
		return this.receiptVDC!=null;
	}

	public boolean isUsableForExpense() {
		return this.expenseVDC!=null;
	}

	@Override
	public boolean equals(Object obj) {
		if ((obj==null) || !(obj instanceof Mode)) {
			return false;
		}
		return NullUtils.areEquals(this.getName(),((Mode)obj).getName());
	}

	@Override
	public int hashCode() {
		return this.getName().hashCode();
	}
	
	@SuppressWarnings("nls")
	@Override
	public String toString() {
		return this.getName() + "[" + this.getExpenseVdc()+"/"+this.getReceiptVdc()+"-"+(this.isUseCheckBook()?"check":"no check")+"]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$
	}

	void updateTo(Mode newMode) {
		this.name = newMode.name;
		this.expenseVDC = newMode.expenseVDC;
		this.receiptVDC = newMode.receiptVDC;
		this.useCheckBook = newMode.useCheckBook;
	}
}