Modifier and Type	Class and Description
pack-priv class	StandardDocFileFactory.StandardDocFile

Modifier and Type	Field and Description
private Path	destDir
private final StandardJavaFileManager	fileManager

Access	Constructor and Description
public	StandardDocFileFactory(BaseConfiguration configuration)

Modifier and Type	Method and Description
public DocFile	createFileForDirectory(String file) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForDirectory. Create a DocFile for a directory.
public DocFile	createFileForInput(String file) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForInput. Create a DocFile for a file that will be opened for reading.
public DocFile	createFileForInput(Path file) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForInput. Create a DocFile for a file that will be opened for reading.
public DocFile	createFileForOutput(DocPath path) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForOutput. Create a DocFile for a file that will be opened for writing.
private Path	getDestDir()
pack-priv Iterable<DocFile>	list(JavaFileManager.Location location, DocPath path) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.list. List the directories and files found in subdirectories along the elements of the given location.
private static Path	newFile(Path dir, String path)
public void	setDestDir(String destDirName) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.setDestDir.

destDir	back to summary
private Path destDir

fileManager	back to summary
private final StandardJavaFileManager fileManager

StandardDocFileFactory	back to summary
public StandardDocFileFactory(BaseConfiguration configuration)

createFileForDirectory	back to summary
public DocFile createFileForDirectory(String file) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForDirectory. Doc from jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForDirectory. Create a DocFile for a directory. Annotations @Override

createFileForInput	back to summary
public DocFile createFileForInput(String file) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForInput. Doc from jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForInput. Create a DocFile for a file that will be opened for reading. Annotations @Override

createFileForInput	back to summary
public DocFile createFileForInput(Path file) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForInput. Doc from jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForInput. Create a DocFile for a file that will be opened for reading. Annotations @Override

createFileForOutput	back to summary
public DocFile createFileForOutput(DocPath path) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForOutput. Doc from jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.createFileForOutput. Create a DocFile for a file that will be opened for writing. Annotations @Override

getDestDir	back to summary
private Path getDestDir()

list	back to summary
pack-priv Iterable<DocFile> list(JavaFileManager.Location location, DocPath path) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.list. Doc from jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.list. List the directories and files found in subdirectories along the elements of the given location. Annotations @Override

newFile	back to summary
private static Path newFile(Path dir, String path)

setDestDir	back to summary
public void setDestDir(String destDirName) throws SimpleDocletException Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory.setDestDir. Annotations @Override

jdk.javadoc.internal.doclets.toolkit.util back to summary

pack-priv Class StandardDocFileFactory.StandardDocFile

Class Inheritance

java.lang.Object
jdk.javadoc.internal.doclets.toolkit.util.DocFile
jdk.javadoc.internal.doclets.toolkit.util.StandardDocFileFactory.StandardDocFile

Field Summary

Modifier and Type	Field and Description
private final Path	file

Inherited from jdk.javadoc.internal.doclets.toolkit.util.DocFile:: location path PLATFORM_LINE_SEPARATOR

Constructor Summary

Access	Constructor and Description
pack-priv	StandardDocFile(Path file) Create a StandardDocFile for a given file.
pack-priv	StandardDocFile(JavaFileManager.Location location, DocPath path) Create a StandardDocFile for a given location and relative path.

Method Summary

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

Inherited from jdk.javadoc.internal.doclets.toolkit.util.DocFile:: copyFile copyResource copyResource copyResource createFileForDirectory createFileForInput createFileForInput createFileForOutput list

Field Detail

file	back to summary
private final Path file

Constructor Detail

StandardDocFile	back to summary
pack-priv StandardDocFile(Path file) Create a StandardDocFile for a given file.

StandardDocFile	back to summary
pack-priv StandardDocFile(JavaFileManager.Location location, DocPath path) Create a StandardDocFile for a given location and relative path.

Method Detail

canRead	back to summary
public boolean canRead() Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.canRead. Return true if the file can be read. Annotations @Override

canRead

back to summary

public boolean canRead()

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.canRead.

Return true if the file can be read.

Annotations

@Override

canWrite	back to summary
public boolean canWrite() Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.canWrite. Return true if the file can be written. Annotations @Override

canWrite

back to summary

public boolean canWrite()

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.canWrite.

Return true if the file can be written.

Annotations

@Override

exists	back to summary
public boolean exists() Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.exists. Return true if the file exists. Annotations @Override

exists

back to summary

public boolean exists()

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.exists.

Return true if the file exists.

Annotations

@Override

getFileObject	back to summary
public FileObject getFileObject() Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.getFileObject. Doc from jdk.javadoc.internal.doclets.toolkit.util.DocFile.getFileObject. Returns a file object for the file. Annotations @Override

getFileObject

back to summary

public FileObject getFileObject()

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.getFileObject.

Doc from jdk.javadoc.internal.doclets.toolkit.util.DocFile.getFileObject.

Returns a file object for the file.

Annotations

@Override

getFileObjectForOutput	back to summary
private FileObject getFileObjectForOutput(DocPath path) throws IOException

getJavaFileObjectForInput	back to summary
private JavaFileObject getJavaFileObjectForInput(Path file)

getName	back to summary
public String getName() Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.getName. Return the base name (last component) of the file name. Annotations @Override

getName

back to summary

public String getName()

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.getName.

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

Annotations

@Override

getPath	back to summary
public String getPath() Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.getPath. Return the file system path for this file. Annotations @Override

getPath

back to summary

public String getPath()

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.getPath.

Return the file system path for this file.

Annotations

@Override

isAbsolute	back to summary
public boolean isAbsolute() Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.isAbsolute. Return true is file has an absolute path name. Annotations @Override

isAbsolute

back to summary

public boolean isAbsolute()

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.isAbsolute.

Return true is file has an absolute path name.

Annotations

@Override

isDirectory	back to summary
public boolean isDirectory() Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.isDirectory. Return true is file identifies a directory. Annotations @Override

isDirectory

back to summary

public boolean isDirectory()

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.isDirectory.

Return true is file identifies a directory.

Annotations

@Override

isFile	back to summary
public boolean isFile() Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.isFile. Return true is file identifies a file. Annotations @Override

isFile

back to summary

public boolean isFile()

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.isFile.

Return true is file identifies a file.

Annotations

@Override

isSameFile	back to summary
public boolean isSameFile(DocFile other) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.isSameFile. Return true if this file is the same as another. Annotations @Override

isSameFile

back to summary

public boolean isSameFile(DocFile other)

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.isSameFile.

Return true if this file is the same as another.

Annotations

@Override

list	back to summary
public Iterable<DocFile> list() throws DocFileIOException Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.list. If the file is a directory, list its contents. Annotations @Override Exceptions DocFileIOException: Doc from jdk.javadoc.internal.doclets.toolkit.util.DocFile.list. if there is a problem while listing the directory

list

back to summary

public Iterable<DocFile> list() throws DocFileIOException

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.list.

If the file is a directory, list its contents.

Annotations

@Override

Exceptions

DocFileIOException:

Doc from jdk.javadoc.internal.doclets.toolkit.util.DocFile.list.

if there is a problem while listing the directory

mkdirs	back to summary
public boolean mkdirs() Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.mkdirs. Create the file as a directory, including any parent directories. Annotations @Override

mkdirs

back to summary

public boolean mkdirs()

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.mkdirs.

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

Annotations

@Override

openInputStream	back to summary
public InputStream openInputStream() throws DocFileIOException Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.openInputStream. Open an input stream for the file. Annotations @Override Exceptions DocFileIOException: if there is a problem while opening stream

openInputStream

back to summary

public InputStream openInputStream() throws DocFileIOException

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.openInputStream.

Open an input stream for the file.

Annotations

@Override

Exceptions

DocFileIOException:: if there is a problem while opening stream

openOutputStream back to summary

openOutputStream	back to summary
public OutputStream openOutputStream() throws DocFileIOException Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.openOutputStream. 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. Annotations @Override Exceptions DocFileIOException: if there is a problem while opening stream

public OutputStream openOutputStream() throws DocFileIOException

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.openOutputStream.

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.

Annotations

@Override

Exceptions

DocFileIOException:: if there is a problem while opening stream

openWriter back to summary

openWriter	back to summary
public Writer openWriter() throws DocFileIOException, UnsupportedEncodingException Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.openWriter. 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. Annotations @Override Exceptions DocFileIOException: if there is a problem while opening stream UnsupportedEncodingException: if the configured encoding is not supported

public Writer openWriter() throws DocFileIOException, UnsupportedEncodingException

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.openWriter.

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.

Annotations

@Override

Exceptions

DocFileIOException:: if there is a problem while opening stream
UnsupportedEncodingException:: if the configured encoding is not supported

resolve	back to summary
public DocFile resolve(DocPath p) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.resolve. 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. Annotations @Override

resolve

back to summary

public DocFile resolve(DocPath p)

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.resolve.

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.

Annotations

@Override

resolve	back to summary
public DocFile resolve(String p) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.resolve. 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. Annotations @Override

resolve

back to summary

public DocFile resolve(String p)

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.resolve.

Annotations

@Override

resolveAgainst back to summary

resolveAgainst	back to summary
public DocFile resolveAgainst(JavaFileManager.Location locn) Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.resolveAgainst. Resolve a relative file against the given output location. Parameters locn:JavaFileManager.Location Currently, only `DocumentationTool.Location#DOCUMENTATION_OUTPUT` is supported. Annotations @Override

public DocFile resolveAgainst(JavaFileManager.Location locn)

Implements abstract jdk.javadoc.internal.doclets.toolkit.util.DocFile.resolveAgainst.

Resolve a relative file against the given output location.

Parameters

locn:JavaFileManager.Location: Currently, only DocumentationTool.Location#DOCUMENTATION_OUTPUT is supported.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return a string to identify the contents of this object, for debugging purposes. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

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

Annotations

@Override

pack-priv Class StandardDocFileFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class StandardDocFileFactory.StandardDocFile

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail