jdk-sandbox: comparison langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocFile.java

equal deleted inserted replaced

-:e17429a7e843
+:1c355ea550ed
 */
 package jdk.javadoc.internal.doclets.toolkit.util;
 import java.io.BufferedReader;
-import java.io.BufferedWriter;
-import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.OutputStream;
-import java.io.OutputStreamWriter;
 import java.io.UnsupportedEncodingException;
 import java.io.Writer;
 import javax.tools.JavaFileManager.Location;
 import javax.tools.StandardLocation;
 /** Create a DocFile for a file that will be opened for writing. */
 public static DocFile createFileForOutput(Configuration configuration, DocPath path) {
 return DocFileFactory.getFactory(configuration).createFileForOutput(path);
 }
-private final Configuration configuration;
 /**
 * The location for this file. Maybe null if the file was created without
 * a location or path.
 */
 public static Iterable<DocFile> list(Configuration configuration, Location location, DocPath path) {
 return DocFileFactory.getFactory(configuration).list(location, path);
 }
 /** Create a DocFile without a location or path */
-protected DocFile(Configuration configuration) {
+protected DocFile() {
-this.configuration = configuration;
 this.location = null;
 this.path = null;
 }
 /** Create a DocFile for a given location and relative path. */
-protected DocFile(Configuration configuration, Location location, DocPath path) {
+protected DocFile(Location location, DocPath path) {
-this.configuration = configuration;
 this.location = location;
 this.path = path;
 }
-/** Open an input stream for the file. */
+/**
-public abstract InputStream openInputStream() throws IOException;
+* Open an input stream for the file.
+*
+* @return an open input stream for the file
+* @throws DocFileIOException if there is a problem opening the stream
+*/
+public abstract InputStream openInputStream() throws DocFileIOException;
 /**
 * Open an output stream for the file.
 * The file must have been created with a location of
 * {@link DocumentationTool.Location#DOCUMENTATION_OUTPUT}
 * and a corresponding relative path.
-*/
+*
-public abstract OutputStream openOutputStream() throws IOException, UnsupportedEncodingException;
+* @return an open output stream for the file
+* @throws DocFileIOException if there is a problem opening the stream
+* @throws UnsupportedEncodingException if the configured encoding is not supported
+*/
+public abstract OutputStream openOutputStream() 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
 * {@link DocumentationTool.Location#DOCUMENTATION_OUTPUT} and a corresponding relative path.
-*/
+*
-public abstract Writer openWriter() throws IOException, UnsupportedEncodingException;
+* @return an open output stream for the file
+* @throws DocFileIOException if there is a problem opening the stream
+* @throws UnsupportedEncodingException if the configured encoding is not supported
+*/
+public abstract Writer openWriter() throws DocFileIOException, UnsupportedEncodingException;
 /**
 * Copy the contents of another file directly to this file.
-*/
+*
-public void copyFile(DocFile fromFile) throws IOException {
+* @param fromFile the file to be copied
-try (OutputStream output = openOutputStream();
+* @throws DocFileIOException if there is a problem file copying the file
-InputStream input = fromFile.openInputStream()) {
+*/
-byte[] bytearr = new byte[1024];
+public void copyFile(DocFile fromFile) throws DocFileIOException {
-int len;
+try (OutputStream output = openOutputStream()) {
-while ((len = input.read(bytearr)) != -1) {
+try (InputStream input = fromFile.openInputStream()) {
-output.write(bytearr, 0, len);
+byte[] bytearr = new byte[1024];
+int len;
+while ((len = read(fromFile, input, bytearr)) != -1) {
+write(this, output, bytearr, len);
+}
+} catch (IOException e) {
+throw new DocFileIOException(fromFile, DocFileIOException.Mode.READ, e);
 }
-}
+} catch (IOException e) {
-catch (FileNotFoundException | SecurityException exc) {
+throw new DocFileIOException(this, DocFileIOException.Mode.WRITE, e);
 }
 }
 /**
 * Copy the contents of a resource file to this file.
+*
 * @param resource the path of the resource, relative to the package of this class
 * @param overwrite whether or not to overwrite the file if it already exists
 * @param 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
-*/
+*
-public void copyResource(DocPath resource, boolean overwrite, boolean replaceNewLine) {
+* @throws DocFileIOException if there is a problem while writing the copy
+* @throws ResourceIOException if there is a problem while reading the resource
+*/
+public void copyResource(DocPath resource, boolean overwrite, boolean replaceNewLine)
+throws DocFileIOException, ResourceIOException {
 if (exists() && !overwrite)
 return;
 try {
 InputStream in = Configuration.class.getResourceAsStream(resource.getPath());
 if (in == null)
 return;
-try (OutputStream out = openOutputStream()) {
+try {
-if (!replaceNewLine) {
+if (replaceNewLine) {
-byte[] buf = new byte[2048];
+try (BufferedReader reader = new BufferedReader(new InputStreamReader(in))) {
-int n;
+try (Writer writer = openWriter()) {
-while ((n = in.read(buf)) > 0)
+String line;
-out.write(buf, 0, n);
+while ((line = readResourceLine(resource, reader)) != null) {
+write(this, writer, line);
+write(this, writer, DocletConstants.NL);
+}
+} catch (IOException e) {
+throw new DocFileIOException(this, DocFileIOException.Mode.WRITE, e);
+}
+}
 } else {
-try (BufferedReader reader = new BufferedReader(new InputStreamReader(in));
+try (OutputStream out = openOutputStream()) {
-BufferedWriter writer = new BufferedWriter(configuration.docencoding == null
+byte[] buf = new byte[2048];
-? new OutputStreamWriter(out)
+int n;
-: new OutputStreamWriter(out, configuration.docencoding))) {
+while ((n = readResource(resource, in, buf)) > 0) {
-String line;
+write(this, out, buf, n);
-while ((line = reader.readLine()) != null) {
-writer.write(line);
-writer.write(DocletConstants.NL);
 }
+} catch (IOException e) {
+throw new DocFileIOException(this, DocFileIOException.Mode.WRITE, e);
 }
 }
 } finally {
 in.close();
 }
 } catch (IOException e) {
-e.printStackTrace(System.err);
+throw new ResourceIOException(resource, e);
-throw new DocletAbortException(e);
 }
 }
 /** Return true if the file can be read. */
 public abstract boolean canRead();
 public abstract boolean isFile();
 /** Return true if this file is the same as another. */
 public abstract boolean isSameFile(DocFile other);
-/** If the file is a directory, list its contents. */
+/** If the file is a directory, list its contents.
-public abstract Iterable<DocFile> list() throws IOException;
+*
+* @return the contents of the directory
+* @throws DocFileIOException if there is a problem while listing the directory
+*/
+public abstract Iterable<DocFile> list() throws DocFileIOException;
 /** Create the file as a directory, including any parent directories. */
 public abstract boolean mkdirs();
 /**
 * Resolve a relative file against the given output location.
 * @param locn Currently, only
 * {@link DocumentationTool.Location#DOCUMENTATION_OUTPUT} is supported.
 */
 public abstract DocFile resolveAgainst(Location locn);
+/**
+* Reads from an input stream opened from a given file into a given buffer.
+* If an IOException occurs, it is wrapped in a DocFileIOException.
+*
+* @param inFile the file for the stream
+* @param input the stream
+* @param buf the buffer
+* @return the number of bytes read, or -1 if at end of file
+* @throws DocFileIOException if an exception occurred while reading the stream
+*/
+private static int read(DocFile inFile, InputStream input, byte[] buf) throws DocFileIOException {
+try {
+return input.read(buf);
+} catch (IOException e) {
+throw new DocFileIOException(inFile, DocFileIOException.Mode.READ, e);
+}
+}
+/**
+* Writes to an output stream for a given file from a given buffer.
+* If an IOException occurs, it is wrapped in a DocFileIOException.
+*
+* @param outFile the file for the stream
+* @param out the stream
+* @param buf the buffer
+* @throws DocFileIOException if an exception occurred while writing the stream
+*/
+private static void write(DocFile outFile, OutputStream out, byte[] buf, int len) throws DocFileIOException {
+try {
+out.write(buf, 0, len);
+} catch (IOException e) {
+throw new DocFileIOException(outFile, DocFileIOException.Mode.WRITE, e);
+}
+}
+/**
+* Writes text to an output stream for a given file from a given buffer.
+* If an IOException occurs, it is wrapped in a DocFileIOException.
+*
+* @param outFile the file for the stream
+* @param out the stream
+* @param text the text to be written
+* @throws DocFileIOException if an exception occurred while writing the stream
+*/
+private static void write(DocFile outFile, Writer out, String text) throws DocFileIOException {
+try {
+out.write(text);
+} catch (IOException e) {
+throw new DocFileIOException(outFile, DocFileIOException.Mode.WRITE, e);
+}
+}
+/**
+* Reads from an input stream opened from a given resource into a given buffer.
+* If an IOException occurs, it is wrapped in a ResourceIOException.
+*
+* @param resource the resource for the stream
+* @param in the stream
+* @param buf the buffer
+* @return the number of bytes read, or -1 if at end of file
+* @throws ResourceIOException if an exception occurred while reading the stream
+*/
+private static int readResource(DocPath resource, InputStream in, byte[] buf) throws ResourceIOException {
+try {
+return in.read(buf);
+} catch (IOException e) {
+throw new ResourceIOException(resource, e);
+}
+}
+/**
+* Reads a line of characters from an input stream opened from a given resource.
+* If an IOException occurs, it is wrapped in a ResourceIOException.
+*
+* @param resource the resource for the stream
+* @param in the stream
+* @return the line of text, or {@code null} if at end of stream
+* @throws ResourceIOException if an exception occurred while reading the stream
+*/
+private static String readResourceLine(DocPath docPath, BufferedReader in) throws ResourceIOException {
+try {
+return in.readLine();
+} catch (IOException e) {
+throw new ResourceIOException(docPath, e);
+}
+}
 }

changeset 40587	1c355ea550ed
parent 35426	374342e56a56
child 45417	f7479ee8de69