org.kapott.hbci.sepa

Class PainVersion

java.lang.Object

org.kapott.hbci.sepa.PainVersion

All Implemented Interfaces:

Comparable<PainVersion>

public class PainVersion
extends Object
implements Comparable<PainVersion>

Kapselt das Parsen und Vergleichen von SEPA Pain-Versionen.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PainVersion.Type Enum fuer die Gruppierung der verschienden Typen von Geschaeftsvorfaellen.

Field Summary

Fields

Modifier and Type	Field and Description
static PainVersion	PAIN_001_001_02
static PainVersion	PAIN_001_001_03
static PainVersion	PAIN_001_002_02
static PainVersion	PAIN_001_002_03
static PainVersion	PAIN_001_003_03
static PainVersion	PAIN_002_001_03
static PainVersion	PAIN_002_002_02
static PainVersion	PAIN_002_003_03
static PainVersion	PAIN_008_001_01
static PainVersion	PAIN_008_001_02
static PainVersion	PAIN_008_002_01
static PainVersion	PAIN_008_002_02
static PainVersion	PAIN_008_003_02

Constructor Summary

Constructors

Constructor and Description
PainVersion(String urn) Deprecated. Bitte stattdessen byURN(String) verwenden.
PainVersion(String urn, String file) Deprecated. Bitte stattdessen byURN(String) verwenden.

Method Summary

Modifier and Type	Method and Description
static PainVersion	autodetect(InputStream xml) Ermittelt die PAIN-Version aus dem uebergebenen XML-Stream.
static PainVersion	byURN(String urn) Liefert die PAIN-Version aus dem URN.
static PainVersion	choose(String sepadesc, String sepadata) Die Bank sendet in ihren Antworten sowohl den SEPA-Deskriptor als auch die SEPA-Daten (die XML-Datei) selbst.
int	compareTo(PainVersion v)
boolean	equals(Object obj)
static PainVersion	findGreatest(List<PainVersion> list) Findet in den der Liste die hoechste Pain-Version.
String	getFile() Liefert den Dateinamen des Schemas insofern bekannt.
String	getGeneratorClass(String jobName) Erzeugt den Namen der Java-Klasse des zugehoerigen SEPA-Generators.
static List<PainVersion>	getKnownVersions(PainVersion.Type t) Liefert eine Liste der bekannten PAIN-Versionen fuer den angegebenen Typ.
int	getMajor() Liefert die Major-Versionsnumer.
int	getMinor() Liefert die Minor-Versionsnumer.
String	getParserClass() Erzeugt den Namen der Java-Klasse des zugehoerigen SEPA-Parsers.
String	getSchemaLocation() Liefert einen String " " zurueck, der im erzeugten XML als "xsi:schemaLocation" verwendet werden kann.
PainVersion.Type	getType() Liefert den Typ der PAIN-Version.
String	getURN() Liefert die URN der PAIN-Version.
int	hashCode()
boolean	isSupported(String jobName) Prueft, ob die angegebene PAIN-Version fuer den angegebenen Job von HBCI4Java unterstuetzt wird.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PAIN_001_001_02

public static PainVersion PAIN_001_001_02

PAIN_001_002_02

public static PainVersion PAIN_001_002_02

PAIN_001_002_03

public static PainVersion PAIN_001_002_03

PAIN_001_003_03

public static PainVersion PAIN_001_003_03

PAIN_001_001_03

public static PainVersion PAIN_001_001_03

PAIN_002_002_02

public static PainVersion PAIN_002_002_02

PAIN_002_003_03

public static PainVersion PAIN_002_003_03

PAIN_002_001_03

public static PainVersion PAIN_002_001_03

PAIN_008_001_01

public static PainVersion PAIN_008_001_01

PAIN_008_002_01

public static PainVersion PAIN_008_002_01

PAIN_008_002_02

public static PainVersion PAIN_008_002_02

PAIN_008_003_02

public static PainVersion PAIN_008_003_02

PAIN_008_001_02

public static PainVersion PAIN_008_001_02

Constructor Detail

PainVersion

@Deprecated
public PainVersion(String urn)

Deprecated. Bitte stattdessen byURN(String) verwenden.

ct. Erzeugt eine neue PAIN-Version.

Parameters:

urn - der URN.

PainVersion

@Deprecated
public PainVersion(String urn,
                               String file)

Deprecated. Bitte stattdessen byURN(String) verwenden.

ct. Erzeugt eine neue PAIN-Version.

Parameters:

urn - der URN.

file - Dateiname der Schema-Datei.

Method Detail

byURN

public static PainVersion byURN(String urn)

Liefert die PAIN-Version aus dem URN.

Parameters:

urn - URN. In der Form "urn:iso:std:iso:20022:tech:xsd:pain.001.002.03" oder in der alten Form "sepade.pain.001.001.02.xsd".

Returns:

die PAIN-Version.

getSchemaLocation

public String getSchemaLocation()

Liefert einen String " " zurueck, der im erzeugten XML als "xsi:schemaLocation" verwendet werden kann.

Returns:

Schema-Location oder NULL, wenn "file" nicht gesetzt wurde.

getGeneratorClass

public String getGeneratorClass(String jobName)

Erzeugt den Namen der Java-Klasse des zugehoerigen SEPA-Generators.

Parameters:

jobName - der Job-Name. Z.Bsp. "UebSEPA".

Returns:

der Name der Java-Klasse des zugehoerigen SEPA-Generators.

getParserClass

public String getParserClass()

Erzeugt den Namen der Java-Klasse des zugehoerigen SEPA-Parsers.

Returns:

der Name der Java-Klasse des zugehoerigen SEPA-Parsers.

isSupported

public boolean isSupported(String jobName)

Prueft, ob die angegebene PAIN-Version fuer den angegebenen Job von HBCI4Java unterstuetzt wird.

Parameters:

jobName - der Job-Name. Z.Bsp. "UebSEPA".

Returns:

true, wenn sie unterstuetzt wird.

getType

public PainVersion.Type getType()

Liefert den Typ der PAIN-Version.

Returns:

der Typ der PAIN-Version.

getMajor

public int getMajor()

Liefert die Major-Versionsnumer.

Returns:

die Major-Versionsnumer.

getMinor

public int getMinor()

Liefert die Minor-Versionsnumer.

Returns:

die Minor-Versionsnumer.

getURN

public String getURN()

Liefert die URN der PAIN-Version.

Returns:

die URN der PAIN-Version.

getFile

public String getFile()

Liefert den Dateinamen des Schemas insofern bekannt.

Returns:

der Dateiname des Schema oder null.

findGreatest

public static PainVersion findGreatest(List<PainVersion> list)

Findet in den der Liste die hoechste Pain-Version.

Parameters:

list - Liste mit PAIN-Versionen.

Returns:

die hoechste Version oder NULL wenn die Liste leer ist.

getKnownVersions

public static List<PainVersion> getKnownVersions(PainVersion.Type t)

Liefert eine Liste der bekannten PAIN-Versionen fuer den angegebenen Typ.

Parameters:

t - der Typ.

Returns:

Liste der bekannten PAIN-Versionen fuer den angegebenen Typ.

autodetect

public static PainVersion autodetect(InputStream xml)

Ermittelt die PAIN-Version aus dem uebergebenen XML-Stream.

Parameters:

xml - der XML-Stream. Achtung: Da der Stream hierbei gelesen werden muss, sollte eine Kopie des Streams uebergeben werden. Denn nach dem Lesen des Streams, kann er nicht erneut gelesen werden. Der Stream wird von dieser Methode nicht geschlossen. Das ist Aufgabe des Aufrufers.

Returns:

die ermittelte PAIN-Version oder NULL wenn das XML-Document keine entsprechenden Informationen enthielt.

choose

public static PainVersion choose(String sepadesc,
                                 String sepadata)

Die Bank sendet in ihren Antworten sowohl den SEPA-Deskriptor als auch die SEPA-Daten (die XML-Datei) selbst. Diese Funktion ermittelt sowohl aus dem SEPA-Deskriptor als auch aus den SEPA-Daten die angegebene PAIN-Version und vergleicht beide. Stimmen sie nicht ueberein, wird eine Warnung ausgegeben. Die Funktion liefert anschliessend die zum Parsen passende Version zurueck. Falls sich die angegebenen Versionen unterscheiden, wird die in den XML-Daten angegebene Version zurueckgeliefert. Siehe https://www.willuhn.de/bugzilla/show_bug.cgi?id=1806

Parameters:

sepadesc - die in der HBCI-Nachricht angegebene PAIN-Version.

sepadata - die eigentlichen XML-Daten.

Returns:

die zum Parsen zu verwendende PAIN-Version. NULL, wenn keinerlei Daten angegeben wurden.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

compareTo

public int compareTo(PainVersion v)

Specified by:

compareTo in interface Comparable<PainVersion>

See Also:

Comparable.compareTo(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()