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

equal deleted inserted replaced

-:e17429a7e843
+:1c355ea550ed
 import jdk.javadoc.doclet.Reporter;
 import jdk.javadoc.internal.doclets.toolkit.builders.BuilderFactory;
 import jdk.javadoc.internal.doclets.toolkit.taglets.TagletManager;
 import jdk.javadoc.internal.doclets.toolkit.util.DocFile;
 import jdk.javadoc.internal.doclets.toolkit.util.DocFileFactory;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
 import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
 import jdk.javadoc.internal.doclets.toolkit.util.Extern;
 import jdk.javadoc.internal.doclets.toolkit.util.Group;
 import jdk.javadoc.internal.doclets.toolkit.util.MetaKeywords;
+import jdk.javadoc.internal.doclets.toolkit.util.SimpleDocletException;
 import jdk.javadoc.internal.doclets.toolkit.util.TypeElementCatalog;
 import jdk.javadoc.internal.doclets.toolkit.util.Utils;
 import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap.GetterSetter;
 import static javax.tools.Diagnostic.Kind.*;
 * @author Jamie Ho
 */
 public abstract class Configuration {
 /**
-* Exception used to report a problem during setOptions.
-*/
-public static class Fault extends Exception {
-private static final long serialVersionUID = 0;
-Fault(String msg) {
-super(msg);
-}
-Fault(String msg, Exception cause) {
-super(msg, cause);
-}
-}
-/**
 * The factory for builders.
 */
 protected BuilderFactory builderFactory;
 /**
 public String builderXMLPath;
 /**
 * The default path to the builder XML.
 */
-private static final String DEFAULT_BUILDER_XML = "resources/doclet.xml";
+public static final String DEFAULT_BUILDER_XML = "resources/doclet.xml";
 /**
 * The path to Taglets
 */
 public String tagletpath = "";
 public abstract Messages getMessages();
 public abstract Resources getResources();
 /**
 * Return the build date for the doclet.
+*
+* @return the build date
 */
 public abstract String getDocletSpecificBuildDate();
 /**
-* This method should be defined in all those doclets(configurations),
+* This method should be defined in all those doclets (configurations),
 * which want to derive themselves from this Configuration. This method
 * can be used to finish up the options setup.
+*
+* @return true if successful and false otherwise
 */
 public abstract boolean finishOptionSettings();
 public CommentUtils cmtUtils;
 /*
 * when this is called all the option have been set, this method,
 * initializes certain components before anything else is started.
 */
-private void finishOptionSettings0() throws Fault {
+private void finishOptionSettings0() throws DocletException {
-ensureOutputDirExists();
+initDestDirectory();
 if (urlForLink != null && pkglistUrlForLink != null)
 extern.link(urlForLink, pkglistUrlForLink, reporter, false);
 if (urlForLinkOffline != null && pkglistUrlForLinkOffline != null)
 extern.link(urlForLinkOffline, pkglistUrlForLinkOffline, reporter, true);
 if (docencoding == null) {
 /**
 * Set the command line options supported by this configuration.
 *
 * @return true if the options are set successfully
-* @throws DocletAbortException
+* @throws DocletException if there is a problem while setting the options
 */
-public boolean setOptions() throws Fault {
+public boolean setOptions() throws DocletException {
-try {
+initPackages();
-initPackages();
+initModules();
-initModules();
+finishOptionSettings0();
-finishOptionSettings0();
+if (!finishOptionSettings())
-if (!finishOptionSettings())
+return false;
-return false;
-} catch (Fault f) {
-throw new DocletAbortException(f.getMessage());
-}
 return true;
 }
-private void ensureOutputDirExists() throws Fault {
+private void initDestDirectory() throws DocletException {
-DocFile destDir = DocFile.createFileForDirectory(this, destDirName);
+if (!destDirName.isEmpty()) {
-if (!destDir.exists()) {
+DocFile destDir = DocFile.createFileForDirectory(this, destDirName);
-//Create the output directory (in case it doesn't exist yet)
+if (!destDir.exists()) {
-if (!destDirName.isEmpty())
+//Create the output directory (in case it doesn't exist yet)
 reporter.print(NOTE, getText("doclet.dest_dir_create", destDirName));
 destDir.mkdirs();
 } else if (!destDir.isDirectory()) {
-throw new Fault(getText(
+throw new SimpleDocletException(getText(
 "doclet.destination_directory_not_directory_0",
 destDir.getPath()));
 } else if (!destDir.canWrite()) {
-throw new Fault(getText(
+throw new SimpleDocletException(getText(
 "doclet.destination_directory_not_writable_0",
 destDir.getPath()));
 }
+}
+DocFileFactory.getFactory(this).setDestDir(destDirName);
 }
 /**
 * Initialize the taglet manager.  The strings to initialize the simple custom tags should
 * be in the following format:  "[tag name]:[location str]:[heading]".
+*
 * @param customTagStrs the set two dimensional arrays of strings.  These arrays contain
 * either -tag or -taglet arguments.
 */
 private void initTagletManager(Set<List<String>> customTagStrs) {
 tagletManager = tagletManager == null ?
 if (opt.matches("-docencoding")) {
 docencodingfound = true;
 if (!checkOutputFileEncoding(docencoding)) {
 return false;
 }
-};
+}
 }
 if (!docencodingfound && (encoding != null && !encoding.isEmpty())) {
 if (!checkOutputFileEncoding(encoding)) {
 return false;
 }
 }
 /**
 * Return true if the given doc-file subdirectory should be excluded and
 * false otherwise.
+*
 * @param docfilesubdir the doc-files subdirectory to check.
 * @return true if the directory is excluded.
 */
 public boolean shouldExcludeDocFileDir(String docfilesubdir){
 return excludedDocFileDirs.contains(docfilesubdir);
 }
 /**
 * Return true if the given qualifier should be excluded and false otherwise.
+*
 * @param qualifier the qualifier to check.
+* @return true if the qualifier should be excluded
 */
 public boolean shouldExcludeQualifier(String qualifier){
 if (excludedQualifiers.contains("all") ||
 excludedQualifiers.contains(qualifier) ||
 excludedQualifiers.contains(qualifier + ".*")) {
 }
 /**
 * Return the qualified name of the Element if its qualifier is not excluded.
 * Otherwise return the unqualified Element name.
+*
 * @param te the TypeElement to check.
 * @return the class name
 */
 public String getClassName(TypeElement te) {
 PackageElement pkg = utils.containingPackage(te);
 /**
 * Convenience method to obtain a resource from the doclet's
 * {@link Resources resources}.
 * Equivalent to <code>getResources.getText(key);</code>.
+*
 * @param key the key for the desired string
 * @return the string for the given key
 * @throws MissingResourceException if the key is not found in either
 *  bundle.
 */
 /**
 * Convenience method to obtain a resource from the doclet's
 * {@link Resources resources}.
 * Equivalent to <code>getResources.getText(key, args);</code>.
+*
 * @param key the key for the desired string
 * @param args values to be substituted into the resulting string
 * @return the string for the given key
 * @throws MissingResourceException if the key is not found in either
 *  bundle.
 return !(utils.isDeprecated(te) || utils.isDeprecated(utils.containingPackage(te)));
 }
 /**
 * Return the doclet specific instance of a writer factory.
+*
 * @return the {@link WriterFactory} for the doclet.
 */
 public abstract WriterFactory getWriterFactory();
 /**
 * Return the input stream to the builder XML.
 *
 * @return the input steam to the builder XML.
-* @throws FileNotFoundException when the given XML file cannot be found.
+* @throws DocFileIOException when the given XML file cannot be found or opened.
 */
-public InputStream getBuilderXML() throws IOException {
+public InputStream getBuilderXML() throws DocFileIOException {
 return builderXMLPath == null ?
 Configuration.class.getResourceAsStream(DEFAULT_BUILDER_XML) :
 DocFile.createFileForInput(this, builderXMLPath).openInputStream();
 }
 /**
 * Return the Locale for this document.
+*
 * @return the current locale
 */
 public abstract Locale getLocale();
 /**
 */
 public abstract JavaFileObject getOverviewPath();
 /**
 * Return the current file manager.
+*
 * @return JavaFileManager
 */
 public abstract JavaFileManager getFileManager();
 private void setTabWidth(int n) {

changeset 40587	1c355ea550ed
parent 40508	74ef30d16fb9
child 41252	058d83c9b1c7