Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util

Class DocFile

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.DocFile
Direct Known Subclasses:
StandardDocFileFactory.StandardDocFile
@Deprecated public abstract class DocFile extends Object
Deprecated.
Abstraction for handling files, which may be specified directly (e.g. via a path on the command line) or relative to a Location.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Since:
8

  • Field Details

    • configuration

      private final Configuration configuration
      Deprecated.

    • location

      protected final JavaFileManager.Location location
      Deprecated.
      The location for this file. Maybe null if the file was created without a location or path.

    • path

      protected final DocPath path
      Deprecated.
      The path relative to the (output) location. Maybe null if the file was created without a location or path.

  • Constructor Details

    • DocFile

      protected DocFile(Configuration configuration)
      Deprecated.
      Create a DocFile without a location or path

    • DocFile

      protected DocFile(Configuration configuration, JavaFileManager.Location location, DocPath path)
      Deprecated.
      Create a DocFile for a given location and relative path.

  • Method Details

    • createFileForDirectory

      public static DocFile createFileForDirectory(Configuration configuration, String file)
      Deprecated.
      Create a DocFile for a directory.

    • createFileForInput

      public static DocFile createFileForInput(Configuration configuration, String file)
      Deprecated.
      Create a DocFile for a file that will be opened for reading.

    • createFileForOutput

      public static DocFile createFileForOutput(Configuration configuration, DocPath path)
      Deprecated.
      Create a DocFile for a file that will be opened for writing.

    • list

      public static Iterable<DocFile> list(Configuration configuration, JavaFileManager.Location location, DocPath path)
      Deprecated.
      List the directories and files found in subdirectories along the elements of the given location.
      Parameters:
      configuration - the doclet configuration
      location - currently, only StandardLocation.SOURCE_PATH is supported.
      path - the subdirectory of the directories of the location for which to list files

    • openInputStream

      public abstract InputStream openInputStream() throws IOException
      Deprecated.
      Open an input stream for the file.
      Throws:
      IOException

    • openOutputStream

      public abstract OutputStream openOutputStream() throws IOException, UnsupportedEncodingException
      Deprecated.
      Open an output stream for the file. The file must have been created with a location of DocumentationTool.Location#DOCUMENTATION_OUTPUT and a corresponding relative path.
      Throws:
      IOException
      UnsupportedEncodingException

    • openWriter

      public abstract Writer openWriter() throws IOException, UnsupportedEncodingException
      Deprecated.
      Open an writer for the file, using the encoding (if any) given in the doclet configuration. The file must have been created with a location of DocumentationTool.Location#DOCUMENTATION_OUTPUT and a corresponding relative path.
      Throws:
      IOException
      UnsupportedEncodingException

    • copyFile

      public void copyFile(DocFile fromFile) throws IOException
      Deprecated.
      Copy the contents of another file directly to this file.
      Throws:
      IOException

    • copyResource

      public void copyResource(DocPath resource, boolean overwrite, boolean replaceNewLine)
      Deprecated.
      Copy the contents of a resource file to this file.
      Parameters:
      resource - the path of the resource, relative to the package of this class
      overwrite - whether or not to overwrite the file if it already exists
      replaceNewLine - if false, the file is copied as a binary file; if true, the file is written line by line, using the platform line separator

    • canRead

      public abstract boolean canRead()
      Deprecated.
      Return true if the file can be read.

    • canWrite

      public abstract boolean canWrite()
      Deprecated.
      Return true if the file can be written.

    • exists

      public abstract boolean exists()
      Deprecated.
      Return true if the file exists.

    • getName

      public abstract String getName()
      Deprecated.
      Return the base name (last component) of the file name.

    • getPath

      public abstract String getPath()
      Deprecated.
      Return the file system path for this file.

    • isAbsolute

      public abstract boolean isAbsolute()
      Deprecated.
      Return true if file has an absolute path name.

    • isDirectory

      public abstract boolean isDirectory()
      Deprecated.
      Return true if file identifies a directory.

    • isFile

      public abstract boolean isFile()
      Deprecated.
      Return true if file identifies a file.

    • isSameFile

      public abstract boolean isSameFile(DocFile other)
      Deprecated.
      Return true if this file is the same as another.

    • list

      public abstract Iterable<DocFile> list() throws IOException
      Deprecated.
      If the file is a directory, list its contents.
      Throws:
      IOException

    • mkdirs

      public abstract boolean mkdirs()
      Deprecated.
      Create the file as a directory, including any parent directories.

    • resolve

      public abstract DocFile resolve(DocPath p)
      Deprecated.
      Derive a new file by resolving a relative path against this file. The new file will inherit the configuration and location of this file If this file has a path set, the new file will have a corresponding new path.

    • resolve

      public abstract DocFile resolve(String p)
      Deprecated.
      Derive a new file by resolving a relative path against this file. The new file will inherit the configuration and location of this file If this file has a path set, the new file will have a corresponding new path.

    • resolveAgainst

      public abstract DocFile resolveAgainst(JavaFileManager.Location locn)
      Deprecated.
      Resolve a relative file against the given output location.
      Parameters:
      locn - Currently, only DocumentationTool.Location#DOCUMENTATION_OUTPUT is supported.