java.lang.Object
   |
   +--java.io.File

Deklaration

Beschreibung

Konstruktoren
public	File(String pathname)
public	File(URI uri)
public	File(String path, String name)
public	File(File dir, String name)

Methoden
public boolean	canRead()
public boolean	canWrite()
public int	compareTo(File file)
public int	compareTo(Object o)
public boolean	createNewFile()
public static File	createTempFile(String prefix, String suffix)
public static File	createTempFile(String prefix, String suffix, File directory)
public boolean	delete()
public void	deleteOnExit()
public boolean	equals(Object obj)
public boolean	exists()
public File	getAbsoluteFile()
public String	getAbsolutePath()
public File	getCanonicalFile()
public String	getCanonicalPath()
public String	getName()
public String	getParent()
public File	getParentFile()
public String	getPath()
public int	hashCode()
public native boolean	isAbsolute()
public boolean	isDirectory()
public boolean	isFile()
public boolean	isHidden()
public long	lastModified()
public long	length()
public String[]	list()
public String[]	list(FilenameFilter filter)
public File[]	listFiles()
public File[]	listFiles(FilenameFilter filter)
public File[]	listFiles(FileFilter filter)
public static File[]	listRoots()
public boolean	mkdir()
public boolean	mkdirs()
public boolean	renameTo(File dest)
public boolean	setLastModified(long time)
public boolean	setReadOnly()
public String	toString()
public URI	toURI()
public URL	toURL()

Datenelemente im Detail

public static final String separator

Das Zeichen, mit dem die Verzeichnisnamen bei einer Pfadangabe getrennt werden, als String.

public static final char separatorChar

Das Zeichen, mit dem die Verzeichnisnamen bei einer Pfadangabe getrennt werden, als char.

public static final String pathSeparator

Das Zeichen, mit dem die einzelnen Pfade in der Umgebungsvariable CLASSPATH getrennt werden, als String.

public static final char pathSeparatorChar

Das Zeichen, mit dem die einzelnen Pfade in der Umgebungsvariable CLASSPATH getrennt werden, als char.

Konstruktoren im Detail

public File(String pathname)

Erzeugt ein neues File-Objekt, das mit dem String pathname initialisiert wird. pathname ist hierbei ein Datei- oder Verzeichnisname, dem eine Pfadangabe vorangestellt werden kann.

Exception: NullPointerException

• Falls pathname null ist.

public File(URI uri)     

Erzeugt ein neues File-Objekt, das mit der durch uri bezeichneten Datei ausgezeichnet wird. uri muss mit file: beginnen.

Exception: NullPointerException

• Falls uri null ist.

Exception: IllegalArgumentException

• Falls uri ungültig ist.

public File(String path, String name)

Erzeugt ein neues File-Objekt, das mit der Konkatenierung des Pfads path und des Dateinamens name initialisiert wird. Falls die Angabe von path nicht benötigt wird, kann für diesen Parameter null oder ein leerer String übergeben werden.

Exception: NullPointerException

• Falls name null ist.

public File(File dir, String name)

Erzeugt ein neues File-Objekt, das mit der Konkatenierung des Pfadanteils von dir und des Dateinamens name initialisiert wird.

Exception: NullPointerException

• Falls dir oder name den Wert null hat.

Methoden im Detail

public boolean canRead()

Liefert true, wenn für die Datei Leserecht besteht, sonst false.

public boolean canWrite()

Liefert true, wenn für die Datei Schreibrecht besteht, sonst false.

public int compareTo(File file)     

Vergleicht den Pfadnamen dieses Objekts mit dem von file. Der Rückgabewert ist null, wenn die Namen gleich sind. Er ist kleiner als null, wenn der Pfadname dieses Objekts lexikographisch kleiner als der von file ist. Der Rückgabewert ist größer als null, wenn der Pfadname dieses Objekts größer als file ist.

public int compareTo(Object o)     

Vergleicht den Wert dieses Objekts mit dem des Parameters o, für den ein File-Objekt übergeben werden muß. Der Rückgabewert ist null, wenn die Namen gleich sind. Er ist kleiner als null, wenn der Pfadname dieses Objekts lexikographisch kleiner als der von o ist. Der Rückgabewert ist größer als null, wenn der Pfadname dieses Objekts größer als o ist.

public boolean createNewFile()     

Erzeugt eine neue Datei mit dem Dateinamen des Objekts, falls eine Datei mit diesem Namen noch nicht existiert. Wenn es die Datei noch nicht gab und sie erfolgreich angelegt werden konnte, ist der Rückgabewert true, sonst false. Diese Methode entspricht einer atomaren test-and-set-Operation, so daß sie zur Realisierung dateibasierter Sperren verwendet werden kann. Falls ein SecurityManager gesetzt ist, wird zuvor geprüft, ob der aufrufende Thread die Berechtigung zum Schreiben von Dateien hat.

Exception: SecurityException

• Falls keine Berechtigung zum Erzeugen von Dateien besteht.

Exception: IOException

public static File createTempFile(String prefix, String suffix)     

Erzeugt eine neue temporäre Datei und liefert ein entsprechendes File-Objekt. Es wird sichergestellt, daß diese Methode während der Laufzeit immer verschiedene Dateien zurückliefert. Die Datei wird in dem plattformspezifischen Verzeichnis für temporäre Dateien erzeugt (z. B. /tmp unter UNIX oder c:\temp unter Windows). Der Name der Datei wird unter Verwendung des Präfix prefix und des Suffix suffix zusammengesetzt. prefix muß hierbei eine Mindestlänge von drei Zeichen aufweisen. Für suffix kann null übergeben werden, wodurch die Datei die Endung .tmp erhält. Falls ein SecurityManager gesetzt ist, wird zuvor geprüft, ob der aufrufende Thread die Berechtigung zum Anlegen und Schreiben der temporären Datei hat.

Exception: IllegalArgumentException

• Falls prefix kürzer als drei Zeichen ist.

Exception: IOException

public static File createTempFile(String prefix, String suffix, File directory)     

Bei dieser Variante kann mit directory zusätzlich ein Verzeichnis angegeben werden, in dem die temporären Datei erzeugt werden soll. Falls hierfür null übergeben wird, wird das plattformspezifischen Verzeichnis für temporäre Dateien verwendet, was der ersten Variante entspricht. Falls ein SecurityManager gesetzt ist, wird zuvor geprüft, ob der aufrufende Thread die Berechtigung zum Anlegen und Schreiben der temporären Datei hat.

Exception: IllegalArgumentException

• Falls prefix kürzer als drei Zeichen ist.

Exception: IOException

• Falls die temporäre Datei nicht erzeugt werden konnte (z. B. weil das Verzeichnis directory nicht existiert.

public boolean delete()

Löscht die bezeichnete Datei oder das Verzeichnis und liefert true zurück, wenn die Datei tatsächlich gelöscht werden konnte, sonst false.

public void deleteOnExit()     

Bewirkt, daß die Datei bei einer normalen Beendigung der Virtual Machine automatisch gelöscht wird. Der Aufruf dieser Methode ist irreversibel, d. h., die Anforderung zum Löschen kann nicht wieder rückgängig gemacht werden. Falls ein SecurityManager gesetzt ist, wird zuvor geprüft, ob der aufrufende Thread die Berechtigung zum Löschen temporärer Dateien hat.

public boolean equals(Object obj)

Liefert true, wenn obj ein Exemplar der Klasse File ist und die enthaltenen Pfad- und Dateinamen identisch sind, sonst false.

public boolean exists()

Liefert true, wenn eine Datei mit dem bezeichneten Pfad und Namen existiert, sonst false.

public File getAbsoluteFile()     

Falls der bezeichnete Pfad absolut ist, wird er zurückgegeben. Wenn das Objekt einen relativen Pfad enthält, wird die Verkettung der System-Property user.dir und des bezeichneten Pfads geliefert.

public String getAbsolutePath()

Falls der bezeichnete Pfad absolut ist, wird er zurückgegeben. Wenn das Objekt einen relativen Pfad enthält, wird die Verkettung der System-Property user.dir und des bezeichneten Pfads geliefert.

public File getCanonicalFile()     

Wie getAbsoluteFile(), nur daß diese Methode alle relativen Angaben (z. B. "..") auflöst und entfernt.

Exception: IOException

public String getCanonicalPath()     

Wie getAbsolutePath(), nur daß diese Methode alle relativen Angaben (z. B. "..") auflöst und entfernt.

Exception: IOException

public String getName()

Liefert den Dateinamen ohne den vorangestellten Pfad.

public String getParent()

Liefert das übergeordnete Verzeichnis des Pfadanteils oder null, falls der Pfadanteil das Hauptverzeichnis bezeichnet.

public File getParentFile()     

Liefert das übergeordnete Verzeichnis des Pfadanteils als File oder null, falls der Pfadanteil das Hauptverzeichnis bezeichnet.

public String getPath()

Liefert den Pfadanteil der bezeichneten Datei zurück.

public int hashCode()

Liefert einen Hashcode für das File-Objekt.

public native boolean isAbsolute()

Liefert true, wenn das Objekt einen absoluten Pfadnamen enthält, sonst false. Hierbei werden die Namenskonventionen der betreffenden Plattform zugrunde gelegt.

public boolean isDirectory()

Liefert true, wenn das Objekt ein Verzeichnis gemäß den Konventionen der Plattform bezeichnet, sonst false.

public boolean isFile()

Liefert true, wenn das Objekt eine reguläre Datei bezeichnet, sonst false.

public boolean isHidden()     

Liefert true, wenn die bezeichnete Datei versteckt ist, sonst false. Unter UNIX gilt eine Datei als versteckt, wenn ihr Name mit einem Punkt beginnt, und unter Windows dann, wenn das entsprechende Attribut der Datei gesetzt ist.

public long lastModified()

Liefert einen Wert, mit dem der Zeitpunkt der letzten Veränderung von Dateien verglichen werden kann. Der Rückgabewert ist plattformabhängig und soll nicht absolut interpretiert werden. Falls die bezeichnete Datei nicht existiert, ist der Rückgabewert null.

public long length()

Liefert die Größe der bezeichneten Datei in Bytes zurück. Bei Verzeichnissen ist der Wert abhängig vom Dateisystem (unter UNIX die iNode-Größe).

public String[] list()

Liefert ein String-Array, das alle Einträge (auch versteckte) im bezeichneten Verzeichnis enthält. Falls das Verzeichnis leer ist, wird ein Array der Länge null geliefert. Falls das Objekt eine Datei bezeichnet, wird null zurückgegeben.

public String[] list(FilenameFilter filter)

Liefert ein String-Array, das die Einträge im bezeichneten Verzeichnis enthält, die auf die in filter definierte Maske passen. Falls das Verzeichnis leer ist oder keine passende Datei enthält, wird ein Array der Länge null geliefert. Falls das Objekt eine Datei bezeichnet, wird null zurückgegeben.

public File[] listFiles()     

Liefert ein File-Array, das alle Einträge (auch versteckte) im bezeichneten Verzeichnis enthält. Falls das Verzeichnis leer ist, wird ein Array der Länge null geliefert. Falls das Objekt eine Datei bezeichnet oder ein Fehler aufgetreten ist, wird null zurückgegeben.

public File[] listFiles(FilenameFilter filter)     

Liefert ein File-Array, das die Einträge im bezeichneten Verzeichnis enthält, die auf die in filter definierte Maske passen. Durch die Angabe von null wird keine Selektion vorgenommen, Falls das Verzeichnis leer ist oder keine passende Datei enthält, wird ein Array der Länge null geliefert. Falls das Objekt eine Datei bezeichnet oder ein Fehler aufgetreten ist, wird null zurückgegeben.

public File[] listFiles(FileFilter filter)     

Bei dieser Variante wird eine FileFilter-Implementierung übergeben.

public static File[] listRoots()     

Liefert alle Wurzelverzeichnisse der Dateisysteme. Unter UNIX enthält das gelieferte Array genau einen Eintrag /, wohin gegen unter Windows für jedes Laufwerk ein Objekt geliefert wird.

public boolean mkdir()

Versucht, das bezeichnete Verzeichnis neu anzulegen, und liefert true, wenn das Verzeichnis erfolgreich angelegt werden konnte, sonst false.

public boolean mkdirs()

Versucht, alle im bezeichneten Pfad enthaltenen Verzeichnisse neu anzulegen, und liefert true, wenn alle Verzeichnisse erfolgreich angelegt werden konnten, sonst false.

public boolean renameTo(File dest)

Benennt die durch das Objekt bezeichnete Datei (oder das Verzeichnis) in dest um. Der Rückgabewert ist true, wenn die Umbenennung erfolgreich ausgeführt werden konnte, sonst false.

public boolean setLastModified(long time)     

Setzt das Datum der letzten Veränderung auf time Millisekunden seit dem 01.01.1970, 00.00h und liefert true, wenn das Datum erfolgreich geändert werden konnte, sonst false. Ein solcher Millisekunden-Aufruf kann aus einem Datum mit dem Aufruf get(MILLISECOND) von GregorianCalendar ermittelt werden.

public boolean setReadOnly()     

Nach dem Aufruf dieser Methode kann die bezeichnete Datei oder das Verzeichnis nur noch ausgelesen werden, Schreiboperationen sind nicht mehr möglich. Diese Methode stellt nur sicher, das die Datei nicht verändert werden kann. Ob das Löschen möglich ist, ist plattformabhängig. Falls die Methode erfolgreich ausgeführt werden konnte, ist der Rückgabewert true, sonst false. Falls ein SecurityManager gesetzt ist, wird zuvor geprüft, ob der aufrufende Thread die Berechtigung zum Schreiben der Datei hat.

public String toString()

Liefert durch einen Aufruf von getPath() den enthaltenen Pfad und Dateinamen zurück.

public URI toURI()     

Liefert einen file:/-URI für den bezeichneten Pfad zurück.

public URL toURL()     

Liefert eine file:/-URL für den bezeichneten Pfad zurück. Bei Verzeichnissen endet die URL mit /.

Exception: MalformedURLException