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

public Class DocFileIOException

extends DocletException
Class Inheritance
Imports
java.io.IOException, jdk.javadoc.internal.doclets.toolkit.DocletException
Wraps an IOException and the filename to which it applies.

API Note

This exception should be thrown by a doclet when an IO exception occurs and the file is known that was in use when the exception occurred.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
DocFileIOException.Mode

A hint for the type of operation being performed when the exception occurred.

Field Summary

Modifier and TypeField and Description
public final DocFile
fileName

The file that was in use when the exception occurred.

public final DocFileIOException.Mode
mode

The mode in which the file was being used when the exception occurred.

private static final long
serialVersionUID

Hides jdk.javadoc.internal.doclets.toolkit.DocletException.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
DocFileIOException(DocFile
the file in use when the exception occurred
fileName, DocFileIOException.Mode
the manner in which the file was being used
mode, IOException
the underlying exception
cause)

Creates an exception to wrap an IO exception, the file which caused it, and the manner in which the file was being used.

Field Detail

fileNameback to summary
public final DocFile fileName

The file that was in use when the exception occurred.

Annotations
@SuppressWarnings:serial
modeback to summary
public final DocFileIOException.Mode mode

The mode in which the file was being used when the exception occurred.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides jdk.javadoc.internal.doclets.toolkit.DocletException.serialVersionUID.

Constructor Detail

DocFileIOExceptionback to summary
public DocFileIOException(DocFile fileName, DocFileIOException.Mode mode, IOException cause)

Creates an exception to wrap an IO exception, the file which caused it, and the manner in which the file was being used.

Parameters
fileName:DocFile

the file in use when the exception occurred

mode:DocFileIOException.Mode

the manner in which the file was being used

cause:IOException

the underlying exception

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

public final Enum DocFileIOException.Mode

extends Enum<DocFileIOException.Mode>
Class Inheritance
A hint for the type of operation being performed when the exception occurred.

API Note

This may be used as a hint when reporting a message to the end user.

Field Summary

Modifier and TypeField and Description
public static final DocFileIOException.Mode
READ

The file was being opened for reading, or being read when the exception occurred.

public static final DocFileIOException.Mode
WRITE

The file was being opened for writing, or being written when the exception occurred.

Constructor Summary

AccessConstructor and Description
private
Mode()

Method Summary

Modifier and TypeMethod and Description
public static DocFileIOException.Mode
valueOf(String name)

public static DocFileIOException.Mode[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

READback to summary
public static final DocFileIOException.Mode READ

The file was being opened for reading, or being read when the exception occurred.

WRITEback to summary
public static final DocFileIOException.Mode WRITE

The file was being opened for writing, or being written when the exception occurred.

Constructor Detail

Modeback to summary
private Mode()

Method Detail

valueOfback to summary
public static DocFileIOException.Mode valueOf(String name)
valuesback to summary
public static DocFileIOException.Mode[] values()