-
- 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
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
25/11/2024 20:33:17 Cette version de la page est en cache (à la date du 25/11/2024 20:33:17) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/tools/fileobject.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.