-
- All Known Subinterfaces:
- JavaFileObject
- All Known Implementing Classes:
- ForwardingFileObject, ForwardingJavaFileObject, SimpleJavaFileObject
public interface FileObject
File abstraction for tools. In this context, file means an abstraction of regular files and other sources of data. For example, a file object can be used to represent regular files, memory cache, or data in databases.All methods in this interface might throw a SecurityException if a security exception occurs.
Unless explicitly allowed, all methods in this interface might throw a NullPointerException if given a
null
argument.- Since:
- 1.6
-
-
Method Summary
Methods Modifier and Type Method and Description boolean
delete()
Deletes this file object.CharSequence
getCharContent(boolean ignoreEncodingErrors)
Gets the character content of this file object, if available.long
getLastModified()
Gets the time this file object was last modified.String
getName()
Gets a user-friendly name for this file object.InputStream
openInputStream()
Gets an InputStream for this file object.OutputStream
openOutputStream()
Gets an OutputStream for this file object.Reader
openReader(boolean ignoreEncodingErrors)
Gets a reader for this object.Writer
openWriter()
Gets a Writer for this file object.URI
toUri()
Returns a URI identifying this file object.
-
-
-
Method Detail
-
toUri
URI toUri()
Returns a URI identifying this file object.- Returns:
- a URI
-
getName
String getName()
Gets a user-friendly name for this file object. The exact value returned is not specified but implementations should take care to preserve names as given by the user. For example, if the user writes the filename"BobsApp\Test.java"
on the command line, this method should return"BobsApp\Test.java"
whereas the toUri method might returnfile:///C:/Documents%20and%20Settings/UncleBob/BobsApp/Test.java
.- Returns:
- a user-friendly name
-
openInputStream
InputStream openInputStream() throws IOException
Gets an InputStream for this file object.- Returns:
- an InputStream
- Throws:
IllegalStateException
- if this file object was opened for writing and does not support readingUnsupportedOperationException
- if this kind of file object does not support byte accessIOException
- if an I/O error occurred
-
openOutputStream
OutputStream openOutputStream() throws IOException
Gets an OutputStream for this file object.- Returns:
- an OutputStream
- Throws:
IllegalStateException
- if this file object was opened for reading and does not support writingUnsupportedOperationException
- if this kind of file object does not support byte accessIOException
- if an I/O error occurred
-
openReader
Reader openReader(boolean ignoreEncodingErrors) throws IOException
Gets a reader for this object. The returned reader will replace bytes that cannot be decoded with the default translation character. In addition, the reader may report a diagnostic unlessignoreEncodingErrors
is true.- Parameters:
ignoreEncodingErrors
- ignore encoding errors if true- Returns:
- a Reader
- Throws:
IllegalStateException
- if this file object was opened for writing and does not support readingUnsupportedOperationException
- if this kind of file object does not support character accessIOException
- if an I/O error occurred
-
getCharContent
CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException
Gets the character content of this file object, if available. Any byte that cannot be decoded will be replaced by the default translation character. In addition, a diagnostic may be reported unlessignoreEncodingErrors
is true.- Parameters:
ignoreEncodingErrors
- ignore encoding errors if true- Returns:
- a CharSequence if available;
null
otherwise - Throws:
IllegalStateException
- if this file object was opened for writing and does not support readingUnsupportedOperationException
- if this kind of file object does not support character accessIOException
- if an I/O error occurred
-
openWriter
Writer openWriter() throws IOException
Gets a Writer for this file object.- Returns:
- a Writer
- Throws:
IllegalStateException
- if this file object was opened for reading and does not support writingUnsupportedOperationException
- if this kind of file object does not support character accessIOException
- if an I/O error occurred
-
getLastModified
long getLastModified()
Gets the time this file object was last modified. The time is measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970).- Returns:
- the time this file object was last modified; or 0 if the file object does not exist, if an I/O error occurred, or if the operation is not supported
-
delete
boolean delete()
Deletes this file object. In case of errors, returns false.- Returns:
- true if and only if this file object is successfully deleted; false otherwise
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/tools/fileobject.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.