de.guibuilder.framework
Class GuiFile

java.lang.Object
  extended by de.guibuilder.framework.GuiFile

public class GuiFile
extends java.lang.Object

GuiFile Objekte dienen als Schnittstelle zwischen interner und externer Repräsentation einer GDL-Beschreibung. Die assoziierte Datei kann mit verschiedenen Methoden gelesen werden.
GuiFile objects works as interface between internal and external representation of a GDL description. The associated file can be read using several methods
Z. Zt. werden folgende Methoden unterstützt:
The following methods are actually supported:

Author:
bubi

Constructor Summary
GuiFile(java.lang.String myFilename)
          Erzeugt ein neues GuiFile Objekt aus der Datei, die durch filename bezeichnet ist.
GuiFile(java.lang.String myFilename, java.lang.String encoding)
          Erzeugt ein neues GuiFile Objekt aus der Datei, die durch filename bezeichnet ist.
 
Method Summary
 void close()
          Schliesst die Datei.
static java.lang.String getDefaultEncoding()
          Antwortet mit der aktuellen Buchstabenkodierung.
 java.lang.String getEncoding()
          Antwortet mit der aktuellen Buchstabenkodierung des GuiFile Objektes.
static void setDefaultEncoding(java.lang.String myEncoding)
          Setzt die Standard-Buchstabenkodierung f¨r GuiFile Objekte.
 void setEncoding(java.lang.String encoding)
          Setzt die Buchstabenkodierung f¨r ein konkretes GuiFile Objekt.
 electric.xml.Document toDocument()
          Antwortet mit der electric.xml.Dokument Repräsentation des GuiFile Objektes.
 java.lang.String toString()
          Antwortet mit der String Repräsentation des GuiFile Objektes.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GuiFile

public GuiFile(java.lang.String myFilename)
        throws java.io.IOException
Erzeugt ein neues GuiFile Objekt aus der Datei, die durch filename bezeichnet ist.
Creates a new GuiFile Object from the Resource specified by filename .

Parameters:
myFilename - Der Name der Datei. the name of the file.
Throws:
java.io.IOException - Wenn URL unkorrekt (MalformedUrlException), wenn Datei nicht gefunden (FileNotFoundException) oder wenn sonstige E/A Fehler auftreten (IOException). If URL malformed (MalformedUrlException), if file not found (FileNotFoundException) or other I/O errors occur (IOException).

GuiFile

public GuiFile(java.lang.String myFilename,
               java.lang.String encoding)
        throws java.nio.charset.IllegalCharsetNameException,
               java.io.IOException
Erzeugt ein neues GuiFile Objekt aus der Datei, die durch filename bezeichnet ist. Es wird die Buchstabenkodierung encoding angenommen. Encoding muss eine unterstützte Buchstabenkodierung sein.
Creates a new GuiFile Object from the Resource specified by filename .

Parameters:
myFilename - Der Name der Datei. the name of the file.
encoding - Die Buchstabenkodierung der Datei. The charset encoding
Throws:
java.io.IOException - Wenn URL unkorrekt (MalformedUrlException), wenn Datei nicht gefunden (FileNotFoundException) oder wenn sonstige E/A Fehler auftreten (IOException). If URL malformed (MalformedUrlException), if file not found (FileNotFoundException) or other I/O errors occur (IOException).
java.nio.charset.IllegalCharsetNameException - Wenn encoding keine unterstützte Buchstabenkodierung ist.
If encoding is a not supported charset
Method Detail

getEncoding

public java.lang.String getEncoding()
Antwortet mit der aktuellen Buchstabenkodierung des GuiFile Objektes.
returns the actual character encoding for this GuiFile object.

Returns:
Die Buchstabenkodierung. Returns the encoding.

setEncoding

public void setEncoding(java.lang.String encoding)
                 throws java.nio.charset.IllegalCharsetNameException
Setzt die Buchstabenkodierung f¨r ein konkretes GuiFile Objekt. Dies kann notwendig werden, wenn die Buchstabenkodierung nicht aus der Datei selbst (XML) gelesen werden kann.
sets the character encoding (the charset) for the concret GuiFile object manually. This may be necessary, if the encoding is not given within the file it self (as it is in XML).

Parameters:
encoding - Name der Buchstabenkodierung. The encoding to set.
Throws:
java.nio.charset.IllegalCharsetNameException
See Also:
Charset, IllegalCharsetNameException

getDefaultEncoding

public static java.lang.String getDefaultEncoding()
Antwortet mit der aktuellen Buchstabenkodierung.
returns the actual character encoding for this GuiFile object.

Returns:
Die Buchstabenkodierung.
Returns the encoding.

setDefaultEncoding

public static void setDefaultEncoding(java.lang.String myEncoding)
                               throws java.nio.charset.IllegalCharsetNameException
Setzt die Standard-Buchstabenkodierung f¨r GuiFile Objekte.
sets the default character encoding (the charset) for the GuiFile objects.

Parameters:
myEncoding - Name der Buchstabenkodierung.
encoding The encoding to set.
Throws:
java.nio.charset.IllegalCharsetNameException
See Also:
Charset, IllegalCharsetNameException

close

public void close()
           throws java.io.IOException
Schliesst die Datei.
Closes the file

Throws:
java.io.IOException

toString

public java.lang.String toString()
Antwortet mit der String Repräsentation des GuiFile Objektes.
returns the String representation of the GuiFile object.

Overrides:
toString in class java.lang.Object
Returns:
String-Repräsentation des GuiFile Objektes.
String, which represents the content of the file.

toDocument

public electric.xml.Document toDocument()
                                 throws electric.xml.ParseException,
                                        java.io.IOException
Antwortet mit der electric.xml.Dokument Repräsentation des GuiFile Objektes.
returns the electric.xml.Document representation for the GuiFile object.

Returns:
Dokument, welches das GuiFile Objekt Repräsentiert.
Document which represents the content of the file.
Throws:
electric.xml.ParseException
java.io.IOException