Module java.compiler
Package javax.tools

Class ForwardingFileObject<F extends FileObject>

  • Type Parameters:
    F - the kind of file object forwarded to by this object
    All Implemented Interfaces:
    FileObject
    Direct Known Subclasses:
    ForwardingJavaFileObject

    public class ForwardingFileObject<F extends FileObject>
extends Object
implements FileObject
    Forwards calls to a given file object. Subclasses of this class might override some of these methods and might also provide additional fields and methods.
    Since:
    1.6

    • Field Detail

      • fileObject

        protected final F extends FileObject fileObject
        The file object which all methods are delegated to.

    • Constructor Detail

      • ForwardingFileObject

        protected ForwardingFileObject​(F fileObject)
        Creates a new instance of ForwardingFileObject.
        Parameters:
        fileObject - delegate to this file object

    • Method Detail

      • toUri

        public URI toUri​()
        Description copied from interface: FileObject
        Returns a URI identifying this file object.
        Specified by:
        toUri in interface FileObject
        Returns:
        a URI

      • getName

        public String getName​()
        Description copied from interface: FileObject
        Returns 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 return file:///C:/Documents%20and%20Settings/UncleBob/BobsApp/Test.java.
        Specified by:
        getName in interface FileObject
        Returns:
        a user-friendly name

      • openReader

        public Reader openReader​(boolean ignoreEncodingErrors)
                  throws IOException
        Description copied from interface: FileObject
        Returns 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 unless ignoreEncodingErrors is true.
        Specified by:
        openReader in interface FileObject
        Parameters:
        ignoreEncodingErrors - ignore encoding errors if true
        Returns:
        a Reader
        Throws:
        IllegalStateException - if this file object was opened for writing and does not support reading
        UnsupportedOperationException - if this kind of file object does not support character access
        IOException - if an I/O error occurred

      • getCharContent

        public CharSequence getCharContent​(boolean ignoreEncodingErrors)
                            throws IOException
        Description copied from interface: FileObject
        Returns 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 unless ignoreEncodingErrors is true.
        Specified by:
        getCharContent in interface FileObject
        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 reading
        UnsupportedOperationException - if this kind of file object does not support character access
        IOException - if an I/O error occurred

      • getLastModified

        public long getLastModified​()
        Description copied from interface: FileObject
        Returns the time this file object was last modified. The time is measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970).
        Specified by:
        getLastModified in interface FileObject
        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

        public boolean delete​()
        Description copied from interface: FileObject
        Deletes this file object. In case of errors, returns false.
        Specified by:
        delete in interface FileObject
        Returns:
        true if and only if this file object is successfully deleted; false otherwise