Package org.jdrupes.mdoclet.internal.doclets.toolkit.util

Klasse DocFile

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.util.DocFile

public abstract class DocFile
extends Object

Abstraction for handling files, which may be specified directly (e.g. via a path on the command line) or relative to a Location.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final JavaFileManager.Location	location	The location for this file.
protected final DocPath	path	The path relative to the (output) location.
static final String	PLATFORM_LINE_SEPARATOR	The line separator for the current platform.

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	DocFile()	Create a DocFile without a location or path
protected	DocFile(JavaFileManager.Location location, DocPath path)	Create a DocFile for a given location and relative path.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
abstract boolean	canRead()	Return true if the file can be read.
abstract boolean	canWrite()	Return true if the file can be written.
void	copyFile(DocFile fromFile)	Copy the contents of another file directly to this file.
void	copyResource(DocPath resource, boolean overwrite, boolean replaceNewLine)	Copy the contents of a resource file to this file.
void	copyResource(DocPath resource, Resources resources)	Copy the contents of a resource file to this file.
static DocFile	createFileForDirectory(BaseConfiguration configuration, String file)	Create a DocFile for a directory.
static DocFile	createFileForInput(BaseConfiguration configuration, String file)	Create a DocFile for a file that will be opened for reading.
static DocFile	createFileForInput(BaseConfiguration configuration, Path file)	Create a DocFile for a file that will be opened for reading.
static DocFile	createFileForOutput(BaseConfiguration configuration, DocPath path)	Create a DocFile for a file that will be opened for writing.
abstract boolean	exists()	Return true if the file exists.
abstract FileObject	getFileObject()	Returns a file object for the file.
abstract String	getName()	Return the base name (last component) of the file name.
abstract String	getPath()	Return the file system path for this file.
abstract boolean	isAbsolute()	Return true if file has an absolute path name.
abstract boolean	isDirectory()	Return true if file identifies a directory.
abstract boolean	isFile()	Return true if file identifies a file.
abstract boolean	isSameFile(DocFile other)	Return true if this file is the same as another.
abstract Iterable<DocFile>	list()	If the file is a directory, list its contents.
static Iterable<DocFile>	list(BaseConfiguration configuration, JavaFileManager.Location location, DocPath path)	List the directories and files found in subdirectories along the elements of the given location.
abstract boolean	mkdirs()	Create the file as a directory, including any parent directories.
abstract InputStream	openInputStream()	Open an input stream for the file.
abstract OutputStream	openOutputStream()	Open an output stream for the file.
abstract Writer	openWriter()	Open an writer for the file, using the encoding (if any) given in the doclet configuration.
abstract DocFile	resolve(String p)	Derive a new file by resolving a relative path against this file.
abstract DocFile	resolve(DocPath p)	Derive a new file by resolving a relative path against this file.
abstract DocFile	resolveAgainst(JavaFileManager.Location locn)	Resolve a relative file against the given output location.

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

PLATFORM_LINE_SEPARATOR

public static final String PLATFORM_LINE_SEPARATOR

The line separator for the current platform.

Use this when writing to external files.

location

protected final JavaFileManager.Location location

The location for this file.

Maybe null if the file was created without a location or path.

path

protected final DocPath path

The path relative to the (output) location.

Maybe null if the file was created without a location or path.

Konstruktordetails

DocFile

protected DocFile()

Create a DocFile without a location or path

DocFile

protected DocFile(JavaFileManager.Location location,
 DocPath path)

Create a DocFile for a given location and relative path.

Methodendetails

createFileForDirectory

public static DocFile createFileForDirectory(BaseConfiguration configuration,
 String file)

Create a DocFile for a directory.

createFileForInput

public static DocFile createFileForInput(BaseConfiguration configuration,
 String file)

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

createFileForInput

public static DocFile createFileForInput(BaseConfiguration configuration,
 Path file)

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

createFileForOutput

public static DocFile createFileForOutput(BaseConfiguration configuration,
 DocPath path)

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

list

public static Iterable<DocFile> list(BaseConfiguration configuration,
 JavaFileManager.Location location,
 DocPath path)

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

Parameter:

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

getFileObject

public abstract FileObject getFileObject()

Returns a file object for the file.

Gibt zurück:

a file object

openInputStream

public abstract InputStream openInputStream()
                                     throws DocFileIOException

Open an input stream for the file.

Gibt zurück:

an open input stream for the file

Löst aus:

DocFileIOException - if there is a problem opening the stream

openOutputStream

public abstract OutputStream openOutputStream()
                                       throws DocFileIOException,
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.

Gibt zurück:

an open output stream for the file

Löst aus:

DocFileIOException - if there is a problem opening the stream

UnsupportedEncodingException - if the configured encoding is not supported

openWriter

public abstract Writer openWriter()
                           throws DocFileIOException,
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.

Gibt zurück:

an open output stream for the file

Löst aus:

DocFileIOException - if there is a problem opening the stream

UnsupportedEncodingException - if the configured encoding is not supported

copyFile

public void copyFile(DocFile fromFile)
              throws DocFileIOException

Copy the contents of another file directly to this file.

Parameter:

fromFile - the file to be copied

Löst aus:

DocFileIOException - if there is a problem file copying the file

copyResource

public void copyResource(DocPath resource,
 boolean overwrite,
 boolean replaceNewLine)
                  throws DocFileIOException,
ResourceIOException

Copy the contents of a resource file to this file.

Parameter:

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

Löst aus:

DocFileIOException - if there is a problem while writing the copy

ResourceIOException - if there is a problem while reading the resource

copyResource

public void copyResource(DocPath resource,
 Resources resources)
                  throws DocFileIOException,
ResourceIOException

Copy the contents of a resource file to this file.

Parameter:

resource - the path of the resource, relative to the package of this class

resources - if not null, substitute occurrences of ##REPLACE:key##

Löst aus:

DocFileIOException - if there is a problem while writing the copy

ResourceIOException - if there is a problem while reading the resource

canRead

public abstract boolean canRead()

Return true if the file can be read.

canWrite

public abstract boolean canWrite()

Return true if the file can be written.

exists

public abstract boolean exists()

Return true if the file exists.

getName

public abstract String getName()

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

getPath

public abstract String getPath()

Return the file system path for this file.

isAbsolute

public abstract boolean isAbsolute()

Return true if file has an absolute path name.

isDirectory

public abstract boolean isDirectory()

Return true if file identifies a directory.

isFile

public abstract boolean isFile()

Return true if file identifies a file.

isSameFile

public abstract boolean isSameFile(DocFile other)

Return true if this file is the same as another.

list

public abstract Iterable<DocFile> list()
                                throws DocFileIOException

If the file is a directory, list its contents.

Gibt zurück:

the contents of the directory

Löst aus:

DocFileIOException - if there is a problem while listing the directory

mkdirs

public abstract boolean mkdirs()

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

resolve

public abstract 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.

resolve

public abstract 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.

resolveAgainst

public abstract DocFile resolveAgainst(JavaFileManager.Location locn)

Resolve a relative file against the given output location.

Parameter:

locn - Currently, only DocumentationTool.Location.DOCUMENTATION_OUTPUT is supported.