ea

Class DateiManager

java.lang.Object

ea.DateiManager

public class DateiManager
extends java.lang.Object

Der Dateimanager liest und schreibt Dateien und beachtet dabei die jeweiligen System-abhängigen Zeichen zur Pfadtrennung.

Ausserdem kann sie die Informationen eines Pixelfeldes im .eaf-Format (Engine-Alpha-Figur-Format) speichern sowie die eines String- oder Integer-Arrays im .eaa-Format (Engine-Alpha-Array-Format) lesen und speichern.

Author:

Michael Andonie, Niklas Keller

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	bruch Das für das aktuelle System gültige Zeichen für einen Zeilenumbruch.
static java.lang.String	sep Das für das aktuelle System gültige Zeichen für ein Unterverzeichnis
static java.lang.String	verz Das grundlegende Verzeichnis.

Method Summary

Modifier and Type	Method and Description
static java.awt.Color	ausListe(java.awt.Color farbe) Die Listenmethode beim Figureinlesen und für das speicherarme Raum-Objekt-Färben.
static java.lang.String	farbeAnalysieren(java.awt.Color c) Analysiert eine Farbe und weist ihr einen String zu.
static java.awt.Color	farbeEinlesen(java.lang.String s) Liest einen String ein und konvertiert ihn zu einer Farbe.
static java.lang.String	feldInfo(PixelFeld f) Berechnet aus einem PixelFeld die Informationen und gibt sie als String zurück.
static Figur	figurEinlesen(java.io.File file) Liest eine Figur ein.
static Figur	figurEinlesen(java.lang.String verzeichnis) Liest eine Figur ein.
static Figur	figurEinlesen(java.lang.String verzeichnis, boolean relativ) Deprecated.
static Figur	figurLaden(java.lang.String verzeichnis) Liest eine Figur ein und gibt die geladene Figur zurück.
static int[]	integerArrayEinlesen(java.lang.String pfad) Liest eine .eaa-int-Array-Datei ein.
static boolean	integerArraySchreiben(int[] array, java.lang.String pfad) Schreibt ein int-Array (bzw.
static boolean	schreiben(Figur f, java.lang.String pfad) Vereinfachte Version der Schreibmethode. Hierbei wird die eingegebene Figur nach dem selben Algorythmus geschrieben, jedoch gibt der eine Eingabeparameter den Namen und den gesamten Pfad an.
static boolean	schreiben(Figur f, java.lang.String verzeichnis, java.lang.String name) Schreibt die ".eaf"-Datei zu einer Figur.
static boolean	schreiben(Figur f, java.lang.String name, java.lang.String verzeichnis, boolean relativ) Deprecated. Deprecated, weil Pfade, die nicht mit / beginnen (bzw. C:\ auf Windows) automatisch relativ sind.
static java.lang.String[]	stringArrayEinlesen(java.lang.String pfad) Liest eine .eaa-String-Array-Datei ein.
static boolean	stringArraySchreiben(java.lang.String[] array, java.lang.String pfad) Schreibt ein String-Array (bzw.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bruch

public static final java.lang.String bruch

Das für das aktuelle System gültige Zeichen für einen Zeilenumbruch.

sep

public static final java.lang.String sep

Das für das aktuelle System gültige Zeichen für ein Unterverzeichnis

verz

public static final java.lang.String verz

Das grundlegende Verzeichnis. Dies ist die absolute Pfadangabe zum aktuellen Arbeitsverzeichnis. Das Arbeitsverzeichnis ist das Verzeichnis in dem sich deine .jar-Datei bzw. dein Projekt befindet.

Method Detail

stringArraySchreiben

@API
public static boolean stringArraySchreiben(java.lang.String[] array,
                                                java.lang.String pfad)

Schreibt ein String-Array (bzw. ein String[]-Objekt) als eigenständige Datei auf.

Hierfür wird das .eaa-Format verwendet (Engine-Alpha-Array).

Parameters:

array - Das zu schreibende Array.

pfad - Der Dateipfad, der sowohl das Verzeichnis wie auch den Dateinamen angibt.

Dieser sollte mit .eaa enden. Wenn nicht, wird dies automatisch angehängt.

Returns:

true, falls die Datei erfolgreich geschrieben wurde, sonst false.

stringArrayEinlesen

@API
public static java.lang.String[] stringArrayEinlesen(java.lang.String pfad)

Liest eine .eaa-String-Array-Datei ein.

Parameters:

pfad - Der Dateipfad, der sowohl das Verzeichnis wie auch den Dateinamen angibt.

Dieser sollte mit .eaa enden. Wenn nicht, wird dies automatisch angehängt.

Returns:

Array, das eingelesen wurde oder null, wenn ein Fehler aufgetreten ist.

integerArraySchreiben

@API
public static boolean integerArraySchreiben(int[] array,
                                                 java.lang.String pfad)

Schreibt ein int-Array (bzw. ein int[]-Objekt) als eigenständige Datei auf.

Hierfür wird das .eaa-Format verwendet (Engine-Alpha-Array).

Parameters:

array - Das zu schreibende Array.

pfad - Der Dateipfad, der sowohl das Verzeichnis wie auch den Dateinamen angibt.

Dieser sollte mit .eaa enden. Wenn nicht, wird dies automatisch angehängt.

Returns:

true, falls die Datei erfolgreich geschrieben wurde, sonst false.

integerArrayEinlesen

@API
public static int[] integerArrayEinlesen(java.lang.String pfad)

Liest eine .eaa-int-Array-Datei ein.

Parameters:

pfad - Der Dateipfad, der sowohl das Verzeichnis wie auch den Dateinamen angibt.

Dieser sollte mit .eaa enden. Wenn nicht, wird dies automatisch angehängt.

Returns:

Array, das eingelesen wurde oder null, wenn ein Fehler aufgetreten ist.

schreiben

@API
public static boolean schreiben(Figur f,
                                     java.lang.String pfad)

Vereinfachte Version der Schreibmethode.
Hierbei wird die eingegebene Figur nach dem selben Algorythmus geschrieben, jedoch gibt der eine Eingabeparameter den Namen und den gesamten Pfad an.

Parameters:

f - Die zu schreibende Figur

pfad - Der absolute (oder auch relative) Dateipfad, der sowohl das Verzeichnis wie auch den Dateinamen angibt.

Returns:

Ist true, wenn die Datei erfolgreich geschrieben wurde, ansonsten false.

See Also:

schreiben(Figur, String, String)

schreiben

@API
public static boolean schreiben(Figur f,
                                     java.lang.String verzeichnis,
                                     java.lang.String name)

Schreibt die ".eaf"-Datei zu einer Figur.

Hierbei wird eine eventuell bestehende Datei dieses Namens rigoros gelöscht, sofern möglich.

Diese Methode gibt zurück, ob das schreiben der Datei erfolgreich war oder nicht.

Parameters:

f - Die zu schreibende Figur

name - Der Name der Datei. Dieser sollte mit ".eaf" enden, wenn nicht, wird dies automatisch angehaengt.
Sollte der String allerdings sonst ein "."-Zeichen enthalten, wird nur eine Fehlermeldung ausgespuckt!

verzeichnis - Das Verzeichnis, in dem die Datei gespeichert werden soll. Ist dies ein leerer String (""), so wird die Figur nur nach ihrem namen gespeichert.

Returns:

Ist true, wenn die Datei erfolgreich geschrieben wurde, ansonsten false.

schreiben

@API
 @Deprecated
public static boolean schreiben(Figur f,
                                                  java.lang.String name,
                                                  java.lang.String verzeichnis,
                                                  boolean relativ)

Deprecated. Deprecated, weil Pfade, die nicht mit / beginnen (bzw. C:\ auf Windows) automatisch relativ sind.

Schreibt die ".eaf"-Datei zu einer Figur.

Hierbei wird eine eventuell bestehende Datei dieses Namens rigoros gelöscht, sofern möglich.

Diese Methode gibt zurück, ob das schreiben der Datei erfolgreich war oder nicht.

Parameters:

f - Die zu schreibende Figur

name - Der Name der Datei. Dieser sollte mit ".eaf" enden, wenn nicht, wird dies automatisch angehaengt.
Sollte der String allerdings sonst ein "."-Zeichen enthalten, wird nur eine Fehlermeldung ausgespuckt!

verzeichnis - Das Verzeichnis, in dem die Datei gespeichert werden soll. Ist dies ein leerer String (""), so wird die Figur nur nach ihrem namen gespeichert.

relativ - Gibt an, ob das Verzeichnis relativ zum Spielprojekt geshen werden soll (standard)

Returns:

Ist true, wenn die Datei erfolgreich geschrieben wurde, sonst false.

feldInfo

public static java.lang.String feldInfo(PixelFeld f)

Berechnet aus einem PixelFeld die Informationen und gibt sie als String zurück.

ACHTUNG: Umbruchzeichen werden gesetzt, jedoch endet der String nicht mit einem Zeilenumbruch, daher muss bei der Informationsbindung aus mehreren Feldern eine Zeile nach dem verwenden dieses Strings geschaltet werden.

farbeAnalysieren

public static java.lang.String farbeAnalysieren(java.awt.Color c)

Analysiert eine Farbe und weist ihr einen String zu.

Parameters:

c - Zu analysierende Farbe

Returns:

Stringrepräsentation der Farbe

figurLaden

@API
public static Figur figurLaden(java.lang.String verzeichnis)

Liest eine Figur ein und gibt die geladene Figur zurück.

Diese Methode macht nichts weiter als die Methode figurEinlesen(String). Diese wurde aufgrund der Namensnähe zur Verhinderung ungeliebter Falschschreibungen hinzugefuegt und wrappt diese Methode lediglich.

Parameters:

verzeichnis - Das Verzeichnis der einzulesenden Datei.
Die Eingabe muss ein Dateiname mit dem ende ".eaf" sein. Dies kann ohne Ordnerangaben gemacht werden, wenn die Datei im Quelltextordner ist.

Returns:

Die eingelesene Figur.
Tritt ein Fehler auf, weil die Datei nicht einlesbar ist oder nicht existiert, ist dieser wert null.
Trotzdem kann es sein, dass eine beschuedigte Datei nicht mehr korrekt einlesbar ist, dennoch ein Ergebnis liefert.

See Also:

figurEinlesen(String)

figurEinlesen

@API
public static Figur figurEinlesen(java.lang.String verzeichnis)

Liest eine Figur ein.

Parameters:

verzeichnis - Verzeichnis der einzulesenden Datei.

Die Eingabe muss ein Dateiname mit dem Ende .eaf sein. Dies kann ohne Ordnerangaben gemacht werden, wenn die Datei im Quelltextordner ist.

Returns:

Eingelesene Figur.

Tritt ein Fehler auf, weil die Datei nicht einlesbar ist oder nicht existiert, ist dieser wert null.

Trotzdem kann es sein, dass eine beschädigte Datei nicht mehr korrekt einlesbar ist, dennoch ein Ergebnis liefert.

figurEinlesen

@API
public static Figur figurEinlesen(java.io.File file)

Liest eine Figur ein.

Parameters:

file - Verzeichnis der einzulesenden Datei.

Die Eingabe muss ein Dateiname mit dem Ende .eaf sein. Dies kann ohne Ordnerangaben gemacht werden, wenn die Datei im Quelltextordner ist.

Returns:

Eingelesene Figur.

Tritt ein Fehler auf, weil die Datei nicht einlesbar ist oder nicht existiert, ist dieser wert null.

Trotzdem kann es sein, dass eine beschädigte Datei nicht mehr korrekt einlesbar ist, dennoch ein Ergebnis liefert.

See Also:

figurLaden(String), figurEinlesen(String)

farbeEinlesen

public static java.awt.Color farbeEinlesen(java.lang.String s)

Liest einen String ein und konvertiert ihn zu einer Farbe.

Parameters:

s - zu konvertierender String

Returns:

Color-Objekt, das gelesen wurde.

null, wenn der String nicht eingelesen werden konnte!

ausListe

public static java.awt.Color ausListe(java.awt.Color farbe)

Die Listenmethode beim Figureinlesen und für das speicherarme Raum-Objekt-Färben.

Diese Methode wird verwendet um den Speicher zu entlasten, da Farbobjekte, die bereits in der Liste enthalten sind, nicht zurückgegeben werden, sondern durch den vorhandenen Farbewert ersetzt werden.

Somit hat jede Farbe beim Einlesen genau eine Instanz innerhalb der gesamten Engine.

Parameters:

farbe - Farbe, die auf Existenz in der Liste geprüft werden soll.

Returns:

Das zurückgegebene Farbobjekt ist vom Zustand her genau das selbe wie das Eingegebene.

Jedoch bleibt dank dieser Methode für jede Farbe nur ein Farbobjekt, was Speicherplatz spart.

figurEinlesen

@Deprecated
public static Figur figurEinlesen(java.lang.String verzeichnis,
                                              boolean relativ)

Deprecated.

Diese Methode ist veraltet, da ein Pfad automatisch relativ ist, wenn er nicht mit / (Linux) bzw. C: (Windows, andere Buchstaben ebenso möglich) beginnt.