org.kapott.hbci.structures.Saldo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hbci4j-adorsys Show documentation

HBCI4j - Home Banking Computer Interface for Java - Clone from https://github.com/hbci4j/hbci4java

There is a newer version: 3.5.46

/*  $Id: Saldo.java,v 1.1 2011/05/04 22:37:49 willuhn Exp $

    This file is part of HBCI4Java
    Copyright (C) 2001-2008  Stefan Palme

    HBCI4Java is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    HBCI4Java is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

package org.kapott.hbci.structures;

import org.kapott.hbci.manager.HBCIUtils;

import java.io.Serializable;
import java.util.Date;

/**
 * Darstellung eines Saldos. Anders als bei der Darstellung als
 * einfacher Wert wird hier der absolute Betrag des Wertes
 * gespeichert. Es gibt ein separates Kennzeichen für die
 * Unterscheidung zwischen Soll und Haben.
 */
public final class Saldo
    implements Serializable {
    /**
     * Betrag des Saldos.
     */
    public Value value;
    /**
     * Zeitpunkt der Gültigkeit dieses Saldos.
     */
    public Date timestamp;

    /**
     * Anlegen eines neuen Saldo-Objektes
     */
    public Saldo() {
        value = new Value();
    }

    /**
     * Umwandeln des Saldos in eine String-Darstellung. Das Format ist dabei folgendes:
     * <timestamp> ["+"|"-"] <value>
     *
     * @return Stringdarstellung des Saldos
     */
    public String toString() {
        return HBCIUtils.datetime2StringLocal(timestamp) + " " + value.toString();
    }
}