xjavadoc.filesystem
Interface AbstractFile

All Known Implementing Classes:
ReaderFile, XJavadocFile

public interface AbstractFile

An interface that allows XJavadoc to read and write from any source/destination and not just files.

Author:
Dmitri Colebatch

Method Summary
 java.io.OutputStream getOutputStream()
          Get an outputstream for the file.
 java.lang.String getPath()
           
 java.io.Reader getReader()
          Obtain a reader for the file.
 java.io.Reader getReader(java.lang.String enc)
           
 java.io.Writer getWriter()
          Obtain a writer for the file.
 boolean isWriteable()
          Determine if the file is writeable or not.
 long lastModified()
          Get the last modified timestamp of the file, or 0 if not available.
 

Method Detail

getReader

java.io.Reader getReader()
                         throws java.io.IOException
Obtain a reader for the file.

Returns:
Throws:
java.io.IOException

getWriter

java.io.Writer getWriter()
                         throws java.io.IOException
Obtain a writer for the file.

Returns:
Throws:
java.io.IOException

isWriteable

boolean isWriteable()
Determine if the file is writeable or not.

Returns:

lastModified

long lastModified()
Get the last modified timestamp of the file, or 0 if not available.

Returns:

getOutputStream

java.io.OutputStream getOutputStream()
                                     throws java.io.IOException
Get an outputstream for the file.

Returns:
Throws:
java.io.IOException

getPath

java.lang.String getPath()

getReader

java.io.Reader getReader(java.lang.String enc)
                         throws java.io.UnsupportedEncodingException,
                                java.io.FileNotFoundException
Parameters:
encoding -
Returns:
Throws:
java.io.UnsupportedEncodingException
java.io.FileNotFoundException