javax.tools

Interface FileObject

public interface FileObject

Abstraction for all kinds of file objects used by tools, e.g. regular files, memory cache, or database data.
Since:
1.6

Method Summary

boolean
delete()
Deletes this file object.
CharSequence
getCharContent(boolean ignoreEncodingErrors)
Returns the character content of the file, if available.
long
getLastModified()
Returns the time when the file was last modified.
String
getName()
Returns a name for this file object.
InputStream
openInputStream()
Opens this file for reading and returns an input stream.
OutputStream
openOutputStream()
Opens this file for writing and returns an output stream.
Reader
openReader(boolean ignoreEncodingErrors)
Opens this file for reading and returns a reader.
Writer
openWriter()
Opens this file for writer and returns a writer.
URI
toUri()
Returns a URI that represents this file object.

Method Details

delete

public boolean delete()
Deletes this file object. In case of errors this returns false.
Returns:
true when the file deletion was successful, false otherwise

getCharContent

public CharSequence getCharContent(boolean ignoreEncodingErrors)
            throws IOException
Returns the character content of the file, if available. Any byte that cannot be decoded will be replaced by the default replacement character. A diagnostic may be reported, unless ignoreEncodingErrors is true.
Parameters:
ignoreEncodingErrors - true when encoding errors should be ignored false otherwise
Returns:
the character content, or null if not available
Throws:
IOException - if an I/O error occurs

getLastModified

public long getLastModified()
Returns the time when the file was last modified. The time is measured like in System.currentTimeMillis().
Returns:
the time when the file was last modified

getName

public String getName()
Returns a name for this file object. The exact name is implementation dependent.
Returns:
a name for this file object

openInputStream

public InputStream openInputStream()
            throws IOException
Opens this file for reading and returns an input stream.
Returns:
an input stream to read this file object
Throws:
IOException - if an I/O error occured
IllegalStateException - if this file was opened for writing and does not support reading
UnsupportedOperationException - if this kind of file does not allow byte reading

openOutputStream

public OutputStream openOutputStream()
            throws IOException
Opens this file for writing and returns an output stream.
Returns:
an output stream for writing this file object
Throws:
IOException - if an I/O error occurs
IllegalStateException - if this file was opened for reading and does not support writing
UnsupportedOperationException - if this kind of file does not allow byte writing

openReader

public Reader openReader(boolean ignoreEncodingErrors)
            throws IOException
Opens this file for reading and returns a reader.
Parameters:
ignoreEncodingErrors - true when encoding errors should be ignored false otherwise
Returns:
a reader for reading this file object
Throws:
IOException - if an I/O error occurs
IllegalStateException - if this file was opened for writing and does not support reading
UnsupportedOperationException - if this kind of file does not allow character reading

openWriter

public Writer openWriter()
            throws IOException
Opens this file for writer and returns a writer.
Returns:
a writer for writing this file object
Throws:
IOException - if an I/O error occurs
IllegalStateException - if this file was opened for reading and does not support writing
UnsupportedOperationException - if this kind of file does not allow character writing

toUri

public URI toUri()
Returns a URI that represents this file object.
Returns:
a URI that represents this file object

FileObject.java -- Copyright (C) 2008 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.