Class StandardDocFileFactory.StandardDocFile

java.lang.Object

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

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.StandardDocFileFactory.StandardDocFile

Enclosing class:

StandardDocFileFactory

class StandardDocFileFactory.StandardDocFile
extends DocFile

Since:

1.8

Field Summary

Fields

Modifier and Type	Field	Description
private Path	file

Fields inherited from class DocFile

location, path

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StandardDocFile(Path file)	Create a StandardDocFile for a given file.
private	StandardDocFile(JavaFileManager.Location location, DocPath path)	Create a StandardDocFile for a given location and relative path.

Method Summary

Modifier and Type	Method	Description
boolean	canRead()	Return true if the file can be read.
boolean	canWrite()	Return true if the file can be written.
boolean	exists()	Return true if the file exists.
private FileObject	getFileObjectForOutput(DocPath path)
private JavaFileObject	getJavaFileObjectForInput(Path file)
String	getName()	Return the base name (last component) of the file name.
String	getPath()	Return the file system path for this file.
boolean	isAbsolute()	Return true is file has an absolute path name.
boolean	isDirectory()	Return true is file identifies a directory.
boolean	isFile()	Return true is file identifies a file.
boolean	isSameFile(DocFile other)	Return true if this file is the same as another.
Iterable<DocFile>	list()	If the file is a directory, list its contents.
boolean	mkdirs()	Create the file as a directory, including any parent directories.
InputStream	openInputStream()	Open an input stream for the file.
OutputStream	openOutputStream()	Open an output stream for the file.
Writer	openWriter()	Open an writer for the file, using the encoding (if any) given in the doclet configuration.
DocFile	resolve(DocPath p)	Derive a new file by resolving a relative path against this file.
DocFile	resolve(String p)	Derive a new file by resolving a relative path against this file.
DocFile	resolveAgainst(JavaFileManager.Location locn)	Resolve a relative file against the given output location.
String	toString()	Return a string to identify the contents of this object, for debugging purposes.

Methods inherited from class DocFile

copyFile, copyResource, createFileForDirectory, createFileForInput, createFileForOutput, list

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

file

private Path file

Constructor Details

StandardDocFile

private StandardDocFile(Path file)

Create a StandardDocFile for a given file.

StandardDocFile

private StandardDocFile(JavaFileManager.Location location,
 DocPath path)

Create a StandardDocFile for a given location and relative path.

Method Details

openInputStream

public InputStream openInputStream()
                            throws IOException

Open an input stream for the file.

Specified by:

openInputStream in class DocFile

Throws:

IOException

openOutputStream

public OutputStream openOutputStream()
                              throws IOException,
UnsupportedEncodingException

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.

Specified by:

openOutputStream in class DocFile

Throws:

IOException

UnsupportedEncodingException

openWriter

public Writer openWriter()
                  throws IOException,
UnsupportedEncodingException

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.

Specified by:

openWriter in class DocFile

Throws:

IOException

UnsupportedEncodingException

canRead

public boolean canRead()

Return true if the file can be read.

Specified by:

canRead in class DocFile

canWrite

public boolean canWrite()

Return true if the file can be written.

Specified by:

canWrite in class DocFile

exists

public boolean exists()

Return true if the file exists.

Specified by:

exists in class DocFile

getName

public String getName()

Return the base name (last component) of the file name.

Specified by:

getName in class DocFile

getPath

public String getPath()

Return the file system path for this file.

Specified by:

getPath in class DocFile

isAbsolute

public boolean isAbsolute()

Return true is file has an absolute path name.

Specified by:

isAbsolute in class DocFile

isDirectory

public boolean isDirectory()

Return true is file identifies a directory.

Specified by:

isDirectory in class DocFile

isFile

public boolean isFile()

Return true is file identifies a file.

Specified by:

isFile in class DocFile

isSameFile

public boolean isSameFile(DocFile other)

Return true if this file is the same as another.

Specified by:

isSameFile in class DocFile

list

public Iterable<DocFile> list()
                       throws IOException

If the file is a directory, list its contents.

Specified by:

list in class DocFile

Throws:

IOException

mkdirs

public boolean mkdirs()

Create the file as a directory, including any parent directories.

Specified by:

mkdirs in class DocFile

resolve

public DocFile resolve(DocPath p)

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.

Specified by:

resolve in class DocFile

resolve

public DocFile resolve(String p)

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.

Specified by:

resolve in class DocFile

resolveAgainst

public DocFile resolveAgainst(JavaFileManager.Location locn)

Resolve a relative file against the given output location.

Specified by:

resolveAgainst in class DocFile

Parameters:

locn - Currently, only

invalid reference

DocumentationTool.Location.DOCUMENTATION_OUTPUT

is supported.

toString

public String toString()

Return a string to identify the contents of this object, for debugging purposes.

Overrides:

toString in class Object

getJavaFileObjectForInput

private JavaFileObject getJavaFileObjectForInput(Path file)

getFileObjectForOutput

private FileObject getFileObjectForOutput(DocPath path)
                                   throws IOException

Throws:

IOException