APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.toolkit.util

public abstract Class DocFileFactory

extends Object
Class Inheritance
Known Direct Subclasses
jdk.javadoc.internal.doclets.toolkit.util.StandardDocFileFactory
Imports
java.nio.file.Path, javax.tools.JavaFileManager, .JavaFileManager.Location, .StandardJavaFileManager, .StandardLocation, jdk.javadoc.internal.doclets.toolkit.BaseConfiguration, .DocletException
Factory for DocFile objects.

Field Summary

Modifier and TypeField and Description
protected BaseConfiguration
configuration

Constructor Summary

AccessConstructor and Description
protected
DocFileFactory(BaseConfiguration configuration)

Method Summary

Modifier and TypeMethod and Description
pack-priv abstract DocFile
createFileForDirectory(String file)

Create a DocFile for a directory.

pack-priv abstract DocFile
createFileForInput(String file)

Create a DocFile for a file that will be opened for reading.

pack-priv abstract DocFile
createFileForInput(Path file)

Create a DocFile for a file that will be opened for reading.

pack-priv abstract DocFile
createFileForOutput(DocPath path)

Create a DocFile for a file that will be opened for writing.

public static synchronized DocFileFactory

Returns:

the factory associated with this configuration
getFactory(BaseConfiguration
the configuration for this doclet
configuration)

Get the appropriate factory, based on the file manager given in the configuration.

pack-priv abstract Iterable<DocFile>
list(JavaFileManager.Location
currently, only StandardLocation#SOURCE_PATH is supported.
location, DocPath
the subdirectory of the directories of the location for which to list files
path)

List the directories and files found in subdirectories along the elements of the given location.

public abstract void
setDestDir(String dir)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

configurationback to summary
protected BaseConfiguration configuration

Constructor Detail

DocFileFactoryback to summary
protected DocFileFactory(BaseConfiguration configuration)

Method Detail

createFileForDirectoryback to summary
pack-priv abstract DocFile createFileForDirectory(String file)

Create a DocFile for a directory.

createFileForInputback to summary
pack-priv abstract DocFile createFileForInput(String file)

Create a DocFile for a file that will be opened for reading.

createFileForInputback to summary
pack-priv abstract DocFile createFileForInput(Path file)

Create a DocFile for a file that will be opened for reading.

createFileForOutputback to summary
pack-priv abstract DocFile createFileForOutput(DocPath path)

Create a DocFile for a file that will be opened for writing.

getFactoryback to summary
public static synchronized DocFileFactory getFactory(BaseConfiguration configuration)

Get the appropriate factory, based on the file manager given in the configuration.

Parameters
configuration:BaseConfiguration

the configuration for this doclet

Returns:DocFileFactory

the factory associated with this configuration

listback to summary
pack-priv abstract Iterable<DocFile> list(JavaFileManager.Location location, DocPath path)

List the directories and files found in subdirectories along the elements of the given location.

Parameters
location:JavaFileManager.Location

currently, only StandardLocation#SOURCE_PATH is supported.

path:DocPath

the subdirectory of the directories of the location for which to list files

setDestDirback to summary
public abstract void setDestDir(String dir) throws DocletException