--- a/.hgtags Tue Aug 30 11:07:58 2016 +0530
+++ b/.hgtags Tue Aug 30 08:45:21 2016 -0700
@@ -375,3 +375,4 @@
e613affb88d178dc7c589f1679db113d589bddb4 jdk-9+130
4d2a15091124488080d65848b704e25599b2aaeb jdk-9+131
2e83d21d78cd9c1d52e6cd2599e9c8aa36ea1f52 jdk-9+132
+e17429a7e843c4a4ed3651458d0f950970edcbcc jdk-9+133
--- a/.hgtags-top-repo Tue Aug 30 11:07:58 2016 +0530
+++ b/.hgtags-top-repo Tue Aug 30 08:45:21 2016 -0700
@@ -375,3 +375,4 @@
d94d54a3192fea79234c3ac55cd0b4052d45e954 jdk-9+130
8728756c2f70a79a90188f4019cfd6b9a275765c jdk-9+131
a24702d4d5ab0015a5c553ed57f66fce7d85155e jdk-9+132
+be1218f792a450dfb5d4b1f82616b9d95a6a732e jdk-9+133
--- a/corba/.hgtags Tue Aug 30 11:07:58 2016 +0530
+++ b/corba/.hgtags Tue Aug 30 08:45:21 2016 -0700
@@ -375,3 +375,4 @@
77f9692d5976ae155773dd3e07533616bb95bae1 jdk-9+130
f7e1d5337c2e550fe553df7a3886bbed80292ecd jdk-9+131
1ab4b9399c4cba584f66c1c088188f2f565fbf9c jdk-9+132
+2021bfedf1c478a4808a7711a6090682a12f4c0e jdk-9+133
--- a/hotspot/.hgtags Tue Aug 30 11:07:58 2016 +0530
+++ b/hotspot/.hgtags Tue Aug 30 08:45:21 2016 -0700
@@ -535,3 +535,4 @@
7d54c7056328b6a2bf4877458b8f4d8cd870f93b jdk-9+130
943bf73b49c33c2d7cbd796f6a4ae3c7a00ae932 jdk-9+131
713951c08aa26813375175c2ab6cc99ff2a56903 jdk-9+132
+a25e0fb6033245ab075136e744d362ce765464cd jdk-9+133
--- a/hotspot/src/share/vm/gc/g1/g1Analytics.cpp Tue Aug 30 11:07:58 2016 +0530
+++ b/hotspot/src/share/vm/gc/g1/g1Analytics.cpp Tue Aug 30 08:45:21 2016 -0700
@@ -316,14 +316,10 @@
return get_new_size_prediction(_pending_cards_seq);
}
-double G1Analytics::oldest_known_gc_end_time_sec() const {
+double G1Analytics::last_known_gc_end_time_sec() const {
return _recent_prev_end_times_for_all_gcs_sec->oldest();
}
-double G1Analytics::last_known_gc_end_time_sec() const {
- return _recent_prev_end_times_for_all_gcs_sec->last();
-}
-
void G1Analytics::update_recent_gc_times(double end_time_sec,
double pause_time_ms) {
_recent_gc_times_ms->add(pause_time_ms);
--- a/hotspot/src/share/vm/gc/g1/g1Analytics.hpp Tue Aug 30 11:07:58 2016 +0530
+++ b/hotspot/src/share/vm/gc/g1/g1Analytics.hpp Tue Aug 30 08:45:21 2016 -0700
@@ -155,7 +155,6 @@
void update_recent_gc_times(double end_time_sec, double elapsed_ms);
void compute_pause_time_ratio(double interval_ms, double pause_time_ms);
- double oldest_known_gc_end_time_sec() const;
double last_known_gc_end_time_sec() const;
};
--- a/hotspot/src/share/vm/gc/g1/g1CollectedHeap.cpp Tue Aug 30 11:07:58 2016 +0530
+++ b/hotspot/src/share/vm/gc/g1/g1CollectedHeap.cpp Tue Aug 30 08:45:21 2016 -0700
@@ -28,7 +28,6 @@
#include "classfile/symbolTable.hpp"
#include "code/codeCache.hpp"
#include "code/icBuffer.hpp"
-#include "gc/g1/g1Analytics.hpp"
#include "gc/g1/bufferingOopClosure.hpp"
#include "gc/g1/concurrentG1Refine.hpp"
#include "gc/g1/concurrentG1RefineThread.hpp"
@@ -2474,19 +2473,8 @@
}
jlong G1CollectedHeap::millis_since_last_gc() {
- jlong now = os::elapsed_counter() / NANOSECS_PER_MILLISEC;
- const G1Analytics* analytics = _g1_policy->analytics();
- double last = analytics->last_known_gc_end_time_sec();
- jlong ret_val = now - (last * 1000);
- if (ret_val < 0) {
- // See the notes in GenCollectedHeap::millis_since_last_gc()
- // for more information about the implementation.
- log_warning(gc)("Detected clock going backwards. "
- "Milliseconds since last GC would be " JLONG_FORMAT
- ". returning zero instead.", ret_val);
- return 0;
- }
- return ret_val;
+ // assert(false, "NYI");
+ return 0;
}
void G1CollectedHeap::prepare_for_verify() {
--- a/hotspot/src/share/vm/gc/g1/g1DefaultPolicy.cpp Tue Aug 30 11:07:58 2016 +0530
+++ b/hotspot/src/share/vm/gc/g1/g1DefaultPolicy.cpp Tue Aug 30 08:45:21 2016 -0700
@@ -604,7 +604,7 @@
_analytics->report_alloc_rate_ms(alloc_rate_ms);
double interval_ms =
- (end_time_sec - _analytics->oldest_known_gc_end_time_sec()) * 1000.0;
+ (end_time_sec - _analytics->last_known_gc_end_time_sec()) * 1000.0;
_analytics->update_recent_gc_times(end_time_sec, pause_time_ms);
_analytics->compute_pause_time_ratio(interval_ms, pause_time_ms);
}
--- a/hotspot/src/share/vm/gc/shared/genCollectedHeap.cpp Tue Aug 30 11:07:58 2016 +0530
+++ b/hotspot/src/share/vm/gc/shared/genCollectedHeap.cpp Tue Aug 30 08:45:21 2016 -0700
@@ -1256,21 +1256,21 @@
};
jlong GenCollectedHeap::millis_since_last_gc() {
- // javaTimeNanos() is guaranteed to be monotonically non-decreasing
- // provided the underlying platform provides such a time source
- // (and it is bug free). So we still have to guard against getting
- // back a time later than 'now'.
+ // We need a monotonically non-decreasing time in ms but
+ // os::javaTimeMillis() does not guarantee monotonicity.
jlong now = os::javaTimeNanos() / NANOSECS_PER_MILLISEC;
GenTimeOfLastGCClosure tolgc_cl(now);
// iterate over generations getting the oldest
// time that a generation was collected
generation_iterate(&tolgc_cl, false);
+ // javaTimeNanos() is guaranteed to be monotonically non-decreasing
+ // provided the underlying platform provides such a time source
+ // (and it is bug free). So we still have to guard against getting
+ // back a time later than 'now'.
jlong retVal = now - tolgc_cl.time();
if (retVal < 0) {
- log_warning(gc)("Detected clock going backwards. "
- "Milliseconds since last GC would be " JLONG_FORMAT
- ". returning zero instead.", retVal);
+ NOT_PRODUCT(log_warning(gc)("time warp: " JLONG_FORMAT, retVal);)
return 0;
}
return retVal;
--- a/jaxp/.hgtags Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/.hgtags Tue Aug 30 08:45:21 2016 -0700
@@ -375,3 +375,4 @@
e66cdc2de6b02443911d386fc9217b0d824d0686 jdk-9+130
874082a9b565a7092a40bfa934a6e3e3c3455a60 jdk-9+131
907445d85e680ea410fe2c83c0ec64b5508e4f3e jdk-9+132
+9490ba2e5e41685c858a0ca2a6ec87611eb011c6 jdk-9+133
--- a/jaxp/src/java.xml/share/classes/com/sun/org/apache/xalan/internal/xsltc/compiler/util/ErrorMessages.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/com/sun/org/apache/xalan/internal/xsltc/compiler/util/ErrorMessages.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,15 +1,15 @@
/*
- * reserved comment block
- * DO NOT REMOVE OR ALTER!
+ * Copyright (c) 2013, 2016, Oracle and/or its affiliates. All rights reserved.
*/
/*
- * Copyright 2001-2004 The Apache Software Foundation.
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
@@ -170,6 +170,14 @@
"Invalid URI ''{0}''."},
/*
+ * Note to translators: This message is displayed when the URI
+ * mentioned in the substitution text is not well-formed syntactically.
+ */
+ {ErrorMsg.CATALOG_EXCEPTION,
+ "JAXP08090001: The CatalogResolver is enabled with the catalog \"{0}\", "
+ + "but a CatalogException is returned."},
+
+ /*
* Note to translators: The file or URI named in the substitution text
* exists but could not be opened.
*/
--- a/jaxp/src/java.xml/share/classes/com/sun/org/apache/xalan/internal/xsltc/compiler/util/ErrorMsg.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/com/sun/org/apache/xalan/internal/xsltc/compiler/util/ErrorMsg.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,15 +1,15 @@
/*
- * reserved comment block
- * DO NOT REMOVE OR ALTER!
+ * Copyright (c) 2013, 2016, Oracle and/or its affiliates. All rights reserved.
*/
/*
- * Copyright 2001-2004 The Apache Software Foundation.
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
@@ -17,9 +17,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-/*
- * $Id: ErrorMsg.java,v 1.2.4.1 2005/09/15 10:18:01 pvedula Exp $
- */
package com.sun.org.apache.xalan.internal.xsltc.compiler.util;
@@ -60,6 +57,7 @@
public static final String ARGUMENT_CONVERSION_ERR = "ARGUMENT_CONVERSION_ERR";
public static final String FILE_NOT_FOUND_ERR = "FILE_NOT_FOUND_ERR";
public static final String INVALID_URI_ERR = "INVALID_URI_ERR";
+ public static final String CATALOG_EXCEPTION = "CATALOG_EXCEPTION";
public static final String FILE_ACCESS_ERR = "FILE_ACCESS_ERR";
public static final String MISSING_ROOT_ERR = "MISSING_ROOT_ERR";
public static final String NAMESPACE_UNDEF_ERR = "NAMESPACE_UNDEF_ERR";
--- a/jaxp/src/java.xml/share/classes/com/sun/org/apache/xalan/internal/xsltc/trax/TransformerFactoryImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/com/sun/org/apache/xalan/internal/xsltc/trax/TransformerFactoryImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -51,10 +51,11 @@
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import javax.xml.XMLConstants;
+import javax.xml.catalog.CatalogException;
import javax.xml.catalog.CatalogFeatures;
import javax.xml.catalog.CatalogFeatures.Feature;
import javax.xml.catalog.CatalogManager;
-import javax.xml.catalog.CatalogUriResolver;
+import javax.xml.catalog.CatalogResolver;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import javax.xml.transform.ErrorListener;
@@ -241,7 +242,7 @@
// type checking
private Map<String, Class> _xsltcExtensionFunctions;
- CatalogUriResolver _catalogUriResolver;
+ CatalogResolver _catalogUriResolver;
CatalogFeatures _catalogFeatures;
CatalogFeatures.Builder cfBuilder = CatalogFeatures.builder();
// Catalog features
@@ -634,7 +635,7 @@
}
// Inefficient, but array is small
- for (int i = 0; i < features.length; i++) {
+ for (int i =0; i < features.length; i++) {
if (name.equals(features[i])) {
return true;
}
@@ -923,7 +924,7 @@
String transletClassName = getTransletBaseName(source);
if (_packageName != null)
- transletClassName = _packageName + "." + transletClassName;
+ transletClassName = _packageName + "." + transletClassName;
if (_jarFileName != null)
bytecodes = getBytecodesFromJar(source, transletClassName);
@@ -1327,7 +1328,7 @@
if (source == null && _catalogFiles != null &&
_xmlFeatures.getFeature(JdkXmlFeatures.XmlFeature.USE_CATALOG)) {
if (_catalogUriResolver == null) {
- _catalogUriResolver = CatalogManager.catalogUriResolver(_catalogFeatures);
+ _catalogUriResolver = CatalogManager.catalogResolver(_catalogFeatures);
}
source = _catalogUriResolver.resolve(href, context);
}
@@ -1340,6 +1341,10 @@
final ErrorMsg msg = new ErrorMsg(ErrorMsg.INVALID_URI_ERR, href + "\n" + e.getMessage(), this);
xsltc.getParser().reportError(Constants.FATAL, msg);
}
+ catch (CatalogException e) {
+ final ErrorMsg msg = new ErrorMsg(ErrorMsg.CATALOG_EXCEPTION, href + "\n" + e.getMessage(), this);
+ xsltc.getParser().reportError(Constants.FATAL, msg);
+ }
return null;
}
--- a/jaxp/src/java.xml/share/classes/com/sun/org/apache/xalan/internal/xsltc/trax/TransformerImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/com/sun/org/apache/xalan/internal/xsltc/trax/TransformerImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -60,9 +60,10 @@
import java.util.Properties;
import java.util.StringTokenizer;
import javax.xml.XMLConstants;
+import javax.xml.catalog.CatalogException;
import javax.xml.catalog.CatalogFeatures;
import javax.xml.catalog.CatalogManager;
-import javax.xml.catalog.CatalogUriResolver;
+import javax.xml.catalog.CatalogResolver;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
@@ -224,7 +225,7 @@
// Catalog features
CatalogFeatures _catalogFeatures;
- CatalogUriResolver _catalogUriResolver;
+ CatalogResolver _catalogUriResolver;
// Catalog is enabled by default
boolean _useCatalog = true;
@@ -1337,7 +1338,7 @@
if (resolvedSource == null && _useCatalog &&
_catalogFeatures.get(CatalogFeatures.Feature.FILES) != null) {
if (_catalogUriResolver == null) {
- _catalogUriResolver = CatalogManager.catalogUriResolver(_catalogFeatures);
+ _catalogUriResolver = CatalogManager.catalogResolver(_catalogFeatures);
}
resolvedSource = _catalogUriResolver.resolve(href, baseURI);
}
@@ -1350,7 +1351,7 @@
return getDOM(resolvedSource);
}
- catch (TransformerException e) {
+ catch (TransformerException | CatalogException e) {
if (_errorListener != null)
postErrorToListener("File not found: " + e.getMessage());
return(null);
--- a/jaxp/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/impl/XMLDocumentFragmentScannerImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/impl/XMLDocumentFragmentScannerImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -511,7 +511,8 @@
//fDocumentHandler.endElement(getElementQName(),null);
break;
default :
- throw new InternalError("processing event: " + event);
+ // Errors should have already been handled by the Scanner
+ return false;
}
//System.out.println("here in before calling next");
--- a/jaxp/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/impl/XMLEntityManager.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/impl/XMLEntityManager.java Tue Aug 30 08:45:21 2016 -0700
@@ -20,8 +20,6 @@
package com.sun.org.apache.xerces.internal.impl ;
-import com.sun.org.apache.xerces.internal.impl.Constants;
-import com.sun.org.apache.xerces.internal.impl.XMLEntityHandler;
import com.sun.org.apache.xerces.internal.impl.io.ASCIIReader;
import com.sun.org.apache.xerces.internal.impl.io.UCSReader;
import com.sun.org.apache.xerces.internal.impl.io.UTF8Reader;
@@ -42,7 +40,6 @@
import com.sun.xml.internal.stream.StaxXMLInputSource;
import com.sun.xml.internal.stream.XMLEntityStorage;
import java.io.*;
-import java.lang.reflect.Method;
import java.net.HttpURLConnection;
import java.net.URISyntaxException;
import java.net.URL;
@@ -59,7 +56,6 @@
import javax.xml.catalog.CatalogFeatures.Feature;
import javax.xml.catalog.CatalogManager;
import javax.xml.catalog.CatalogResolver;
-import javax.xml.catalog.CatalogUriResolver;
import javax.xml.stream.XMLInputFactory;
import javax.xml.transform.Source;
import jdk.xml.internal.JdkXmlUtils;
@@ -420,7 +416,6 @@
private boolean fUseCatalog = true;
CatalogFeatures fCatalogFeatures;
CatalogResolver fCatalogResolver;
- CatalogUriResolver fCatalogUriResolver;
private String fCatalogFile;
private String fDefer;
@@ -1044,12 +1039,18 @@
}
fCatalogFile = fCatalogFeatures.get(Feature.FILES);
if (fUseCatalog && fCatalogFile != null) {
- if (fCatalogResolver == null) {
- fCatalogResolver = CatalogManager.catalogResolver(fCatalogFeatures);
- }
- InputSource is = fCatalogResolver.resolveEntity(publicId, literalSystemId);
- if (is != null && !is.isEmpty()) {
- staxInputSource = new StaxXMLInputSource(new XMLInputSource(is, true), true);
+ try {
+ if (fCatalogResolver == null) {
+ fCatalogResolver = CatalogManager.catalogResolver(fCatalogFeatures);
+ }
+ InputSource is = fCatalogResolver.resolveEntity(publicId, literalSystemId);
+ if (is != null && !is.isEmpty()) {
+ staxInputSource = new StaxXMLInputSource(new XMLInputSource(is, true), true);
+ }
+ } catch (CatalogException e) {
+ fErrorReporter.reportError(XMLMessageFormatter.XML_DOMAIN,"CatalogException",
+ new Object[]{SecuritySupport.sanitizePath(fCatalogFile)},
+ XMLErrorReporter.SEVERITY_FATAL_ERROR, e );
}
}
}
@@ -1140,7 +1141,7 @@
if (fUseCatalog && fCatalogFile != null) {
/*
since the method can be called from various processors, both
- CatalogResolver and CatalogUriResolver are used to attempt to find
+ EntityResolver and URIResolver are used to attempt to find
a match
*/
InputSource is = null;
@@ -1153,13 +1154,20 @@
is = fCatalogResolver.resolveEntity(pid, literalSystemId);
}
} catch (CatalogException e) {}
+
if (is != null && !is.isEmpty()) {
xmlInputSource = new XMLInputSource(is, true);
} else if (literalSystemId != null) {
- if (fCatalogUriResolver == null) {
- fCatalogUriResolver = CatalogManager.catalogUriResolver(fCatalogFeatures);
+ if (fCatalogResolver == null) {
+ fCatalogResolver = CatalogManager.catalogResolver(fCatalogFeatures);
}
- Source source = fCatalogUriResolver.resolve(literalSystemId, baseSystemId);
+
+ Source source = null;
+ try {
+ source = fCatalogResolver.resolve(literalSystemId, baseSystemId);
+ } catch (CatalogException e) {
+ throw new XNIException(e);
+ }
if (source != null && !source.isEmpty()) {
xmlInputSource = new XMLInputSource(publicId, source.getSystemId(), baseSystemId, true);
}
--- a/jaxp/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/impl/msg/XMLMessages.properties Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/impl/msg/XMLMessages.properties Tue Aug 30 08:45:21 2016 -0700
@@ -303,3 +303,5 @@
MaxElementDepthLimit=JAXP00010006: The element \"{0}\" has a depth of \"{1}\" that exceeds the limit \"{2}\" set by \"{3}\".
EntityReplacementLimit=JAXP00010007: The total number of nodes in entity references is \"{0}\" that is over the limit \"{1}\" set by \"{2}\".
+# Catalog 09
+ CatalogException=JAXP00090001: The CatalogResolver is enabled with the catalog \"{0}\", but a CatalogException is returned.
\ No newline at end of file
--- a/jaxp/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/util/EntityResolverWrapper.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/util/EntityResolverWrapper.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,13 +1,13 @@
/*
- * reserved comment block
- * DO NOT REMOVE OR ALTER!
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
*/
/*
- * Copyright 2001, 2002,2004 The Apache Software Foundation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
@@ -28,6 +28,7 @@
import com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier;
import com.sun.org.apache.xerces.internal.xni.parser.XMLEntityResolver;
import com.sun.org.apache.xerces.internal.xni.parser.XMLInputSource;
+import javax.xml.catalog.CatalogException;
import org.xml.sax.EntityResolver;
import org.xml.sax.InputSource;
@@ -132,6 +133,10 @@
}
throw new XNIException(ex);
}
+
+ catch (CatalogException e) {
+ throw new XNIException(e);
+ }
}
// unable to resolve entity
--- a/jaxp/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/xinclude/XIncludeHandler.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/xinclude/XIncludeHandler.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2006, 2016, Oracle and/or its affiliates. All rights reserved.
*/
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
@@ -75,7 +75,6 @@
import javax.xml.catalog.CatalogFeatures;
import javax.xml.catalog.CatalogManager;
import javax.xml.catalog.CatalogResolver;
-import javax.xml.catalog.CatalogUriResolver;
import javax.xml.transform.Source;
import jdk.xml.internal.JdkXmlUtils;
import org.xml.sax.InputSource;
@@ -371,7 +370,6 @@
private boolean fUseCatalog = true;
CatalogFeatures fCatalogFeatures;
CatalogResolver fCatalogResolver;
- CatalogUriResolver fCatalogUriResolver;
private String fCatalogFile;
private String fDefer;
@@ -1638,10 +1636,10 @@
*/
Source source = null;
try {
- if (fCatalogUriResolver == null) {
- fCatalogUriResolver = CatalogManager.catalogUriResolver(fCatalogFeatures);
+ if (fCatalogResolver == null) {
+ fCatalogResolver = CatalogManager.catalogResolver(fCatalogFeatures);
}
- source = fCatalogUriResolver.resolve(href, fCurrentBaseURI.getExpandedSystemId());
+ source = fCatalogResolver.resolve(href, fCurrentBaseURI.getExpandedSystemId());
} catch (CatalogException e) {}
if (source != null && !source.isEmpty()) {
@@ -1669,7 +1667,7 @@
includedSource.getBaseSystemId(), accept, acceptLanguage);
}
}
- catch (IOException e) {
+ catch (IOException | CatalogException e) {
reportResourceError(
"XMLResourceError",
new Object[] { href, e.getMessage()});
--- a/jaxp/src/java.xml/share/classes/com/sun/xml/internal/stream/StaxEntityResolverWrapper.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/com/sun/xml/internal/stream/StaxEntityResolverWrapper.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -33,6 +33,7 @@
import com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier;
import com.sun.org.apache.xerces.internal.xni.XNIException;
import com.sun.org.apache.xerces.internal.xni.parser.XMLInputSource;
+import javax.xml.catalog.CatalogException;
/**
*
@@ -58,11 +59,11 @@
public StaxXMLInputSource resolveEntity(XMLResourceIdentifier resourceIdentifier)
throws XNIException, java.io.IOException {
Object object = null ;
- try{
+ try {
object = fStaxResolver.resolveEntity(resourceIdentifier.getPublicId(), resourceIdentifier.getLiteralSystemId(),
resourceIdentifier.getBaseSystemId(), null);
return getStaxInputSource(object) ;
- }catch(XMLStreamException streamException){
+ } catch(XMLStreamException | CatalogException streamException){
throw new XNIException(streamException) ;
}
}
--- a/jaxp/src/java.xml/share/classes/javax/xml/catalog/Catalog.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/javax/xml/catalog/Catalog.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -42,9 +42,9 @@
* <p>
* A catalog can be used in two situations:
* <ul>
- * <li>Locate the replacement text for an external entity;
+ * <li>Locate the external resources with a public or system identifier;
* </li>
- * <li>Locate an alternate URI reference for a resource.
+ * <li>Locate an alternate URI reference with an URI.
* </li>
* </ul>
* <p>
--- a/jaxp/src/java.xml/share/classes/javax/xml/catalog/CatalogManager.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/javax/xml/catalog/CatalogManager.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -77,17 +77,6 @@
}
/**
- * Creates an instance of a {@code CatalogUriResolver} using the specified catalog.
- *
- * @param catalog the catalog instance
- * @return an instance of a {@code CatalogResolver}
- */
- public static CatalogUriResolver catalogUriResolver(Catalog catalog) {
- if (catalog == null) CatalogMessages.reportNPEOnNull("catalog", null);
- return new CatalogUriResolverImpl(catalog);
- }
-
- /**
* Creates an instance of a {@code CatalogResolver} using the specified feature
* settings and path to one or more catalog files.
* <p>
@@ -115,33 +104,4 @@
Catalog catalog = catalog(features, paths);
return new CatalogResolverImpl(catalog);
}
-
- /**
- * Creates an instance of a {@code CatalogUriResolver} using the specified
- * feature settings and path to one or more catalog files.
- * <p>
- * If {@code paths} is empty, system property {@code javax.xml.catalog.files}
- * will be read to locate the initial list of catalog files.
- * <p>
- * If more than one catalog files are specified through the paths argument or
- * {@code javax.xml.catalog.files} property, the first entry is considered
- * the main catalog, while others are treated as alternative catalogs after
- * those referenced by the {@code nextCatalog} elements in the main catalog.
- * <p>
- * As specified in
- * <a href="https://www.oasis-open.org/committees/download.php/14809/xml-catalogs.html#s.res.fail">
- * XML Catalogs, OASIS Standard V1.1</a>, invalid path entries will be ignored.
- * No error will be reported. In case all entries are invalid, the resolver
- * will return as no mapping is found.
- *
- * @param features the catalog features
- * @param paths the path(s) to one or more catalogs
- *
- * @return an instance of a {@code CatalogUriResolver}
- * @throws CatalogException If an error occurs while parsing the catalog
- */
- public static CatalogUriResolver catalogUriResolver(CatalogFeatures features, String... paths) {
- Catalog catalog = catalog(features, paths);
- return new CatalogUriResolverImpl(catalog);
- }
}
--- a/jaxp/src/java.xml/share/classes/javax/xml/catalog/CatalogResolver.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/javax/xml/catalog/CatalogResolver.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -24,32 +24,90 @@
*/
package javax.xml.catalog;
+import java.io.InputStream;
+import javax.xml.stream.XMLResolver;
+import javax.xml.transform.Source;
+import javax.xml.transform.URIResolver;
+import org.w3c.dom.ls.LSInput;
+import org.w3c.dom.ls.LSResourceResolver;
import org.xml.sax.EntityResolver;
import org.xml.sax.InputSource;
/**
- * A SAX EntityResolver that uses catalogs to resolve references.
+ * A Catalog Resolver that implements SAX {@link org.xml.sax.EntityResolver},
+ * StAX {@link javax.xml.stream.XMLResolver},
+ * DOM LS {@link org.w3c.dom.ls.LSResourceResolver} used by Schema Validation, and
+ * Transform {@link javax.xml.transform.URIResolver}, and resolves
+ * external references using catalogs.
+ * <p>
+ * The <a href="https://www.oasis-open.org/committees/download.php/14809/xml-catalogs.html">
+ * Catalog Standard</a> distinguished {@code external identifiers} from {@code uri entries}
+ * as being used to solely identify DTDs, while {@code uri entries} for
+ * other resources such as stylesheets and schema. The Java APIs, such as
+ * {@link javax.xml.stream.XMLResolver} and {@link org.w3c.dom.ls.LSResourceResolver}
+ * however, make no such distinction.
+ * In consistent with the existing Java API, this CatalogResolver recognizes a
+ * system identifier as an URI and will search both {@code system} and {@code uri}
+ * entries in a catalog in order to find a matching entry.
+ * <p>
+ * The search is started in the current catalog. If a match is found,
+ * no further attempt will be made. Only if there is no match in the current
+ * catalog, will alternate catalogs including delegate and next catalogs be considered.
+ * <p>
+ * <h3>Search Order</h3>
+ * The resolver will first search the system-type of entries with the specified
+ * {@code systemId}. The system entries include {@code system},
+ * {@code rewriteSystem} and {@code systemSuffix} entries.
+ * <p>
+ * If no match is found, {@code public} entries may be searched in accordance with
+ * the {@code prefer} attribute.
+ * <p>
+ * <b>The {@code prefer} attribute</b>: if the {@code prefer} is public,
+ * and there is no match found through the system entries, {@code public} entries
+ * will be considered. If it is not specified, the {@code prefer} is public
+ * by default (Note that by the OASIS standard, system entries will always
+ * be considered before public entries. Prefer public means that public entries
+ * will be matched when both system and public identifiers are specified.
+ * In general therefore, prefer public is recommended.)
+ * <p>
+ * If no match is found with the {@code systemId} and {@code public} identifier,
+ * the resolver will continue searching {@code uri} entries
+ * with the specified {@code systemId} or {@code href}. The {@code uri} entries
+ * include {@code uri}, {@code rewriteURI}, and {@code uriSuffix} entries.
+ *
+ * <p>
+ * <h3>Error Handling</h3>
+ * The interfaces that the CatalogResolver extend specified checked exceptions, including:
+ * <ul>
+ * <li>
+ * {@link org.xml.sax.SAXException} and {@link java.io.IOException} by
+ * {@link org.xml.sax.EntityResolver#resolveEntity(java.lang.String, java.lang.String)}
+ * </li>
+ * <li>
+ * {@link javax.xml.stream.XMLStreamException} by
+ * {@link javax.xml.stream.XMLResolver#resolveEntity(java.lang.String, java.lang.String, java.lang.String, java.lang.String)}
+ * </li>
+ * <li>
+ * {@link javax.xml.transform.TransformerException} by
+ * {@link javax.xml.transform.URIResolver#resolve(java.lang.String, java.lang.String)}
+ * </li>
+ * </ul>
+ * <p>
+ * The CatalogResolver however, will throw {@link javax.xml.catalog.CatalogException}
+ * only when {@code javax.xml.catalog.resolve} is specified as {@code strict}.
+ * For applications that expect to handle the checked Exceptions, it may be
+ * necessary to use a custom resolver to wrap the CatalogResolver or implement it
+ * with a {@link javax.xml.catalog.Catalog} object.
*
* @since 9
*/
-public interface CatalogResolver extends EntityResolver {
+public interface CatalogResolver extends EntityResolver, XMLResolver,
+ URIResolver, LSResourceResolver {
/**
- * The method searches through the catalog entries in the main and
- * alternative catalogs to attempt to find a match with the specified publicId
- * or systemId.
- * <p>
- * For resolving external entities, system entries will be matched before
- * the public entries.
- * <p>
- * <b>The {@code prefer} attribute</b>: if the {@code prefer} is public,
- * and there is no match found through the system entries, public entries
- * will be considered. If it is not specified, the {@code prefer} is public
- * by default (Note that by the OASIS standard, system entries will always
- * be considered first when the external system identifier is specified.
- * Prefer public means that public entries will be matched when both system
- * and public identifiers are specified. In general therefore, prefer
- * public is recommended.)
+ * Implements {@link org.xml.sax.EntityResolver}. The method searches through
+ * the catalog entries in the main and alternative catalogs to attempt to find
+ * a match with the specified {@code publicId} or systemId.
*
* @param publicId the public identifier of the external entity being
* referenced, or null if none was supplied
@@ -59,15 +117,123 @@
* requires a system identifier on all external entities, so this value is
* always specified.
*
- * @return a {@link org.xml.sax.InputSource} object if a mapping is found. If no mapping is
- * found, returns a {@link org.xml.sax.InputSource} object containing an empty
- * {@link java.io.Reader} if the {@code javax.xml.catalog.resolve} property
- * is set to {@code ignore}; returns null if the
+ * @return a {@link org.xml.sax.InputSource} object if a mapping is found.
+ * If no mapping is found, returns a {@link org.xml.sax.InputSource} object
+ * containing an empty {@link java.io.Reader} if the
+ * {@code javax.xml.catalog.resolve} property is set to {@code ignore};
+ * returns null if the
+ * {@code javax.xml.catalog.resolve} property is set to {@code continue}.
+ *
+ * @throws CatalogException if no mapping is found and
+ * {@code javax.xml.catalog.resolve} is specified as {@code strict}
+ */
+ @Override
+ public InputSource resolveEntity(String publicId, String systemId);
+
+
+ /**
+ * Implements URIResolver. The method searches through the catalog entries
+ * in the main and alternative catalogs to attempt to find a match
+ * with the specified {@code href} attribute. The {@code href} attribute will
+ * be used literally, with no attempt to be made absolute to the {@code base}.
+ * <p>
+ * If the value is an URN, the {@code href} attribute is recognized as a
+ * {@code publicId}, and used to search {@code public} entries.
+ * If the value is an URI, it is taken as a {@code systemId}, and used to
+ * search both {@code system} and {@code uri} entries.
+ *
+ *
+ * @param href the href attribute that specifies the URI of a style sheet,
+ * which may be relative or absolute
+ * @param base The base URI against which the href attribute will be made
+ * absolute if the absolute URI is required
+ *
+ * @return a {@link javax.xml.transform.Source} object if a mapping is found.
+ * If no mapping is found, returns an empty {@link javax.xml.transform.Source}
+ * object if the {@code javax.xml.catalog.resolve} property is set to
+ * {@code ignore};
+ * returns a {@link javax.xml.transform.Source} object with the original URI
+ * (href, or href resolved with base if base is not null) if the
* {@code javax.xml.catalog.resolve} property is set to {@code continue}.
*
* @throws CatalogException if no mapping is found and
- * {@code javax.xml.catalog.resolve} is specified as strict
+ * {@code javax.xml.catalog.resolve} is specified as {@code strict}
+ */
+ @Override
+ public Source resolve(String href, String base);
+
+ /**
+ * Implements {@link javax.xml.stream.XMLResolver}. For the purpose of resolving
+ * {@code publicId} and {@code systemId}, this method is equivalent to
+ * {@link #resolveEntity(java.lang.String, java.lang.String) }.
+ * <p>
+ * The {@code systemId} will be used literally, with no attempt to be made
+ * absolute to the {@code baseUri}. The {@code baseUri} and {@code namespace}
+ * are not used in the search for a match in a catalog. However, a relative
+ * {@code systemId} in an xml source may have been made absolute by the parser
+ * with the {@code baseURI}, thus making it unable to find a {@code system} entry.
+ * In such a case, a {@code systemSuffix} entry is recommended over a
+ * {@code system} entry.
+ *
+ * @param publicId the public identifier of the external entity being
+ * referenced, or null if none was supplied
+ *
+ * @param systemId the system identifier of the external entity being
+ * referenced. A system identifier is required on all external entities. XML
+ * requires a system identifier on all external entities, so this value is
+ * always specified.
+ * @param baseUri the absolute base URI, not used by the CatalogResolver
+ * @param namespace the namespace of the entity to resolve, not used by the
+ * CatalogResolver.
+ *
+ * @return an {@link java.io.InputStream} object if a mapping is found; null
+ * if no mapping is found and the {@code javax.xml.catalog.resolve} property
+ * is set to {@code continue} or {@code ignore}. Note that for XMLResolver,
+ * it is not possible to ignore a reference, {@code ignore} is therefore
+ * treated the same as {@code continue}.
+ *
+ * @throws CatalogException if no mapping is found and
+ * {@code javax.xml.catalog.resolve} is specified as {@code strict}
*/
@Override
- public InputSource resolveEntity(String publicId, String systemId);
+ public InputStream resolveEntity(String publicId, String systemId,
+ String baseUri, String namespace);
+
+ /**
+ * Implements {@link org.w3c.dom.ls.LSResourceResolver}. For the purpose of
+ * resolving {@code publicId} and {@code systemId}, this method is equivalent
+ * to {@link #resolveEntity(java.lang.String, java.lang.String) }.
+ * <p>
+ * The {@code systemId} will be used literally, with no attempt to be made
+ * absolute to the {@code baseUri}. The {@code baseUri}, {@code namespaceUri}
+ * and {@code type} are not used in the search for a match in a catalog.
+ * However, a relative {@code systemId} in a source may have been made absolute
+ * by the parser with the {@code baseURI}, thus making it unable to find a
+ * {@code system} entry. In such a case, a {@code systemSuffix} entry is
+ * recommended over a {@code system} entry.
+ *
+ * @param type the type of the resource being resolved,
+ * not used by the CatalogResolver
+ * @param namespaceUri the namespace of the resource being resolved,
+ * not used by the CatalogResolver
+ * @param publicId the public identifier of the external entity being
+ * referenced, or {@code null} if no public identifier was
+ * supplied or if the resource is not an entity.
+ * @param systemId the system identifier, an URI reference of the
+ * external resource being referenced
+ * @param baseUri the absolute base URI, not used by the CatalogResolver
+ *
+ * @return a {@link org.w3c.dom.ls.LSInput} object if a mapping is found; null
+ * if no mapping is found and the {@code javax.xml.catalog.resolve} property
+ * is set to {@code continue} or {@code ignore}. Note that for
+ * {@link org.w3c.dom.ls.LSResourceResolver}, it is not possible to ignore a
+ * reference, {@code ignore} is therefore treated the same as {@code continue}.
+ *
+ * @throws CatalogException if no mapping is found and
+ * {@code javax.xml.catalog.resolve} is specified as {@code strict}
+ */
+ @Override
+ public LSInput resolveResource(String type, String namespaceUri,
+ String publicId, String systemId, String baseUri);
+
}
--- a/jaxp/src/java.xml/share/classes/javax/xml/catalog/CatalogResolverImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/javax/xml/catalog/CatalogResolverImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -24,15 +24,27 @@
*/
package javax.xml.catalog;
+import com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.Reader;
import java.io.StringReader;
-import java.util.Iterator;
+import java.net.URL;
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.parsers.SAXParserFactory;
+import javax.xml.transform.Source;
+import javax.xml.transform.sax.SAXSource;
+import org.w3c.dom.ls.LSInput;
import org.xml.sax.InputSource;
+import org.xml.sax.SAXException;
+import org.xml.sax.XMLReader;
/**
- * A SAX EntityResolver/JAXP URIResolver that uses catalogs.
+ * Implements CatalogResolver.
*
* <p>
- * This class implements both a SAX EntityResolver and a JAXP URIResolver.
+ * This class implements a SAX EntityResolver, StAX XMLResolver,
+ * Schema Validation LSResourceResolver and Transform URIResolver.
*
*
* @since 9
@@ -49,9 +61,14 @@
this.catalog = catalog;
}
+ /*
+ Implements the EntityResolver interface
+ */
@Override
public InputSource resolveEntity(String publicId, String systemId) {
+ //8150187: NPE expected if the system identifier is null for CatalogResolver
CatalogMessages.reportNPEOnNull("systemId", systemId);
+
//Normalize publicId and systemId
systemId = Normalizer.normalizeURI(Util.getNotNullOrEmpty(systemId));
publicId = Normalizer.normalizePublicId(Normalizer.decodeURN(Util.getNotNullOrEmpty(publicId)));
@@ -87,4 +104,242 @@
return null;
}
+ /*
+ Implements the URIResolver interface
+ */
+ CatalogResolverImpl entityResolver;
+
+ @Override
+ public Source resolve(String href, String base) {
+ CatalogMessages.reportNPEOnNull("href", href);
+
+ href = Util.getNotNullOrEmpty(href);
+ base = Util.getNotNullOrEmpty(base);
+
+ String result = null;
+ CatalogImpl c = (CatalogImpl)catalog;
+ String uri = Normalizer.normalizeURI(href);
+ //check whether uri is an urn
+ if (uri != null && uri.startsWith(Util.URN)) {
+ String publicId = Normalizer.decodeURN(uri);
+ if (publicId != null) {
+ result = Util.resolve(c, publicId, null);
+ }
+ }
+
+ //if no match with a public id, continue search for an URI
+ if (result == null) {
+ //remove fragment if any.
+ int hashPos = uri.indexOf("#");
+ if (hashPos >= 0) {
+ uri = uri.substring(0, hashPos);
+ }
+
+ //search the current catalog
+ result = Util.resolve(c, null, uri);
+ }
+
+ //Report error or return the URI as is when no match is found
+ if (result == null) {
+ GroupEntry.ResolveType resolveType = c.getResolve();
+ switch (resolveType) {
+ case IGNORE:
+ return new SAXSource(new InputSource(new StringReader("")));
+ case STRICT:
+ CatalogMessages.reportError(CatalogMessages.ERR_NO_URI_MATCH,
+ new Object[]{href, base});
+ }
+ try {
+ URL url = null;
+
+ if (base == null) {
+ url = new URL(uri);
+ result = url.toString();
+ } else {
+ URL baseURL = new URL(base);
+ url = (href.length() == 0 ? baseURL : new URL(baseURL, uri));
+ result = url.toString();
+ }
+ } catch (java.net.MalformedURLException mue) {
+ CatalogMessages.reportError(CatalogMessages.ERR_CREATING_URI,
+ new Object[]{href, base});
+ }
+ }
+
+ SAXSource source = new SAXSource();
+ source.setInputSource(new InputSource(result));
+ setEntityResolver(source);
+ return source;
+ }
+
+ /**
+ * Establish an entityResolver for newly resolved URIs.
+ * <p>
+ * This is called from the URIResolver to set an EntityResolver on the SAX
+ * parser to be used for new XML documents that are encountered as a result
+ * of the document() function, xsl:import, or xsl:include. This is done
+ * because the XSLT processor calls out to the SAXParserFactory itself to
+ * create a new SAXParser to parse the new document. The new parser does not
+ * automatically inherit the EntityResolver of the original (although
+ * arguably it should). Quote from JAXP specification on Class
+ * SAXTransformerFactory:
+ * <p>
+ * {@code If an application wants to set the ErrorHandler or EntityResolver
+ * for an XMLReader used during a transformation, it should use a URIResolver
+ * to return the SAXSource which provides (with getXMLReader) a reference to
+ * the XMLReader}
+ *
+ */
+ private void setEntityResolver(SAXSource source) {
+ XMLReader reader = source.getXMLReader();
+ if (reader == null) {
+ SAXParserFactory spFactory = new SAXParserFactoryImpl();
+ spFactory.setNamespaceAware(true);
+ try {
+ reader = spFactory.newSAXParser().getXMLReader();
+ } catch (ParserConfigurationException | SAXException ex) {
+ CatalogMessages.reportRunTimeError(CatalogMessages.ERR_PARSER_CONF, ex);
+ }
+ }
+ if (entityResolver != null) {
+ entityResolver = new CatalogResolverImpl(catalog);
+ }
+ reader.setEntityResolver(entityResolver);
+ source.setXMLReader(reader);
+ }
+
+ @Override
+ public InputStream resolveEntity(String publicId, String systemId, String baseUri, String namespace) {
+ InputSource is = resolveEntity(publicId, systemId);
+
+ if (is != null && !is.isEmpty()) {
+
+ try {
+ return new URL(is.getSystemId()).openStream();
+ } catch (IOException ex) {
+ //considered as no mapping.
+ }
+
+ }
+
+ GroupEntry.ResolveType resolveType = ((CatalogImpl) catalog).getResolve();
+ switch (resolveType) {
+ case IGNORE:
+ return null;
+ case STRICT:
+ CatalogMessages.reportError(CatalogMessages.ERR_NO_MATCH,
+ new Object[]{publicId, systemId});
+ }
+
+ //no action, allow the parser to continue
+ return null;
+ }
+
+ @Override
+ public LSInput resolveResource(String type, String namespaceURI, String publicId, String systemId, String baseURI) {
+ InputSource is = resolveEntity(publicId, systemId);
+
+ if (is != null && !is.isEmpty()) {
+ return new LSInputImpl(is.getSystemId());
+ }
+
+ GroupEntry.ResolveType resolveType = ((CatalogImpl) catalog).getResolve();
+ switch (resolveType) {
+ case IGNORE:
+ return null;
+ case STRICT:
+ CatalogMessages.reportError(CatalogMessages.ERR_NO_MATCH,
+ new Object[]{publicId, systemId});
+ }
+
+ //no action, allow the parser to continue
+ return null;
+ }
+
+ /**
+ * Implements LSInput. All that we need is the systemId since the Catalog
+ * has already resolved it.
+ */
+ class LSInputImpl implements LSInput {
+
+ private String systemId;
+
+ public LSInputImpl(String systemId) {
+ this.systemId = systemId;
+ }
+
+ @Override
+ public Reader getCharacterStream() {
+ return null;
+ }
+
+ @Override
+ public void setCharacterStream(Reader characterStream) {
+ }
+
+ @Override
+ public InputStream getByteStream() {
+ return null;
+ }
+
+ @Override
+ public void setByteStream(InputStream byteStream) {
+ }
+
+ @Override
+ public String getStringData() {
+ return null;
+ }
+
+ @Override
+ public void setStringData(String stringData) {
+ }
+
+ @Override
+ public String getSystemId() {
+ return systemId;
+ }
+
+ @Override
+ public void setSystemId(String systemId) {
+ this.systemId = systemId;
+ }
+
+ @Override
+ public String getPublicId() {
+ return null;
+ }
+
+ @Override
+ public void setPublicId(String publicId) {
+ }
+
+ @Override
+ public String getBaseURI() {
+ return null;
+ }
+
+ @Override
+ public void setBaseURI(String baseURI) {
+ }
+
+ @Override
+ public String getEncoding() {
+ return null;
+ }
+
+ @Override
+ public void setEncoding(String encoding) {
+ }
+
+ @Override
+ public boolean getCertifiedText() {
+ return false;
+ }
+
+ @Override
+ public void setCertifiedText(boolean certifiedText) {
+ }
+ }
+
}
--- a/jaxp/src/java.xml/share/classes/javax/xml/catalog/CatalogUriResolver.java Tue Aug 30 11:07:58 2016 +0530
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,58 +0,0 @@
-/*
- * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 only, as
- * published by the Free Software Foundation. Oracle designates this
- * particular file as subject to the "Classpath" exception as provided
- * by Oracle in the LICENSE file that accompanied this code.
- *
- * This code is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- * version 2 for more details (a copy is included in the LICENSE file that
- * accompanied this code).
- *
- * You should have received a copy of the GNU General Public License version
- * 2 along with this work; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
- * or visit www.oracle.com if you need additional information or have any
- * questions.
- */
-package javax.xml.catalog;
-
-import javax.xml.transform.Source;
-import javax.xml.transform.URIResolver;
-
-/**
- * A JAXP URIResolver that uses catalogs to resolve references.
- *
- * @since 9
- */
-public interface CatalogUriResolver extends URIResolver {
-
- /**
- * The method searches through the catalog entries in the main and
- * alternative catalogs to attempt to find a match with the specified URI.
- *
- * @param href an href attribute, which may be relative or absolute
- * @param base The base URI against which the href attribute will be made
- * absolute if the absolute URI is required
- *
- * @return a {@link javax.xml.transform.Source} object if a mapping is found.
- * If no mapping is found, returns an empty {@link javax.xml.transform.Source}
- * object if the {@code javax.xml.catalog.resolve} property is set to
- * {@code ignore};
- * returns a {@link javax.xml.transform.Source} object with the original URI
- * (href, or href resolved with base if base is not null) if the
- * {@code javax.xml.catalog.resolve} property is set to {@code continue}.
- *
- * @throws CatalogException if no mapping is found and
- * {@code javax.xml.catalog.resolve} is specified as strict
- */
- @Override
- public Source resolve(String href, String base);
-}
--- a/jaxp/src/java.xml/share/classes/javax/xml/catalog/CatalogUriResolverImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,191 +0,0 @@
-/*
- * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 only, as
- * published by the Free Software Foundation. Oracle designates this
- * particular file as subject to the "Classpath" exception as provided
- * by Oracle in the LICENSE file that accompanied this code.
- *
- * This code is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- * version 2 for more details (a copy is included in the LICENSE file that
- * accompanied this code).
- *
- * You should have received a copy of the GNU General Public License version
- * 2 along with this work; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
- * or visit www.oracle.com if you need additional information or have any
- * questions.
- */
-package javax.xml.catalog;
-
-import com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl;
-import java.io.StringReader;
-import java.net.URL;
-import java.util.Iterator;
-import javax.xml.parsers.ParserConfigurationException;
-import javax.xml.parsers.SAXParserFactory;
-import javax.xml.transform.Source;
-import javax.xml.transform.sax.SAXSource;
-import org.xml.sax.InputSource;
-import org.xml.sax.SAXException;
-import org.xml.sax.XMLReader;
-
-/**
- * A SAX EntityResolver/JAXP URIResolver that uses catalogs.
- * <p>
- * This class implements both a SAX EntityResolver and a JAXP URIResolver.
- *
- *
- * @since 9
- */
-final class CatalogUriResolverImpl implements CatalogUriResolver {
-
- Catalog catalog;
- CatalogResolverImpl entityResolver;
-
- /**
- * Construct an instance of the CatalogResolver from a Catalog.
- *
- * @param catalog A Catalog.
- */
- public CatalogUriResolverImpl(Catalog catalog) {
- this.catalog = catalog;
- }
-
- @Override
- public Source resolve(String href, String base) {
- href = Util.getNotNullOrEmpty(href);
- base = Util.getNotNullOrEmpty(base);
-
- if (href == null) return null;
-
- String result = null;
- CatalogImpl c = (CatalogImpl)catalog;
- String uri = Normalizer.normalizeURI(href);
- //check whether uri is an urn
- if (uri != null && uri.startsWith(Util.URN)) {
- String publicId = Normalizer.decodeURN(uri);
- if (publicId != null) {
- result = Util.resolve(c, publicId, null);
- }
- }
-
- //if no match with a public id, continue search for an URI
- if (result == null) {
- //remove fragment if any.
- int hashPos = uri.indexOf("#");
- if (hashPos >= 0) {
- uri = uri.substring(0, hashPos);
- }
-
- //search the current catalog
- result = resolve(c, uri);
- }
-
- //Report error or return the URI as is when no match is found
- if (result == null) {
- GroupEntry.ResolveType resolveType = c.getResolve();
- switch (resolveType) {
- case IGNORE:
- return new SAXSource(new InputSource(new StringReader("")));
- case STRICT:
- CatalogMessages.reportError(CatalogMessages.ERR_NO_URI_MATCH,
- new Object[]{href, base});
- }
- try {
- URL url = null;
-
- if (base == null) {
- url = new URL(uri);
- result = url.toString();
- } else {
- URL baseURL = new URL(base);
- url = (href.length() == 0 ? baseURL : new URL(baseURL, uri));
- result = url.toString();
- }
- } catch (java.net.MalformedURLException mue) {
- CatalogMessages.reportError(CatalogMessages.ERR_CREATING_URI,
- new Object[]{href, base});
- }
- }
-
- SAXSource source = new SAXSource();
- source.setInputSource(new InputSource(result));
- setEntityResolver(source);
- return source;
- }
-
- /**
- * Resolves the publicId or systemId to one specified in the catalog.
- * @param catalog the catalog
- * @param href an href attribute, which may be relative or absolute
- * @return the resolved systemId if a match is found, null otherwise
- */
- String resolve(CatalogImpl catalog, String href) {
- String result = null;
-
- //search the current catalog
- catalog.reset();
- if (href != null) {
- result = catalog.matchURI(href);
- }
-
- //mark the catalog as having been searched before trying alternatives
- catalog.markAsSearched();
-
- //search alternative catalogs
- if (result == null) {
- Iterator<Catalog> iter = catalog.catalogs().iterator();
- while (iter.hasNext()) {
- result = resolve((CatalogImpl)iter.next(), href);
- if (result != null) {
- break;
- }
- }
- }
-
- return result;
- }
-
- /**
- * Establish an entityResolver for newly resolved URIs.
- * <p>
- * This is called from the URIResolver to set an EntityResolver on the SAX
- * parser to be used for new XML documents that are encountered as a result
- * of the document() function, xsl:import, or xsl:include. This is done
- * because the XSLT processor calls out to the SAXParserFactory itself to
- * create a new SAXParser to parse the new document. The new parser does not
- * automatically inherit the EntityResolver of the original (although
- * arguably it should). Quote from JAXP specification on Class
- * SAXTransformerFactory:
- * <p>
- * {@code If an application wants to set the ErrorHandler or EntityResolver
- * for an XMLReader used during a transformation, it should use a URIResolver
- * to return the SAXSource which provides (with getXMLReader) a reference to
- * the XMLReader}
- *
- */
- private void setEntityResolver(SAXSource source) {
- XMLReader reader = source.getXMLReader();
- if (reader == null) {
- SAXParserFactory spFactory = new SAXParserFactoryImpl();
- spFactory.setNamespaceAware(true);
- try {
- reader = spFactory.newSAXParser().getXMLReader();
- } catch (ParserConfigurationException | SAXException ex) {
- CatalogMessages.reportRunTimeError(CatalogMessages.ERR_PARSER_CONF, ex);
- }
- }
- if (entityResolver != null) {
- entityResolver = new CatalogResolverImpl(catalog);
- }
- reader.setEntityResolver(entityResolver);
- source.setXMLReader(reader);
- }
-}
--- a/jaxp/src/java.xml/share/classes/javax/xml/catalog/Util.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/src/java.xml/share/classes/javax/xml/catalog/Util.java Tue Aug 30 08:45:21 2016 -0700
@@ -55,6 +55,9 @@
* prefer "public": attempts to resolve with a system entry;
* attempts to resolve with a public entry if no matching
* system entry is found.
+ *
+ * If no match is found, continue searching uri entries
+ *
* @param catalog the catalog
* @param publicId the publicId
* @param systemId the systemId
@@ -77,6 +80,10 @@
resolvedSystemId = catalog.matchPublic(publicId);
}
+ if (resolvedSystemId == null && systemId != null) {
+ resolvedSystemId = catalog.matchURI(systemId);
+ }
+
//mark the catalog as having been searched before trying alternatives
catalog.markAsSearched();
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/CatalogReferCircularityTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/CatalogReferCircularityTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -64,4 +64,3 @@
{ "catalogReferCircle-left.xml" } };
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/DefaultFeaturesTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/DefaultFeaturesTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -69,4 +69,3 @@
{ Feature.RESOLVE, CatalogTestUtils.RESOLVE_STRICT } };
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/DeferFeatureTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/DeferFeatureTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -86,4 +86,3 @@
return (int) method.invoke(catalog);
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/DelegatePublicTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/DelegatePublicTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -100,4 +100,3 @@
return catalogResolver("delegatePublic.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/DelegateSystemTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/DelegateSystemTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -100,4 +100,3 @@
return catalogResolver("delegateSystem.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/DelegateUriTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/DelegateUriTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -27,8 +27,8 @@
import static catalog.ResolutionChecker.checkUriResolution;
import static catalog.ResolutionChecker.expectExceptionOnUri;
+import javax.xml.catalog.CatalogResolver;
import javax.xml.catalog.CatalogException;
-import javax.xml.catalog.CatalogUriResolver;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Listeners;
@@ -95,8 +95,7 @@
CatalogException.class } };
}
- private CatalogUriResolver createResolver() {
+ private CatalogResolver createResolver() {
return catalogUriResolver("delegateUri.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/GroupTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/GroupTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -131,4 +131,3 @@
return catalogResolver(CATALOG_GROUP);
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/LoadCatalogTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/LoadCatalogTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -33,7 +33,6 @@
import javax.xml.catalog.CatalogException;
import javax.xml.catalog.CatalogResolver;
-import javax.xml.catalog.CatalogUriResolver;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Listeners;
@@ -56,6 +55,7 @@
private static final String CATALOG_DUMMY = "dummy.xml";
private static final String ID_ALICE = "http://remote/dtd/alice/docAlice.dtd";
+ private static final String ID_ALICE_URI = "http://remote/dtd/uri/alice/docAlice.dtd";
private static final String ID_DUMMY = "http://remote/dtd/doc.dtd";
@Test(dataProvider = "entityResolver")
@@ -79,8 +79,8 @@
}
@Test(dataProvider = "uriResolver")
- public void testMatchOnUriResolver(CatalogUriResolver resolver) {
- checkUriResolution(resolver, ID_ALICE,
+ public void testMatchOnUriResolver(CatalogResolver resolver) {
+ checkUriResolution(resolver, ID_ALICE_URI,
"http://local/dtd/docAliceURI.dtd");
}
@@ -121,4 +121,3 @@
{ new String[] { CATALOG_LOADCATALOGFILES } } };
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/NextCatalogTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/NextCatalogTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -30,7 +30,6 @@
import static catalog.ResolutionChecker.checkUriResolution;
import javax.xml.catalog.CatalogResolver;
-import javax.xml.catalog.CatalogUriResolver;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Listeners;
@@ -154,9 +153,8 @@
CATALOG_NEXTCATALOGRIGHT);
}
- private CatalogUriResolver createUriResolver() {
+ private CatalogResolver createUriResolver() {
return catalogUriResolver(CATALOG_NEXTCATALOGLEFT,
CATALOG_NEXTCATALOGRIGHT);
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/NormalizationTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/NormalizationTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -30,7 +30,6 @@
import static catalog.ResolutionChecker.checkUriResolution;
import javax.xml.catalog.CatalogResolver;
-import javax.xml.catalog.CatalogUriResolver;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Listeners;
@@ -111,8 +110,7 @@
return catalogResolver(CATALOG_NORMALIZATION);
}
- private CatalogUriResolver createUriResolver() {
+ private CatalogResolver createUriResolver() {
return catalogUriResolver(CATALOG_NORMALIZATION);
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/PreferFeatureTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/PreferFeatureTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -81,4 +81,3 @@
"preferFeature.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/PreferTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/PreferTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -92,4 +92,3 @@
return catalogResolver("prefer.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/PublicFamilyTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/PublicFamilyTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -70,4 +70,3 @@
return catalogResolver("publicFamily.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/PublicTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/PublicTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -92,4 +92,3 @@
return catalogResolver(CATALOG_PUBLIC);
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/ResolveFeatureTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/ResolveFeatureTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -38,7 +38,6 @@
import javax.xml.catalog.CatalogFeatures;
import javax.xml.catalog.CatalogFeatures.Feature;
import javax.xml.catalog.CatalogResolver;
-import javax.xml.catalog.CatalogUriResolver;
import org.testng.annotations.Listeners;
import org.testng.annotations.Test;
@@ -93,7 +92,7 @@
*/
@Test
public void testContinueResolutionOnUriResolver() {
- CatalogUriResolver resolver = createUriResolver(RESOLVE_CONTINUE);
+ CatalogResolver resolver = createUriResolver(RESOLVE_CONTINUE);
resolver.resolve("http://remote/dtd/bob/docBobDummy.dtd", null);
checkUriResolution(resolver, "http://remote/dtd/bob/docBob.dtd",
"http://local/base/dtd/docBobURI.dtd");
@@ -123,7 +122,7 @@
return catalogResolver(createFeature(resolve), CATALOG_SYSTEM);
}
- private CatalogUriResolver createUriResolver(String resolve) {
+ private CatalogResolver createUriResolver(String resolve) {
return catalogUriResolver(createFeature(resolve), CATALOG_URI);
}
@@ -131,4 +130,3 @@
return builder().with(Feature.RESOLVE, resolve).build();
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/RewriteSystemTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/RewriteSystemTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -95,4 +95,3 @@
return catalogResolver("rewriteSystem.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/RewriteUriTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/RewriteUriTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -24,11 +24,11 @@
package catalog;
import static catalog.CatalogTestUtils.catalogUriResolver;
-import static catalog.ResolutionChecker.checkNoMatch;
+import static catalog.ResolutionChecker.checkNoUriMatch;
import static catalog.ResolutionChecker.checkUriResolution;
+import javax.xml.catalog.CatalogResolver;
import javax.xml.catalog.CatalogException;
-import javax.xml.catalog.CatalogUriResolver;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Listeners;
@@ -88,11 +88,10 @@
*/
@Test(expectedExceptions = CatalogException.class)
public void testNoMatch() {
- checkNoMatch(createResolver());
+ checkNoUriMatch(createResolver());
}
- private CatalogUriResolver createResolver() {
+ private CatalogResolver createResolver() {
return catalogUriResolver("rewriteUri.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/SpecifyCatalogTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/SpecifyCatalogTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -36,7 +36,6 @@
import javax.xml.catalog.CatalogFeatures;
import javax.xml.catalog.CatalogResolver;
-import javax.xml.catalog.CatalogUriResolver;
import org.testng.annotations.Listeners;
import org.testng.annotations.Test;
@@ -68,7 +67,7 @@
}
/*
- * CatalogUriResolver specifies catalog via feature javax.xml.catalog.files.
+ * CatalogResolver specifies catalog via feature javax.xml.catalog.files.
*/
@Test
public void specifyCatalogOnUriResolver() {
@@ -102,7 +101,7 @@
checkSysIdResolution(resolver, ID_SYS, matchedUri);
}
- private void checkResolutionOnUriResolver(CatalogUriResolver resolver,
+ private void checkResolutionOnUriResolver(CatalogResolver resolver,
String matchedUri) {
checkUriResolution(resolver, ID_URI, matchedUri);
}
@@ -111,4 +110,3 @@
return builder().with(FILES, getCatalogPath(catalogName)).build();
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/SystemFamilyTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/SystemFamilyTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -84,4 +84,3 @@
return catalogResolver("systemFamily.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/SystemSuffixTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/SystemSuffixTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -95,4 +95,3 @@
return catalogResolver("systemSuffix.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/SystemTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/SystemTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -92,4 +92,3 @@
return catalogResolver(CATALOG_SYSTEM);
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/UriFamilyTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/UriFamilyTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -24,11 +24,11 @@
package catalog;
import static catalog.CatalogTestUtils.catalogUriResolver;
-import static catalog.ResolutionChecker.checkNoMatch;
+import static catalog.ResolutionChecker.checkNoUriMatch;
import static catalog.ResolutionChecker.checkUriResolution;
+import javax.xml.catalog.CatalogResolver;
import javax.xml.catalog.CatalogException;
-import javax.xml.catalog.CatalogUriResolver;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Listeners;
@@ -58,7 +58,7 @@
return new Object[][] {
// The matched URI of the specified URI reference is defined in
// a uri entry.
- { "http://remote/dtd/alice/docAlice.dtd",
+ { "http://remote/dtd/uri/alice/docAlice.dtd",
"http://local/base/dtd/docAliceURI.dtd" },
// The matched URI of the specified URI reference is defined in
@@ -77,11 +77,10 @@
*/
@Test(expectedExceptions = CatalogException.class)
public void testNoMatch() {
- checkNoMatch(createResolver());
+ checkNoUriMatch(createResolver());
}
- private CatalogUriResolver createResolver() {
+ private CatalogResolver createResolver() {
return catalogUriResolver("uriFamily.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/UriSuffixTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/UriSuffixTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -24,11 +24,11 @@
package catalog;
import static catalog.CatalogTestUtils.catalogUriResolver;
-import static catalog.ResolutionChecker.checkNoMatch;
+import static catalog.ResolutionChecker.checkNoUriMatch;
import static catalog.ResolutionChecker.checkUriResolution;
+import javax.xml.catalog.CatalogResolver;
import javax.xml.catalog.CatalogException;
-import javax.xml.catalog.CatalogUriResolver;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Listeners;
@@ -88,11 +88,10 @@
*/
@Test(expectedExceptions = CatalogException.class)
public void testNoMatch() {
- checkNoMatch(createResolver());
+ checkNoUriMatch(createResolver());
}
- private CatalogUriResolver createResolver() {
+ private CatalogResolver createResolver() {
return catalogUriResolver("uriSuffix.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/UriTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/UriTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -26,12 +26,12 @@
import static catalog.CatalogTestUtils.CATALOG_URI;
import static catalog.CatalogTestUtils.RESOLVE_CONTINUE;
import static catalog.CatalogTestUtils.catalogUriResolver;
-import static catalog.ResolutionChecker.checkNoMatch;
+import static catalog.ResolutionChecker.checkNoUriMatch;
import static catalog.ResolutionChecker.checkUriResolution;
+import javax.xml.catalog.CatalogResolver;
import javax.xml.catalog.CatalogException;
import javax.xml.catalog.CatalogFeatures;
-import javax.xml.catalog.CatalogUriResolver;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Listeners;
@@ -58,7 +58,7 @@
return new Object[][] {
// The matched URI of the specified URI reference is defined in
// a uri entry. The match is an absolute path.
- { "http://remote/dtd/alice/docAlice.dtd",
+ { "http://remote/dtd/uri/alice/docAlice.dtd",
"http://local/dtd/docAliceURI.dtd" },
// The matched URI of the specified URI reference is defined in
@@ -76,7 +76,7 @@
}
/*
- * Specify base location via method CatalogUriResolver.resolve(href, base).
+ * Specify base location via method CatalogResolver.resolve(href, base).
*/
@Test
public void testSpecifyBaseByAPI() {
@@ -84,7 +84,7 @@
"http://remote/dtd/carl/docCarl.dtd",
"http://local/carlBase/dtd/docCarlURI.dtd");
- CatalogUriResolver continueResolver = catalogUriResolver(
+ CatalogResolver continueResolver = catalogUriResolver(
CatalogFeatures.builder().with(CatalogFeatures.Feature.RESOLVE,
RESOLVE_CONTINUE).build(), CATALOG_URI);
checkUriResolution(continueResolver, "docCarl.dtd",
@@ -97,11 +97,10 @@
*/
@Test(expectedExceptions = CatalogException.class)
public void testNoMatch() {
- checkNoMatch(createResolver());
+ checkNoUriMatch(createResolver());
}
- private CatalogUriResolver createResolver() {
+ private CatalogResolver createResolver() {
return catalogUriResolver(CATALOG_URI);
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/UrnUnwrappingTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/UrnUnwrappingTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -67,4 +67,3 @@
return catalogResolver("urnUnwrapping.xml");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/ValidateCatalogTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/ValidateCatalogTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -98,8 +98,7 @@
"http://remote/dtd/alice/docAlice.dtd",
"http://local/dtd/docAliceSys.dtd");
checkUriResolution(catalogUriResolver(catalogName, CATALOG_URI),
- "http://remote/dtd/alice/docAlice.dtd",
+ "http://remote/dtd/uri/alice/docAlice.dtd",
"http://local/dtd/docAliceURI.dtd");
}
}
-
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/catalogFiles/deferFeature.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/catalogFiles/deferFeature.xml Tue Aug 30 08:45:21 2016 -0700
@@ -2,7 +2,7 @@
<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
<system systemId="http://remote/dtd/alice/docAlice.dtd" uri="http://local/dtd/docAliceSys.dtd" />
- <uri name="http://remote/dtd/alice/docAlice.dtd" uri="http://local/dtd/docAliceURI.dtd" />
+ <uri name="http://remote/dtd/uri/alice/docAlice.dtd" uri="http://local/dtd/docAliceURI.dtd" />
<delegateSystem systemIdStartString="http://remote/dtd/alice/" catalog="delegateSystem-alice.xml" />
<delegatePublic publicIdStartString="-//REMOTE//DTD ALICE DOCALICE" catalog="delegatePublic-alice.xml" />
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/catalogFiles/uri.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/catalogFiles/uri.xml Tue Aug 30 08:45:21 2016 -0700
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog" xml:base="http://local/base/dtd/">
- <uri name="http://remote/dtd/alice/docAlice.dtd" uri="http://local/dtd/docAliceURI.dtd" />
+ <uri name="http://remote/dtd/uri/alice/docAlice.dtd" uri="http://local/dtd/docAliceURI.dtd" />
<uri name="http://remote/dtd/bob/docBob.dtd" uri="docBobURI.dtd" />
--- a/jaxp/test/javax/xml/jaxp/functional/catalog/catalogFiles/uriFamily.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/functional/catalog/catalogFiles/uriFamily.xml Tue Aug 30 08:45:21 2016 -0700
@@ -4,7 +4,7 @@
<delegateURI uriStartString="http://remote/dtd/alice/" catalog="delegateURI-alice.xml" />
<uriSuffix uriSuffix="docAlice.dtd" uri="docAliceUS.dtd" />
<rewriteURI uriStartString="http://remote/dtd/alice/" rewritePrefix="http://local/base/ru/" />
- <uri name="http://remote/dtd/alice/docAlice.dtd" uri="docAliceURI.dtd" />
+ <uri name="http://remote/dtd/uri/alice/docAlice.dtd" uri="docAliceURI.dtd" />
<delegateURI uriStartString="http://remote/dtd/bob/" catalog="delegateURI-bob.xml" />
<uriSuffix uriSuffix="docBob.dtd" uri="docBobUS.dtd" />
--- a/jaxp/test/javax/xml/jaxp/isolatedjdk/catalog/PropertiesTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/isolatedjdk/catalog/PropertiesTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -42,7 +42,6 @@
import java.util.Map;
import javax.xml.catalog.CatalogResolver;
-import javax.xml.catalog.CatalogUriResolver;
/*
* This case tests if the properties FILES, DEFER, PREFER, RESOLVE in
@@ -96,7 +95,7 @@
}
private static void testPropertiesOnUriResolver() {
- CatalogUriResolver uriResolver = catalogUriResolver((String[]) null);
+ CatalogResolver uriResolver = catalogUriResolver((String[]) null);
uriResolver.resolve("http://remote/uri/dtd/docDummy.dtd", null);
"http://local/base/dtd/docURI.dtd".equals(uriResolver.resolve(
"http://remote/dtd/doc.dtd", null).getSystemId());
--- a/jaxp/test/javax/xml/jaxp/libs/catalog/CatalogTestUtils.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/libs/catalog/CatalogTestUtils.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -35,7 +35,6 @@
import javax.xml.catalog.CatalogFeatures;
import javax.xml.catalog.CatalogManager;
import javax.xml.catalog.CatalogResolver;
-import javax.xml.catalog.CatalogUriResolver;
import jaxp.library.JAXPTestUtilities;
@@ -101,18 +100,18 @@
/*
* Creates catalogUriResolver with a set of catalogs.
*/
- static CatalogUriResolver catalogUriResolver(String... catalogName) {
+ static CatalogResolver catalogUriResolver(String... catalogName) {
return catalogUriResolver(CatalogFeatures.defaults(), catalogName);
}
/*
* Creates catalogUriResolver with a feature and a set of catalogs.
*/
- static CatalogUriResolver catalogUriResolver(
+ static CatalogResolver catalogUriResolver(
CatalogFeatures features, String... catalogName) {
return (catalogName == null) ?
- CatalogManager.catalogUriResolver(features) :
- CatalogManager.catalogUriResolver(features, getCatalogPaths(catalogName));
+ CatalogManager.catalogResolver(features) :
+ CatalogManager.catalogResolver(features, getCatalogPaths(catalogName));
}
// Gets the paths of the specified catalogs.
--- a/jaxp/test/javax/xml/jaxp/libs/catalog/ResolutionChecker.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/libs/catalog/ResolutionChecker.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -24,7 +24,6 @@
package catalog;
import javax.xml.catalog.CatalogResolver;
-import javax.xml.catalog.CatalogUriResolver;
import org.testng.Assert;
@@ -65,7 +64,7 @@
* Checks the resolution result for specified URI references
* with the specified base location.
*/
- static void checkUriResolution(CatalogUriResolver resolver,
+ static void checkUriResolution(CatalogResolver resolver,
String href, String base, String matchedUri) {
Assert.assertEquals(resolver.resolve(href, base).getSystemId(),
matchedUri);
@@ -74,7 +73,7 @@
/*
* Checks the resolution result for specified URI references.
*/
- static void checkUriResolution(CatalogUriResolver resolver,
+ static void checkUriResolution(CatalogResolver resolver,
String href, String matchedUri) {
checkUriResolution(resolver, href, null, matchedUri);
}
@@ -92,9 +91,9 @@
/*
* With strict resolution, if no match is found,
- * CatalogUriResolver should throw CatalogException.
+ * CatalogResolver should throw CatalogException.
*/
- static void checkNoMatch(CatalogUriResolver resolver) {
+ static void checkNoUriMatch(CatalogResolver resolver) {
resolver.resolve("http://uri/noMatch/docNoMatch.dtd", getNotSpecified(null));
}
@@ -139,7 +138,7 @@
* URI reference with a specified base location.
*/
static <T extends Throwable> void expectExceptionOnUri(
- CatalogUriResolver resolver, String href, String base,
+ CatalogResolver resolver, String href, String base,
Class<T> expectedExceptionClass) {
expectThrows(expectedExceptionClass, () -> {
resolver.resolve(href, base);
@@ -151,7 +150,7 @@
* URI reference without any specified base location.
*/
static <T extends Throwable> void expectExceptionOnUri(
- CatalogUriResolver resolver, String href,
+ CatalogResolver resolver, String href,
Class<T> expectedExceptionClass) {
expectExceptionOnUri(resolver, href, null, expectedExceptionClass);
}
--- a/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport.java Tue Aug 30 08:45:21 2016 -0700
@@ -327,4 +327,3 @@
};
}
}
-
--- a/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport.xml Tue Aug 30 08:45:21 2016 -0700
@@ -11,32 +11,32 @@
<!-- public publicId="datatypes" uri="datatypes.dtd"/-->
<!-- XInclude -->
- <uri name="XI_simple.xml" uri="XI_simple4Catalog.xml"/>
- <uri name="XI_utf8.xml" uri="XI_utf8.xml"/>
- <uri name="XI_utf8Catalog.xml" uri="XI_utf8Catalog.xml"/>
- <uri name="XI_test2.xml" uri="XI_test2.xml"/>
+ <system systemId="XI_simple.xml" uri="XI_simple4Catalog.xml"/>
+ <system systemId="XI_utf8.xml" uri="XI_utf8.xml"/>
+ <system systemId="XI_utf8Catalog.xml" uri="XI_utf8Catalog.xml"/>
+ <system systemId="XI_test2.xml" uri="XI_test2.xml"/>
<system systemId="XI_red.dtd" uri="XI_red.dtd"/>
<!-- xsd import can be mapped using the namespace or systemId -->
<!--public publicId="http://www.w3.org/XML/1998/namespace" uri="xml.xsd"/-->
<!--uri name="http://www.w3.org/XML/1998/namespace" uri="xml.xsd"/-->
- <uri name="http://www.w3.org/2001/pathto/xml.xsd" uri="xml.xsd"/>
+ <system systemId="http://www.w3.org/2001/pathto/xml.xsd" uri="xml.xsd"/>
<!-- schema include -->
- <uri name="pathto/XSDInclude_person.xsd" uri="XSDInclude_person.xsd"/>
- <uri name="pathto/XSDInclude_product.xsd" uri="XSDInclude_product.xsd"/>
+ <system systemId="pathto/XSDInclude_person.xsd" uri="XSDInclude_person.xsd"/>
+ <system systemId="pathto/XSDInclude_product.xsd" uri="XSDInclude_product.xsd"/>
<!-- for relative path, use Suffix -->
<systemSuffix systemIdSuffix="pathto/val_test.xsd" uri="val_test.xsd"/>
<!-- XSL import and include -->
- <uri name="pathto/XSLImport_html.xsl" uri="XSLImport_html.xsl"/>
- <uri name="pathto/XSLInclude_header.xsl" uri="XSLInclude_header.xsl"/>
- <uri name="pathto/XSLInclude_footer.xsl" uri="XSLInclude_footer.xsl"/>
+ <system systemId="pathto/XSLImport_html.xsl" uri="XSLImport_html.xsl"/>
+ <system systemId="pathto/XSLInclude_header.xsl" uri="XSLInclude_header.xsl"/>
+ <system systemId="pathto/XSLInclude_footer.xsl" uri="XSLInclude_footer.xsl"/>
<!-- and DTDs -->
<system systemId="http://openjdk.java.net/xml/catalog/dtd/XSLDTD.dtd" uri="XSLDTD.dtd"/>
<system systemId="http://openjdk.java.net/xml/catalog/dtd/include.dtd" uri="include.dtd"/>
<!-- XSLT document function -->
- <uri name="pathto/DocFunc2.xml" uri="DocFuncCatalog.xml"/>
+ <system systemId="pathto/DocFunc2.xml" uri="DocFuncCatalog.xml"/>
</catalog>
--- a/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport1.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport1.java Tue Aug 30 08:45:21 2016 -0700
@@ -268,4 +268,3 @@
}
}
-
--- a/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport2.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport2.java Tue Aug 30 08:45:21 2016 -0700
@@ -270,4 +270,3 @@
};
}
}
-
--- a/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport3.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport3.java Tue Aug 30 08:45:21 2016 -0700
@@ -280,4 +280,3 @@
};
}
}
-
--- a/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport4.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport4.java Tue Aug 30 08:45:21 2016 -0700
@@ -269,4 +269,3 @@
};
}
}
-
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport5.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,250 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package catalog;
+
+import java.io.File;
+import java.io.StringReader;
+import javax.xml.transform.Source;
+import javax.xml.transform.TransformerException;
+import javax.xml.transform.URIResolver;
+import javax.xml.transform.dom.DOMSource;
+import javax.xml.transform.sax.SAXSource;
+import javax.xml.transform.stax.StAXSource;
+import javax.xml.transform.stream.StreamSource;
+import org.testng.annotations.AfterClass;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Listeners;
+import org.testng.annotations.Test;
+import org.w3c.dom.ls.LSResourceResolver;
+import org.xml.sax.InputSource;
+import org.xml.sax.SAXException;
+
+/*
+ * @test
+ * @bug 8158084 8163232
+ * @library /javax/xml/jaxp/libs /javax/xml/jaxp/unittest
+ * @run testng/othervm -DrunSecMngr=true catalog.CatalogSupport5
+ * @run testng/othervm catalog.CatalogSupport5
+ * @summary extends CatalogSupport tests, verifies that when errors occur,
+ * relevant checked Exceptions are returned.
+ */
+/**
+ * The CatalogResolver will throw CatalogException when there is no match and
+ * the resolve property is strict. The Exception should be caught with the existing
+ * mechanisms so that the checked Exception corresponding to the process can be
+ * returned.
+ *
+ * @author huizhe.wang@oracle.com
+ */
+@Listeners({jaxp.library.FilePolicy.class, jaxp.library.NetAccessPolicy.class})
+public class CatalogSupport5 extends CatalogSupportBase {
+
+ /*
+ * Initializing fields
+ */
+ @BeforeClass
+ public void setUpClass() throws Exception {
+ setUp();
+ }
+
+
+ /*
+ Verifies the Catalog support on SAXParser.
+ */
+ @Test(dataProvider = "data_SAXC", expectedExceptions = SAXException.class)
+ public void testSAXC(boolean setUseCatalog, boolean useCatalog, String catalog, String
+ xml, MyHandler handler, String expected) throws Exception {
+ testSAX(setUseCatalog, useCatalog, catalog, xml, handler, expected);
+ }
+
+ /*
+ Verifies the Catalog support on XMLReader.
+ */
+ @Test(dataProvider = "data_SAXC", expectedExceptions = SAXException.class)
+ public void testXMLReaderC(boolean setUseCatalog, boolean useCatalog, String catalog,
+ String xml, MyHandler handler, String expected) throws Exception {
+ testXMLReader(setUseCatalog, useCatalog, catalog, xml, handler, expected);
+ }
+
+ /*
+ Verifies the Catalog support on XInclude.
+ */
+ @Test(dataProvider = "data_XIC", expectedExceptions = SAXException.class)
+ public void testXIncludeC(boolean setUseCatalog, boolean useCatalog, String catalog,
+ String xml, MyHandler handler, String expected) throws Exception {
+ testXInclude(setUseCatalog, useCatalog, catalog, xml, handler, expected);
+ }
+
+ /*
+ Verifies the Catalog support on DOM parser.
+ */
+ @Test(dataProvider = "data_DOMC", expectedExceptions = SAXException.class)
+ public void testDOMC(boolean setUseCatalog, boolean useCatalog, String catalog,
+ String xml, MyHandler handler, String expected) throws Exception {
+ testDOM(setUseCatalog, useCatalog, catalog, xml, handler, expected);
+ }
+
+ /*
+ Verifies the Catalog support on resolving DTD, xsd import and include in
+ Schema files.
+ */
+ @Test(dataProvider = "data_SchemaC", expectedExceptions = SAXException.class)
+ public void testValidationC(boolean setUseCatalog, boolean useCatalog, String catalog,
+ String xsd, LSResourceResolver resolver)
+ throws Exception {
+ testValidation(setUseCatalog, useCatalog, catalog, xsd, resolver) ;
+ }
+
+ @Test(dataProvider = "data_ValidatorC", expectedExceptions = SAXException.class)
+ public void testValidatorC(boolean setUseCatalog1, boolean setUseCatalog2, boolean useCatalog,
+ Source source, LSResourceResolver resolver1, LSResourceResolver resolver2,
+ String catalog1, String catalog2)
+ throws Exception {
+ testValidator(setUseCatalog1, setUseCatalog2, useCatalog, source,
+ resolver1, resolver2, catalog1, catalog2);
+ }
+
+ /*
+ Verifies the Catalog support on resolving DTD, xsl import and include in
+ XSL files.
+ */
+ @Test(dataProvider = "data_XSLC", expectedExceptions = TransformerException.class)
+ public void testXSLImportC(boolean setUseCatalog, boolean useCatalog, String catalog,
+ SAXSource xsl, StreamSource xml, URIResolver resolver, String expected) throws Exception {
+
+ testXSLImport(setUseCatalog, useCatalog, catalog, xsl, xml, resolver, expected);
+ }
+
+ /*
+ @bug 8158084 8162442
+ Verifies the Catalog support on resolving DTD, xsl import and include in
+ XSL files.
+ */
+ @Test(dataProvider = "data_XSLC", expectedExceptions = TransformerException.class)
+ public void testXSLImportWTemplatesC(boolean setUseCatalog, boolean useCatalog, String catalog,
+ SAXSource xsl, StreamSource xml, URIResolver resolver, String expected) throws Exception {
+ testXSLImportWTemplates(setUseCatalog, useCatalog, catalog, xsl, xml, resolver, expected);
+ }
+
+ /*
+ DataProvider: for testing the SAX parser
+ Data: set use_catalog, use_catalog, catalog file, xml file, handler, expected result string
+ */
+ @DataProvider(name = "data_SAXC")
+ public Object[][] getDataSAXC() {
+ return new Object[][]{
+ {false, true, xml_bogus_catalog, xml_system, new MyHandler(elementInSystem), expectedWCatalog}
+
+ };
+ }
+
+ /*
+ DataProvider: for testing XInclude
+ Data: set use_catalog, use_catalog, catalog file, xml file, handler, expected result string
+ */
+ @DataProvider(name = "data_XIC")
+ public Object[][] getDataXIC() {
+ return new Object[][]{
+ {false, true, xml_bogus_catalog, xml_xInclude, new MyHandler(elementInXISimple), contentInUIutf8Catalog},
+ };
+ }
+
+ /*
+ DataProvider: for testing DOM parser
+ Data: set use_catalog, use_catalog, catalog file, xml file, handler, expected result string
+ */
+ @DataProvider(name = "data_DOMC")
+ public Object[][] getDataDOMC() {
+ return new Object[][]{
+ {false, true, xml_bogus_catalog, xml_system, new MyHandler(elementInSystem), expectedWCatalog}
+ };
+ }
+
+ /*
+ DataProvider: for testing Schema validation
+ Data: set use_catalog, use_catalog, catalog file, xsd file, a LSResourceResolver
+ */
+ @DataProvider(name = "data_SchemaC")
+ public Object[][] getDataSchemaC() {
+
+ return new Object[][]{
+ // for resolving DTD in xsd
+ {false, true, xml_bogus_catalog, xsd_xmlSchema, null},
+ // for resolving xsd import
+ {false, true, xml_bogus_catalog, xsd_xmlSchema_import, null},
+ // for resolving xsd include
+ {false, true, xml_bogus_catalog, xsd_include_company, null}
+ };
+ }
+
+ /*
+ DataProvider: for testing Schema Validator
+ Data: setUseCatalog1, setUseCatalog2, useCatalog, source, resolver1, resolver2,
+ catalog1, catalog2
+ */
+ @DataProvider(name = "data_ValidatorC")
+ public Object[][] getDataValidator() {
+ DOMSource ds = getDOMSource(xml_val_test, xml_val_test_id, true, true, xml_catalog);
+
+ SAXSource ss = new SAXSource(new InputSource(xml_val_test));
+ ss.setSystemId(xml_val_test_id);
+
+ StAXSource stax = getStaxSource(xml_val_test, xml_val_test_id);
+ StAXSource stax1 = getStaxSource(xml_val_test, xml_val_test_id);
+
+ StreamSource source = new StreamSource(new File(xml_val_test));
+
+ return new Object[][]{
+ // use catalog
+ {false, false, true, ds, null, null, xml_bogus_catalog, null},
+ {false, false, true, ds, null, null, null, xml_bogus_catalog},
+ {false, false, true, ss, null, null, xml_bogus_catalog, null},
+ {false, false, true, ss, null, null, null, xml_bogus_catalog},
+ {false, false, true, stax, null, null, xml_bogus_catalog, null},
+ {false, false, true, stax1, null, null, null, xml_bogus_catalog},
+ {false, false, true, source, null, null, xml_bogus_catalog, null},
+ {false, false, true, source, null, null, null, xml_bogus_catalog},
+ };
+ }
+
+ /*
+ DataProvider: for testing XSL import and include
+ Data: set use_catalog, use_catalog, catalog file, xsl file, xml file, a URIResolver, expected
+ */
+ @DataProvider(name = "data_XSLC")
+ public Object[][] getDataXSLC() {
+ SAXSource xslSourceDTD = new SAXSource(new InputSource(new StringReader(xsl_includeDTD)));
+ StreamSource xmlSourceDTD = new StreamSource(new StringReader(xml_xslDTD));
+
+ SAXSource xslDocSource = new SAXSource(new InputSource(new File(xsl_doc).toURI().toASCIIString()));
+ StreamSource xmlDocSource = new StreamSource(new File(xml_doc));
+ return new Object[][]{
+ // for resolving DTD, import and include in xsl
+ {false, true, xml_bogus_catalog, xslSourceDTD, xmlSourceDTD, null, ""},
+ // for resolving reference by the document function
+ {false, true, xml_bogus_catalog, xslDocSource, xmlDocSource, null, "Resolved by a catalog"},
+ };
+ }
+}
--- a/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupportBase.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupportBase.java Tue Aug 30 08:45:21 2016 -0700
@@ -35,9 +35,9 @@
import java.io.StringReader;
import java.io.StringWriter;
import java.io.UnsupportedEncodingException;
-
import javax.xml.XMLConstants;
import javax.xml.catalog.CatalogFeatures;
+import javax.xml.catalog.CatalogResolver;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
@@ -61,7 +61,6 @@
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;
-
import org.testng.Assert;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
@@ -677,6 +676,29 @@
}
+
+ /**
+ * Extends MyHandler and overrides resolveEntity with a CatalogResolver
+ */
+ class MyCatalogHandler extends MyHandler {
+ CatalogResolver cr;
+
+ public MyCatalogHandler(CatalogResolver cr, String elementName) {
+ super(elementName);
+ this.cr = cr;
+ }
+
+ @Override
+ public InputSource resolveEntity(String publicId, String systemId) {
+ return cr.resolveEntity(publicId, systemId);
+ }
+ @Override
+ public InputSource resolveEntity(String name, String publicId,
+ String baseURI, String systemId) {
+ return cr.resolveEntity(publicId, systemId);
+ }
+ }
+
/**
* Extends MyHandler and overrides resolveEntity
*/
@@ -935,4 +957,3 @@
}
}
}
-
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogSupport_uri.xml Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
+ <!-- DTDs and external entities -->
+ <uri name="http://openjdk.java.net/xml/catalog/dtd/system.dtd" uri="system.dtd"/>
+
+ <!-- XMLSchema refers to XMLSchema.dtd -->
+ <public publicId="-//W3C//DTD XMLSCHEMA 200102//EN" uri="XMLSchema.dtd"/>
+ <!-- XMLSchema.dtd refers to datatypes.dtd -->
+ <uriSuffix uriSuffix="datatypes.dtd" uri="datatypes.dtd"/>
+ <!-- XMLSchema.dtd refers to datatypes.dtd, can use public entry as well -->
+ <!-- public publicId="datatypes" uri="datatypes.dtd"/-->
+
+ <!-- XInclude -->
+ <uri name="XI_simple.xml" uri="XI_simple4Catalog.xml"/>
+ <uri name="XI_utf8.xml" uri="XI_utf8.xml"/>
+ <uri name="XI_utf8Catalog.xml" uri="XI_utf8Catalog.xml"/>
+ <uri name="XI_test2.xml" uri="XI_test2.xml"/>
+ <uri name="XI_red.dtd" uri="XI_red.dtd"/>
+
+ <!-- xsd import can be mapped using the namespace or systemId -->
+ <!--public publicId="http://www.w3.org/XML/1998/namespace" uri="xml.xsd"/-->
+ <!--uri name="http://www.w3.org/XML/1998/namespace" uri="xml.xsd"/-->
+ <uri name="http://www.w3.org/2001/pathto/xml.xsd" uri="xml.xsd"/>
+
+ <!-- schema include -->
+ <uri name="pathto/XSDInclude_person.xsd" uri="XSDInclude_person.xsd"/>
+ <uri name="pathto/XSDInclude_product.xsd" uri="XSDInclude_product.xsd"/>
+
+ <!-- for relative path, use Suffix -->
+ <uriSuffix uriSuffix="pathto/val_test.xsd" uri="val_test.xsd"/>
+
+ <!-- XSL import and include -->
+ <uri name="pathto/XSLImport_html.xsl" uri="XSLImport_html.xsl"/>
+ <uri name="pathto/XSLInclude_header.xsl" uri="XSLInclude_header.xsl"/>
+ <uri name="pathto/XSLInclude_footer.xsl" uri="XSLInclude_footer.xsl"/>
+ <!-- and DTDs -->
+ <uri name="http://openjdk.java.net/xml/catalog/dtd/XSLDTD.dtd" uri="XSLDTD.dtd"/>
+ <uri name="http://openjdk.java.net/xml/catalog/dtd/include.dtd" uri="include.dtd"/>
+
+ <!-- XSLT document function -->
+ <uri name="pathto/DocFunc2.xml" uri="DocFuncCatalog.xml"/>
+</catalog>
+
--- a/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/CatalogTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -26,23 +26,37 @@
import static jaxp.library.JAXPTestUtilities.getSystemProperty;
import static jaxp.library.JAXPTestUtilities.setSystemProperty;
+import java.io.File;
+import java.io.FileInputStream;
import java.io.FilePermission;
import java.io.IOException;
+import java.io.InputStream;
+import java.io.StringReader;
+import java.io.StringWriter;
import java.nio.file.Paths;
import java.util.PropertyPermission;
-
+import javax.xml.XMLConstants;
import javax.xml.catalog.Catalog;
import javax.xml.catalog.CatalogException;
import javax.xml.catalog.CatalogFeatures;
import javax.xml.catalog.CatalogFeatures.Feature;
import javax.xml.catalog.CatalogManager;
import javax.xml.catalog.CatalogResolver;
-import javax.xml.catalog.CatalogUriResolver;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
+import javax.xml.stream.XMLInputFactory;
+import javax.xml.stream.XMLStreamConstants;
+import javax.xml.stream.XMLStreamReader;
import javax.xml.transform.Source;
-
+import javax.xml.transform.Transformer;
+import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.sax.SAXSource;
+import javax.xml.transform.stream.StreamResult;
+import javax.xml.transform.stream.StreamSource;
+import javax.xml.validation.Schema;
+import javax.xml.validation.SchemaFactory;
+import javax.xml.validation.Validator;
import jaxp.library.JAXPTestUtilities;
import org.testng.Assert;
@@ -59,29 +73,235 @@
/*
* @test
- * @bug 8081248 8144966 8146606 8146237 8151154 8150969 8151162 8152527 8154220
+ * @bug 8081248 8144966 8146606 8146237 8151154 8150969 8151162 8152527 8154220 8163232
* @library /javax/xml/jaxp/libs /javax/xml/jaxp/unittest
* @run testng/othervm -DrunSecMngr=true catalog.CatalogTest
* @run testng/othervm catalog.CatalogTest
* @summary Tests basic Catalog functions.
*/
@Listeners({jaxp.library.FilePolicy.class})
-public class CatalogTest {
+public class CatalogTest extends CatalogSupportBase {
static final String KEY_FILES = "javax.xml.catalog.files";
- public String filepath;
/*
* Initializing fields
*/
@BeforeClass
public void setUpClass() throws Exception {
- String file1 = getClass().getResource("first_cat.xml").getFile();
- if (getSystemProperty("os.name").contains("Windows")) {
- filepath = file1.substring(1, file1.lastIndexOf("/") + 1);
- } else {
- filepath = file1.substring(0, file1.lastIndexOf("/") + 1);
+ super.setUp();
+ }
+
+
+ /*
+ * @bug 8163232
+ * Verifies that the CatalogResolver supports the following XML Resolvers:
+ javax.xml.stream.XMLResolver
+ javax.xml.transform.URIResolver
+ org.w3c.dom.ls.LSResourceResolver
+ org.xml.sax.EntityResolver
+ *
+ * Plus, system and uri entries can equally be used.
+ */
+
+ /*
+ * Verifies the support for org.xml.sax.EntityResolver.
+ * Expected: the parser returns the expected string.
+ */
+ @Test(dataProvider = "supportXMLResolver")
+ public void supportEntityResolver(String catalogFile, String xml, String expected) throws Exception {
+ String xmlSource = getClass().getResource(xml).getFile();
+
+ CatalogResolver cr = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);
+ MyCatalogHandler handler = new MyCatalogHandler(cr, elementInSystem);
+ SAXParser parser = getSAXParser(false, true, null);
+ parser.parse(xmlSource, handler);
+
+ Assert.assertEquals(handler.getResult().trim(), expected);
+ }
+
+ /*
+ * Verifies the support for javax.xml.stream.XMLResolver.
+ * Expected: the parser returns the expected string.
+ */
+ @Test(dataProvider = "supportXMLResolver")
+ public void supportXMLResolver(String catalogFile, String xml, String expected) throws Exception {
+ String xmlSource = getClass().getResource(xml).getFile();
+
+ CatalogResolver cr = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);
+
+ XMLInputFactory xifactory = XMLInputFactory.newInstance();
+ xifactory.setProperty(XMLInputFactory.IS_COALESCING, true);
+ xifactory.setProperty(XMLInputFactory.RESOLVER, cr);
+ File file = new File(xmlSource);
+ String systemId = file.toURI().toString();
+ InputStream entityxml = new FileInputStream(file);
+ XMLStreamReader streamReader = xifactory.createXMLStreamReader(systemId, entityxml);
+ String result = null;
+ while (streamReader.hasNext()) {
+ int eventType = streamReader.next();
+ if (eventType == XMLStreamConstants.START_ELEMENT) {
+ eventType = streamReader.next();
+ if (eventType == XMLStreamConstants.CHARACTERS) {
+ result = streamReader.getText();
+ }
+ }
}
+ System.out.println(": expected [" + expected + "] <> actual [" + result.trim() + "]");
+
+ Assert.assertEquals(result.trim(), expected);
+ }
+
+ /*
+ * Verifies the support for org.w3c.dom.ls.LSResourceResolver by ShemaFactory.
+ * Success: parsing goes through with no error
+ * Fail: throws Exception if references are not resolved (by the CatalogResolver)
+ */
+ @Test(dataProvider = "supportLSResourceResolver")
+ public void supportLSResourceResolver(String catalogFile, Source schemaSource) throws SAXException {
+
+ CatalogResolver cr = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);
+
+ SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
+ factory.setResourceResolver(cr);
+ Schema schema = factory.newSchema(schemaSource);
+
+ }
+
+ /*
+ * Verifies the support for org.w3c.dom.ls.LSResourceResolver by Validator.
+ * Success: parsing goes through with no error
+ * Fail: throws Exception if references are not resolved (by the CatalogResolver)
+ */
+ @Test(dataProvider = "supportLSResourceResolver1")
+ public void supportLSResourceResolver1(String catalogFile, Source source) throws Exception {
+
+ CatalogResolver cr = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);
+
+ SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
+ Validator validator = factory.newSchema().newValidator();
+ validator.setResourceResolver(cr);
+ validator.validate(source);
+ }
+
+ /*
+ * Verifies the support for javax.xml.transform.URIResolver.
+ * Success: parsing goes through with no error
+ * Fail: throws Exception if references are not resolved (by the CatalogResolver)
+ */
+ @Test(dataProvider = "supportURIResolver")
+ public void supportURIResolver(String catalogFile, Source xsl, Source xml, String expected) throws Exception {
+
+ CatalogResolver cr = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);
+
+ TransformerFactory factory = TransformerFactory.newInstance();
+ factory.setURIResolver(cr);
+ Transformer transformer = factory.newTransformer(xsl);
+ StringWriter out = new StringWriter();
+ transformer.transform(xml, new StreamResult(out));
+ if (expected != null) {
+ Assert.assertTrue(out.toString().contains(expected), "supportURIResolver");
+ }
+ }
+
+ /*
+ DataProvider: used to verify the support of XML Resolvers.
+ Data columns:
+ catalog filepath, xml source file, expected result
+ */
+ @DataProvider(name = "supportXMLResolver")
+ public Object[][] supportXMLResolver() {
+ String catalogFile = getClass().getResource("catalog.xml").getFile();
+ String catalogFileUri = getClass().getResource("catalog_uri.xml").getFile();
+
+ return new Object[][]{
+ {catalogFile, "system.xml", "Test system entry"},
+ {catalogFile, "rewritesystem.xml", "Test rewritesystem entry"},
+ {catalogFile, "rewritesystem1.xml", "Test rewritesystem entry"},
+ {catalogFile, "systemsuffix.xml", "Test systemsuffix entry"},
+ {catalogFile, "delegatesystem.xml", "Test delegatesystem entry"},
+ {catalogFile, "public.xml", "Test public entry"},
+ {catalogFile, "delegatepublic.xml", "Test delegatepublic entry"},
+ // using uri entries
+ {catalogFileUri, "system.xml", "Test system entry"},
+ {catalogFileUri, "rewritesystem.xml", "Test rewritesystem entry"},
+ {catalogFileUri, "rewritesystem1.xml", "Test rewritesystem entry"},
+ {catalogFileUri, "systemsuffix.xml", "Test systemsuffix entry"},
+ {catalogFileUri, "delegateuri.xml", "Test delegateuri entry"},
+ {catalogFileUri, "public.xml", "Test public entry"},
+ };
+ }
+
+ /*
+ DataProvider: used to verify the support of LSResourceResolver by SchemaFactory.
+ Data columns:
+ catalog filepath, schema source file
+ */
+ @DataProvider(name = "supportLSResourceResolver")
+ public Object[][] supportLSResourceResolver() {
+ String catalogFile = getClass().getResource("CatalogSupport.xml").getFile();
+ String catalogFileUri = getClass().getResource("CatalogSupport_uri.xml").getFile();
+
+ /*
+ * XMLSchema.xsd has a reference to XMLSchema.dtd which in turn refers to
+ * datatypes.dtd
+ */
+ return new Object[][]{
+ {catalogFile, new StreamSource(new StringReader(xsd_xmlSchema))},
+ {catalogFile, new StreamSource(new StringReader(xsd_xmlSchema_import))},
+ {catalogFile, new StreamSource(new StringReader(xsd_include_company))},
+ {catalogFileUri, new StreamSource(new StringReader(xsd_xmlSchema))},
+ {catalogFileUri, new StreamSource(new StringReader(xsd_xmlSchema_import))},
+ {catalogFileUri, new StreamSource(new StringReader(xsd_include_company))},
+ };
+ }
+
+ /*
+ DataProvider: used to verify the support of LSResourceResolver by Validator.
+ Data columns:
+ catalog filepath, source file
+ */
+ @DataProvider(name = "supportLSResourceResolver1")
+ public Object[][] supportLSResourceResolver1() {
+ String catalogFile = getClass().getResource("CatalogSupport.xml").getFile();
+ String catalogFileUri = getClass().getResource("CatalogSupport_uri.xml").getFile();
+
+ /*
+ * val_test.xml has a reference to system.dtd and val_test.xsd
+ */
+ SAXSource ss = new SAXSource(new InputSource(xml_val_test));
+ ss.setSystemId(xml_val_test_id);
+
+ return new Object[][]{
+ {catalogFile, ss},
+ {catalogFileUri, ss},
+ };
+ }
+
+
+ /*
+ DataProvider: used to verify the support of LSResourceResolver by Validator.
+ Data columns:
+ catalog filepath, xsl source, xml source file
+ */
+ @DataProvider(name = "supportURIResolver")
+ public Object[][] supportURIResolver() {
+ String catalogFile = getClass().getResource("CatalogSupport.xml").getFile();
+ String catalogFileUri = getClass().getResource("CatalogSupport_uri.xml").getFile();
+ SAXSource xslSource = new SAXSource(new InputSource(new File(xsl_doc).toURI().toASCIIString()));
+
+ /*
+ * val_test.xml has a reference to system.dtd and val_test.xsd
+ */
+ SAXSource ss = new SAXSource(new InputSource(xml_val_test));
+ ss.setSystemId(xml_val_test_id);
+
+ return new Object[][]{
+ {catalogFile, new SAXSource(new InputSource(new File(xsl_doc).toURI().toASCIIString())),
+ new StreamSource(new File(xml_doc)), "Resolved by a catalog"},
+ {catalogFileUri, new SAXSource(new InputSource(new StringReader(xsl_include))),
+ new StreamSource(new StringReader(xml_xsl)), null},
+ };
}
/*
@@ -110,7 +330,7 @@
@Test(dataProvider = "resolveUri")
public void testMatch1(String cFile, String href, String expectedFile, String expectedUri, String msg) {
String catalogFile = getClass().getResource(cFile).getFile();
- CatalogUriResolver cur = CatalogManager.catalogUriResolver(CatalogFeatures.defaults(), catalogFile);
+ CatalogResolver cur = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);
Source source = cur.resolve(href, null);
Assert.assertNotNull(source, "Source returned is null");
Assert.assertEquals(expectedUri, source.getSystemId(), msg);
@@ -275,7 +495,7 @@
try {
- CatalogUriResolver resolver = CatalogManager.catalogUriResolver(CatalogFeatures.defaults(), catalog);
+ CatalogResolver resolver = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalog);
String actualSystemId = resolver.resolve("http://remote.com/import/import.xsl", null).getSystemId();
Assert.assertTrue(!actualSystemId.contains("//"), "result contains duplicate slashes");
} catch (Exception e) {
@@ -383,7 +603,7 @@
/*
- DataProvider: used to verify CatalogUriResolver's resolve function.
+ DataProvider: used to verify CatalogResolver's resolve function.
Data columns:
catalog, uri or publicId, expectedFile, expectedUri, msg
@@ -571,4 +791,3 @@
}
}
}
-
--- a/jaxp/test/javax/xml/jaxp/unittest/catalog/catalog.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/catalog.xml Tue Aug 30 08:45:21 2016 -0700
@@ -26,4 +26,4 @@
<system systemId="http://remote/dtd/alice/docAlice.dtd" uri="http://local/dtd/docAliceSys.dtd" />
</group>
-</catalog>
\ No newline at end of file
+</catalog>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/catalog_uri.xml Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<catalog
+ xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
+
+ <!-- using uri entries -->
+ <uri name="http://openjdk.java.net/xml/catalog/dtd/system.dtd" uri="system.dtd"/>
+ <rewriteURI uriStartString="http://openjdk.java.net/"
+ rewritePrefix="files" />
+
+ <rewriteURI uriStartString="http://openjdk.java.net/xml/catalog/dtd/"
+ rewritePrefix="files" />
+
+ <uriSuffix uriSuffix="systemsuffix.dtd" uri="systemsuffix.dtd"/>
+
+ <delegateURI uriStartString="http://java.com/xml/catalog/dtd/" catalog="files/delegatecatalog_uri.xml"/>
+
+
+ <uri name="-//OPENJDK//XML CATALOG DTD//1.0" uri="public.dtd"/>
+
+
+ <delegateURI uriStartString="-//JAVASE//XML CATALOG DTD//DELEGATEPULIC" catalog="files/delegatecatalog_uri.xml"/>
+
+</catalog>
+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/delegateuri.xml Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,5 @@
+<?xml version="1.0"?>
+<!DOCTYPE catalogtest PUBLIC "-//JAVASE//XML CATALOG DTD//DELEGATEURI"
+ "http://java.com/xml/catalog/dtd/delegateuri.dtd">
+
+<catalogtest>Test &delegateuri; entry</catalogtest>
--- a/jaxp/test/javax/xml/jaxp/unittest/catalog/files/delegatecatalog.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/files/delegatecatalog.xml Tue Aug 30 08:45:21 2016 -0700
@@ -22,4 +22,4 @@
<system systemId="http://java.com/xml/catalog/dtd/delegatesystem.dtd" uri="delegatesystem.dtd"/>
-</catalog>
\ No newline at end of file
+</catalog>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/files/delegatecatalog_uri.xml Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<catalog
+ xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
+
+ <uri name="http://java.com/xml/catalog/dtd/delegateuri.dtd" uri="delegateuri.dtd"/>
+
+</catalog>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/files/delegateuri.dtd Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,2 @@
+
+<!ENTITY delegateuri "delegateuri">
--- a/jaxp/test/javax/xml/jaxp/unittest/catalog/system.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxp/test/javax/xml/jaxp/unittest/catalog/system.xml Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<!DOCTYPE catalogtest PUBLIC "-//OPENJDK//XML CATALOG DTD//1.0"
+<!DOCTYPE catalogtest PUBLIC "-//OPENJDK//XML CATALOG DTD SYSTEM//1.0"
"http://openjdk.java.net/xml/catalog/dtd/system.dtd">
-<catalogtest>Test &system; entry</catalogtest>
\ No newline at end of file
+<catalogtest>Test &system; entry</catalogtest>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/jaxp/test/javax/xml/jaxp/unittest/parsers/HandleError.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package parsers;
+
+import java.io.StringReader;
+import javax.xml.parsers.SAXParser;
+import javax.xml.parsers.SAXParserFactory;
+import org.xml.sax.InputSource;
+import org.xml.sax.SAXException;
+import org.xml.sax.SAXParseException;
+import org.xml.sax.helpers.DefaultHandler;
+
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Listeners;
+import org.testng.annotations.Test;
+
+/*
+ * @test
+ * @bug 8157797
+ * @library /javax/xml/jaxp/libs /javax/xml/jaxp/unittest
+ * @run testng/othervm -DrunSecMngr=true parsers.HandleError
+ * @run testng/othervm parsers.HandleError
+ * @summary Tests that the parser handles errors properly.
+ */
+@Listeners({jaxp.library.BasePolicy.class})
+public class HandleError {
+
+ /*
+ * Verifies that the parser returns with no unexpected "java.lang.InternalError"
+ * when continue-after-fatal-error is requested.
+ */
+ @Test
+ public void test() throws Exception {
+ String invalidXml = "<a>";
+ SAXParserFactory saxParserFactory = SAXParserFactory.newInstance();
+ saxParserFactory.setFeature("http://apache.org/xml/features/continue-after-fatal-error", true);
+ SAXParser parser = saxParserFactory.newSAXParser();
+ parser.parse(new InputSource(new StringReader(invalidXml)), new DefaultHandler() {
+ @Override
+ public void fatalError(SAXParseException e) throws SAXException {
+ System.err.printf("%s%n", e.getMessage());
+ }
+ });
+ }
+
+
+ /*
+ * Verifies that the parser throws SAXParseException when parsing error is
+ * encountered when:
+ * continue-after-fatal-error is not set, the default it false
+ * continue-after-fatal-error is explicitly set to false
+ */
+ @Test(dataProvider = "setFeature", expectedExceptions = SAXParseException.class)
+ public void test1(boolean setFeature, boolean value) throws Exception {
+ String invalidXml = "<a>";
+ SAXParserFactory saxParserFactory = SAXParserFactory.newInstance();
+ if (setFeature) {
+ saxParserFactory.setFeature("http://apache.org/xml/features/continue-after-fatal-error", value);
+ }
+ SAXParser parser = saxParserFactory.newSAXParser();
+ parser.parse(new InputSource(new StringReader(invalidXml)), new DefaultHandler());
+ }
+
+ /*
+ DataProvider: used to set feature "continue-after-fatal-error"
+ Data columns:
+ flag to indicate the feature is to be set, the value of the feature
+ */
+ @DataProvider(name = "setFeature")
+ public Object[][] getFeatureSetting() {
+
+ return new Object[][]{
+ {false, false},
+ {true, false},
+ };
+ }
+}
--- a/jaxws/.hgtags Tue Aug 30 11:07:58 2016 +0530
+++ b/jaxws/.hgtags Tue Aug 30 08:45:21 2016 -0700
@@ -378,3 +378,4 @@
39c6293131d91aec7f2f5120395e070a937b8858 jdk-9+130
783e7e2c587f2c7e1b9998a46d90ec196ab2a195 jdk-9+131
9fff2477a4cadf2a9618a76f1f4fe0f20bb5ff3b jdk-9+132
+05e99eefda2b58d1ed176e411302d9d6b35dca16 jdk-9+133
--- a/jdk/src/java.base/share/classes/jdk/internal/jrtfs/JrtDirectoryStream.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jdk/src/java.base/share/classes/jdk/internal/jrtfs/JrtDirectoryStream.java Tue Aug 30 08:45:21 2016 -0700
@@ -47,8 +47,8 @@
private final JrtPath dir;
private final DirectoryStream.Filter<? super Path> filter;
- private volatile boolean isClosed;
- private volatile Iterator<Path> itr;
+ private boolean isClosed;
+ private Iterator<Path> itr;
JrtDirectoryStream(JrtPath dir,
DirectoryStream.Filter<? super java.nio.file.Path> filter)
@@ -73,24 +73,22 @@
throw new IllegalStateException(e);
}
return new Iterator<Path>() {
- private Path next;
@Override
- public synchronized boolean hasNext() {
- if (isClosed)
- return false;
- return itr.hasNext();
+ public boolean hasNext() {
+ synchronized (JrtDirectoryStream.this) {
+ if (isClosed)
+ return false;
+ return itr.hasNext();
+ }
}
@Override
- public synchronized Path next() {
- if (isClosed)
- throw new NoSuchElementException();
- return itr.next();
- }
-
- @Override
- public void remove() {
- throw new UnsupportedOperationException();
+ public Path next() {
+ synchronized (JrtDirectoryStream.this) {
+ if (isClosed)
+ throw new NoSuchElementException();
+ return itr.next();
+ }
}
};
}
--- a/jdk/src/java.base/share/classes/jdk/internal/jrtfs/JrtFileSystem.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jdk/src/java.base/share/classes/jdk/internal/jrtfs/JrtFileSystem.java Tue Aug 30 08:45:21 2016 -0700
@@ -119,9 +119,7 @@
@Override
public Iterable<Path> getRootDirectories() {
- ArrayList<Path> dirs = new ArrayList<>();
- dirs.add(getRootPath());
- return dirs;
+ return Collections.singleton(getRootPath());
}
@Override
@@ -159,9 +157,7 @@
@Override
public final Iterable<FileStore> getFileStores() {
- ArrayList<FileStore> list = new ArrayList<>(1);
- list.add(getFileStore(getRootPath()));
- return list;
+ return Collections.singleton(getFileStore(getRootPath()));
}
private static final Set<String> supportedFileAttributeViews
--- a/jdk/src/java.smartcardio/share/classes/sun/security/smartcardio/TerminalImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jdk/src/java.smartcardio/share/classes/sun/security/smartcardio/TerminalImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -75,10 +75,10 @@
}
}
try {
- card = new CardImpl(this, protocol);
+ card = new CardImpl(this, protocol);
return card;
} catch (PCSCException e) {
- if (e.code == SCARD_W_REMOVED_CARD) {
+ if (e.code == SCARD_W_REMOVED_CARD || e.code == SCARD_E_NO_SMARTCARD) {
throw new CardNotPresentException("No card present", e);
} else {
throw new CardException("connect() failed", e);
--- a/jdk/test/java/lang/ProcessBuilder/Zombies.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jdk/test/java/lang/ProcessBuilder/Zombies.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
* @test
* @run main/othervm Zombies
* @bug 6474073 6180151
- * @key intermittent
* @summary Make sure zombies don't get created on Unix
* @author Martin Buchholz
*/
--- a/jdk/test/java/net/URLPermission/nstest/lookup.sh Tue Aug 30 11:07:58 2016 +0530
+++ b/jdk/test/java/net/URLPermission/nstest/lookup.sh Tue Aug 30 08:45:21 2016 -0700
@@ -27,6 +27,7 @@
# @build jdk.testlibrary.*
# @compile -XDignore.symbol.file=true LookupTest.java
# @run shell/timeout=50 lookup.sh
+# @key intermittent
#
OS=`uname -s`
--- a/jdk/test/sun/security/ssl/SSLSocketImpl/CloseSocket.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jdk/test/sun/security/ssl/SSLSocketImpl/CloseSocket.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -26,67 +26,96 @@
* @bug 4674913
* @summary Verify that EOFException are correctly handled during the handshake
* @author Andreas Sterbenz
+ * @run main/othervm CloseSocket
*/
-import java.io.*;
-import java.net.*;
-
-import javax.net.ssl.*;
+import javax.net.SocketFactory;
+import javax.net.ssl.SSLSocket;
+import javax.net.ssl.SSLSocketFactory;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.ServerSocket;
+import java.net.Socket;
+import java.util.ArrayList;
public class CloseSocket {
+ private static ArrayList<TestCase> testCases = new ArrayList<>();
+
+ static {
+ testCases.add(socket -> socket.startHandshake());
+ testCases.add(socket -> {
+ InputStream in = socket.getInputStream();
+ in.read();
+ });
+ testCases.add(socket -> {
+ OutputStream out = socket.getOutputStream();
+ out.write(43);
+ });
+ }
+
public static void main(String[] args) throws Exception {
- final ServerSocket serverSocket = new ServerSocket(0);
- int serverPort = serverSocket.getLocalPort();
- new Thread() {
- public void run() {
- try {
- Socket s = serverSocket.accept();
- System.out.println("Server accepted connection");
- // wait a bit before closing the socket to give
- // the client time to send its hello message
- Thread.currentThread().sleep(100);
- s.close();
- System.out.println("Server closed socket, done.");
- } catch (Exception e) {
- System.out.println("Server exception:");
- e.printStackTrace();
+ try (Server server = new Server()) {
+ new Thread(server).start();
+
+ SocketFactory factory = SSLSocketFactory.getDefault();
+ try (SSLSocket socket = (SSLSocket) factory.createSocket("localhost",
+ server.getPort())) {
+ socket.setSoTimeout(2000);
+ System.out.println("Client established TCP connection");
+ boolean failed = false;
+ for (TestCase testCase : testCases) {
+ try {
+ testCase.test(socket);
+ System.out.println("ERROR: no exception");
+ failed = true;
+ } catch (IOException e) {
+ System.out.println("Failed as expected: " + e);
+ }
+ }
+ if (failed) {
+ throw new Exception("One or more tests failed");
}
}
- }.start();
- SSLSocketFactory factory = (SSLSocketFactory)SSLSocketFactory.getDefault();
- SSLSocket socket = (SSLSocket)factory.createSocket("localhost", serverPort);
- System.out.println("Client established TCP connection");
- boolean failed = false;
- try {
- System.out.println("Starting handshake...");
- socket.startHandshake();
- System.out.println("ERROR: no exception");
- failed = true;
- } catch (IOException e) {
- System.out.println("Failed as expected: " + e);
- }
- try {
- System.out.println("Trying read...");
- InputStream in = socket.getInputStream();
- int b = in.read();
- System.out.println("ERROR: no exception, read: " + b);
- failed = true;
- } catch (IOException e) {
- System.out.println("Failed as expected: " + e);
- }
- try {
- System.out.println("Trying read...");
- OutputStream out = socket.getOutputStream();
- out.write(43);
- System.out.println("ERROR: no exception");
- failed = true;
- } catch (IOException e) {
- System.out.println("Failed as expected: " + e);
- }
- if (failed) {
- throw new Exception("One or more tests failed");
}
}
+ static class Server implements AutoCloseable, Runnable {
+
+ final ServerSocket serverSocket;
+
+ Server() throws IOException {
+ serverSocket = new ServerSocket(0);
+ }
+
+ public int getPort() {
+ return serverSocket.getLocalPort();
+ }
+
+ @Override
+ public void run() {
+ try (Socket s = serverSocket.accept()) {
+ System.out.println("Server accepted connection");
+ // wait a bit before closing the socket to give
+ // the client time to send its hello message
+ Thread.currentThread().sleep(100);
+ s.close();
+ System.out.println("Server closed socket, done.");
+ } catch (Exception e) {
+ throw new RuntimeException("Problem in test execution", e);
+ }
+ }
+
+ @Override
+ public void close() throws Exception {
+ if (!serverSocket.isClosed()) {
+ serverSocket.close();
+ }
+ }
+ }
+
+ interface TestCase {
+ void test(SSLSocket socket) throws IOException;
+ }
}
--- a/jdk/test/sun/util/calendar/zi/TestZoneInfo310.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jdk/test/sun/util/calendar/zi/TestZoneInfo310.java Tue Aug 30 08:45:21 2016 -0700
@@ -22,11 +22,15 @@
*/
/*
- *@test
- *@bug 8007572 8008161
- *@summary Test whether the TimeZone generated from JSR310 tzdb is the same
- *as the one from the tz data from javazic
+ * @test
+ * @bug 8007572 8008161 8157792
+ * @summary Test whether the TimeZone generated from JSR310 tzdb is the same
+ * as the one from the tz data from javazic
* @modules java.base/sun.util.calendar
+ * @build BackEnd Checksum DayOfWeek Gen GenDoc Main Mappings Month
+ * Rule RuleDay RuleRec Simple TestZoneInfo310 Time Timezone
+ * TzIDOldMapping Zone ZoneInfoFile ZoneInfoOld ZoneRec Zoneinfo
+ * @run main TestZoneInfo310
*/
import java.io.File;
@@ -164,10 +168,6 @@
}
for (String zid : zids_new) {
- if (zid.equals("Asia/Oral") || zid.equals("Asia/Qyzylorda")) {
- // JDK-8157792 tracking this issue
- continue;
- }
ZoneInfoOld zi = toZoneInfoOld(TimeZone.getTimeZone(zid));
ZoneInfoOld ziOLD = (ZoneInfoOld)ZoneInfoOld.getTimeZone(zid);
if (! zi.equalsTo(ziOLD)) {
--- a/jdk/test/sun/util/calendar/zi/Zoneinfo.java Tue Aug 30 11:07:58 2016 +0530
+++ b/jdk/test/sun/util/calendar/zi/Zoneinfo.java Tue Aug 30 08:45:21 2016 -0700
@@ -373,6 +373,7 @@
tz.getOffsetIndex(zrec.getGmtOffset());
int lastGmtOffsetValue = -1;
+ ZoneRec prevzrec = null;
int currentSave = 0;
boolean usedZone;
for (int zindex = 0; zindex < zone.size(); zindex++) {
@@ -441,6 +442,15 @@
currentSave);
if (zrec.hasUntil()) {
if (transition >= zrec.getUntilTime(currentSave)) {
+ // If the GMT offset changed from the previous one,
+ // record fromTime as a transition.
+ if (!fromTimeUsed && prevzrec != null
+ && gmtOffset != prevzrec.getGmtOffset()) {
+ tz.addTransition(fromTime,
+ tz.getOffsetIndex(gmtOffset+currentSave),
+ tz.getDstOffsetIndex(currentSave));
+ fromTimeUsed = true; // for consistency
+ }
break year_loop;
}
}
@@ -452,8 +462,6 @@
if (fromTime != minTime) {
int prevsave;
- ZoneRec prevzrec = zone.get(zindex - 1);
-
// See if until time in the previous
// ZoneRec is the same thing as the
// local time in the next rule.
@@ -555,6 +563,7 @@
fromYear = zrec.getUntilYear();
year = zrec.getUntilYear();
}
+ prevzrec = zrec;
}
if (tz.getDSTType() == Timezone.UNDEF_DST) {
--- a/langtools/.hgtags Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/.hgtags Tue Aug 30 08:45:21 2016 -0700
@@ -375,3 +375,4 @@
3665ebc22a42c8f33777ee025ba0e300e6086a8c jdk-9+130
aebfafc43714d5a27d5064d8a0011eaccde633cf jdk-9+131
2c17b65a37a8d7afdb9f96d5f11b28a3f21c78f2 jdk-9+132
+7efa4b3477b2b93edbdb4abf827b74c6391f056e jdk-9+133
--- a/langtools/make/CompileInterim.gmk Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/make/CompileInterim.gmk Tue Aug 30 08:45:21 2016 -0700
@@ -32,7 +32,7 @@
include SetupJavaCompilers.gmk
################################################################################
-# Setup the rules to build interim langtools, which is compiled by the boot
+# Setup the rules to build interim langtools, which is compiled by the boot
# javac and can be run on the boot jdk. This will be used to compile
# the rest of the product. Each module is compiled separately to allow a modular
# boot jdk to override system classes using -Xoverride:.
@@ -45,7 +45,8 @@
DISABLE_SJAVAC := true, \
SRC := $(LANGTOOLS_TOPDIR)/src/$(strip $1)/share/classes \
$$(wildcard $(SUPPORT_OUTPUTDIR)/gensrc/$(strip $1)), \
- EXCLUDES := sun com/sun/tools/jdeps com/sun/tools/javap, \
+ EXCLUDES := sun com/sun/tools/jdeps com/sun/tools/javap \
+ com/sun/tools/jdeprscan, \
EXCLUDE_FILES := module-info.java, \
COPY := .gif .png .xml .css .js javax.tools.JavaCompilerTool, \
BIN := $(BUILDTOOLS_OUTPUTDIR)/override_modules/$(strip $1), \
--- a/langtools/make/build.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/make/build.xml Tue Aug 30 08:45:21 2016 -0700
@@ -88,18 +88,18 @@
<dirset dir="${src.dir}" includes="*.*"/>
</pathconvert>
- <pathconvert property="xpatch.rest" pathsep=" -Xpatch:">
+ <pathconvert property="xpatch.rest" pathsep=" --patch-module=">
<regexpmapper from="${file.separator}([^${file.separator}]+)$" to='\1="${build.modules}${file.separator}\1"' />
<dirset dir="${src.dir}" includes="*.*"/>
</pathconvert>
- <pathconvert property="xpatch.noquotes.rest" pathsep=" -Xpatch:">
+ <pathconvert property="xpatch.noquotes.rest" pathsep=" --patch-module=">
<regexpmapper from="${file.separator}([^${file.separator}]+)$" to="\1=${build.modules}${file.separator}\1" />
<dirset dir="${src.dir}" includes="*.*"/>
</pathconvert>
- <property name="xpatch.cmd" value="-Xpatch:${xpatch.rest}"/>
- <property name="xpatch.noquotes.cmd" value="-Xpatch:${xpatch.noquotes.rest}"/>
+ <property name="xpatch.cmd" value="--patch-module=${xpatch.rest}"/>
+ <property name="xpatch.noquotes.cmd" value="--patch-module=${xpatch.noquotes.rest}"/>
<!-- java.marker is set to a marker file to check for within a Java install dir.
The best file to check for across Solaris/Linux/Windows/MacOS is one of the
@@ -207,7 +207,7 @@
<arg line="-source ${javac.source} -target ${javac.target}" />
<arg value="-d" />
<arg value="${build.modules}" />
- <arg line="${javac.opts} -modulesourcepath ${src.dir}${file.separator}*${file.separator}share${file.separator}classes:${build.gensrc} -m ${modules.names}" />
+ <arg line="${javac.opts} --module-source-path ${src.dir}${file.separator}*${file.separator}share${file.separator}classes:${build.gensrc} -m ${modules.names}" />
</exec>
<delete>
<fileset dir="${build.modules}" includes="**/module-info.class"/>
--- a/langtools/make/diags-examples.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/make/diags-examples.xml Tue Aug 30 08:45:21 2016 -0700
@@ -80,12 +80,12 @@
includeAntRuntime="no"
debug="${javac.debug}"
debuglevel="${javac.debuglevel}">
- <compilerarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED"/>
- <compilerarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED"/>
- <compilerarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED"/>
- <compilerarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED"/>
- <compilerarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED"/>
- <compilerarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED"/>
+ <compilerarg line="--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED"/>
+ <compilerarg line="--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED"/>
+ <compilerarg line="--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED"/>
+ <compilerarg line="--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED"/>
+ <compilerarg line="--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED"/>
+ <compilerarg line="--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED"/>
</javac>
</target>
@@ -111,12 +111,12 @@
<arg value="-showFiles"/>
<arg value="-title"/>
<arg value="Examples of javac diagnostics"/>
- <jvmarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED"/>
- <jvmarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED"/>
- <jvmarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED"/>
- <jvmarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED"/>
- <jvmarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED"/>
- <jvmarg line="-XaddExports:jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED"/>
+ <jvmarg line="--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED"/>
+ <jvmarg line="--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED"/>
+ <jvmarg line="--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED"/>
+ <jvmarg line="--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED"/>
+ <jvmarg line="--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED"/>
+ <jvmarg line="--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED"/>
</java>
</sequential>
</macrodef>
--- a/langtools/make/gendata/Gendata-jdk.compiler.gmk Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/make/gendata/Gendata-jdk.compiler.gmk Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# This code is free software; you can redistribute it and/or modify it
@@ -41,9 +41,9 @@
ifeq ($(BOOT_JDK_MODULAR), true)
COMPILECREATESYMBOLS_ADD_EXPORTS := \
- -XaddExports:jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED \
- -XaddExports:jdk.compiler/com.sun.tools.javac.jvm=ALL-UNNAMED \
- -XaddExports:jdk.jdeps/com.sun.tools.classfile=ALL-UNNAMED
+ --add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED \
+ --add-exports=jdk.compiler/com.sun.tools.javac.jvm=ALL-UNNAMED \
+ --add-exports=jdk.jdeps/com.sun.tools.classfile=ALL-UNNAMED
endif
$(SUPPORT_OUTPUTDIR)/symbols/ct.sym-files/_the.symbols: \
--- a/langtools/make/intellij/runConfigurations/javah.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/make/intellij/runConfigurations/javah.xml Tue Aug 30 08:45:21 2016 -0700
@@ -2,7 +2,7 @@
<configuration default="false" name="javah" type="Application" factoryName="Application">
<extension name="coverage" enabled="false" merge="false" sample_coverage="true" runner="idea" />
<option name="MAIN_CLASS_NAME" value="com.sun.tools.javah.Main" />
- <option name="VM_PARAMETERS" value='@XPATCH@ -XaddExports:jdk.compiler/com.sun.tools.javah=ALL-UNNAMED' />
+ <option name="VM_PARAMETERS" value='@XPATCH@ --add-exports=jdk.compiler/com.sun.tools.javah=ALL-UNNAMED' />
<option name="PROGRAM_PARAMETERS" value="" />
<option name="WORKING_DIRECTORY" value="file://$PROJECT_DIR$" />
<option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
--- a/langtools/make/intellij/runConfigurations/javap.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/make/intellij/runConfigurations/javap.xml Tue Aug 30 08:45:21 2016 -0700
@@ -2,7 +2,7 @@
<configuration default="false" name="javap" type="Application" factoryName="Application">
<extension name="coverage" enabled="false" merge="false" sample_coverage="true" runner="idea" />
<option name="MAIN_CLASS_NAME" value="com.sun.tools.javap.Main" />
- <option name="VM_PARAMETERS" value='@XPATCH@ -XaddExports:jdk.jdeps/com.sun.tools.javap=ALL-UNNAMED' />
+ <option name="VM_PARAMETERS" value='@XPATCH@ --add-exports=jdk.jdeps/com.sun.tools.javap=ALL-UNNAMED' />
<option name="PROGRAM_PARAMETERS" value="" />
<option name="WORKING_DIRECTORY" value="file://$PROJECT_DIR$" />
<option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
--- a/langtools/make/intellij/runConfigurations/jshell.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/make/intellij/runConfigurations/jshell.xml Tue Aug 30 08:45:21 2016 -0700
@@ -2,7 +2,7 @@
<configuration default="false" name="jshell" type="Application" factoryName="Application">
<extension name="coverage" enabled="false" merge="false" sample_coverage="true" runner="idea" />
<option name="MAIN_CLASS_NAME" value="jdk.internal.jshell.tool.JShellTool" />
- <option name="VM_PARAMETERS" value='@XPATCH@ -XaddExports:jdk.jshell/jdk.internal.jshell.tool=ALL-UNNAMED' />
+ <option name="VM_PARAMETERS" value='@XPATCH@ --add-exports=jdk.jshell/jdk.internal.jshell.tool=ALL-UNNAMED' />
<option name="PROGRAM_PARAMETERS" value="" />
<option name="WORKING_DIRECTORY" value="file://$PROJECT_DIR$" />
<option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
--- a/langtools/make/intellij/runConfigurations/sjavac.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/make/intellij/runConfigurations/sjavac.xml Tue Aug 30 08:45:21 2016 -0700
@@ -2,7 +2,7 @@
<configuration default="false" name="sjavac" type="Application" factoryName="Application">
<extension name="coverage" enabled="false" merge="false" sample_coverage="true" runner="idea" />
<option name="MAIN_CLASS_NAME" value="com.sun.tools.sjavac.Main" />
- <option name="VM_PARAMETERS" value='@XPATCH@ -XaddExports:jdk.compiler/com.sun.tools.sjavac=ALL-UNNAMED' />
+ <option name="VM_PARAMETERS" value='@XPATCH@ --add-exports=jdk.compiler/com.sun.tools.sjavac=ALL-UNNAMED' />
<option name="PROGRAM_PARAMETERS" value="" />
<option name="WORKING_DIRECTORY" value="file://$PROJECT_DIR$" />
<option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
--- a/langtools/make/netbeans/langtools/build.xml Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/make/netbeans/langtools/build.xml Tue Aug 30 08:45:21 2016 -0700
@@ -218,11 +218,11 @@
<sequential>
<java fork="true" jvm="${langtools.jdk.home}/bin/java" classname="@{mainclass}">
- <jvmarg line="-Xpatch:java.compiler=@{build.modules}/java.compiler"/>
- <jvmarg line="-Xpatch:jdk.compiler=@{build.modules}/jdk.compiler"/>
- <jvmarg line="-Xpatch:jdk.javadoc=@{build.modules}/jdk.javadoc"/>
- <jvmarg line="-Xpatch:jdk.jdeps=@{build.modules}/jdk.jdeps"/>
- <jvmarg line="-Xpatch:jdk.jshell=@{build.modules}/jdk.jshell"/>
+ <jvmarg line="--patch-module=java.compiler=@{build.modules}/java.compiler"/>
+ <jvmarg line="--patch-module=jdk.compiler=@{build.modules}/jdk.compiler"/>
+ <jvmarg line="--patch-module=jdk.javadoc=@{build.modules}/jdk.javadoc"/>
+ <jvmarg line="--patch-module=jdk.jdeps=@{build.modules}/jdk.jdeps"/>
+ <jvmarg line="--patch-module=jdk.jshell=@{build.modules}/jdk.jshell"/>
<jvmarg line="@{jpda.jvmargs}"/>
<arg line="@{args}"/>
</java>
--- a/langtools/make/tools/crules/DefinedByAnalyzer.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/make/tools/crules/DefinedByAnalyzer.java Tue Aug 30 08:45:21 2016 -0700
@@ -23,10 +23,15 @@
package crules;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+
import com.sun.source.util.JavacTask;
import com.sun.source.util.TaskEvent.Kind;
import com.sun.tools.javac.code.Symbol;
import com.sun.tools.javac.code.Symbol.MethodSymbol;
+import com.sun.tools.javac.tree.JCTree.JCClassDecl;
import com.sun.tools.javac.tree.JCTree.JCMethodDecl;
import com.sun.tools.javac.tree.TreeScanner;
import com.sun.tools.javac.util.DefinedBy;
@@ -44,8 +49,21 @@
eventKind = Kind.ANALYZE;
}
+ //only java.compiler and jdk.compiler modules implement the APIs,
+ //so only these need the @DefinedBy annotation:
+ private static final Set<String> MODULE = new HashSet<>(Arrays.asList(
+ "java.compiler",
+ "jdk.compiler"
+ ));
+
class DefinedByVisitor extends TreeScanner {
@Override
+ public void visitClassDef(JCClassDecl tree) {
+ if (MODULE.contains(tree.sym.packge().modle.name.toString())) {
+ super.visitClassDef(tree);
+ }
+ }
+ @Override
public void visitMethodDef(JCMethodDecl tree) {
if (!isAPIPackage(packageName(tree.sym))) {
boolean seenAPIPackage = false;
--- a/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/code/Symtab.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/code/Symtab.java Tue Aug 30 08:45:21 2016 -0700
@@ -369,6 +369,7 @@
}
};
addRootPackageFor(unnamedModule);
+ unnamedModule.enclosedPackages = unnamedModule.enclosedPackages.prepend(unnamedModule.unnamedPackage);
errModule = new ModuleSymbol(names.empty, null) { };
addRootPackageFor(errModule);
--- a/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/code/Types.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/code/Types.java Tue Aug 30 08:45:21 2016 -0700
@@ -418,10 +418,15 @@
final ListBuffer<Symbol> abstracts = new ListBuffer<>();
for (Symbol sym : membersCache.getSymbols(new DescriptorFilter(origin))) {
Type mtype = memberType(origin.type, sym);
- if (abstracts.isEmpty() ||
- (sym.name == abstracts.first().name &&
+ if (abstracts.isEmpty()) {
+ abstracts.append(sym);
+ } else if ((sym.name == abstracts.first().name &&
overrideEquivalent(mtype, memberType(origin.type, abstracts.first())))) {
- abstracts.append(sym);
+ if (!abstracts.stream().filter(msym -> msym.owner.isSubClass(sym.enclClass(), Types.this))
+ .map(msym -> memberType(origin.type, msym))
+ .anyMatch(abstractMType -> isSubSignature(abstractMType, mtype))) {
+ abstracts.append(sym);
+ }
} else {
//the target method(s) should be the only abstract members of t
throw failure("not.a.functional.intf.1", origin,
--- a/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/comp/Infer.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/comp/Infer.java Tue Aug 30 08:45:21 2016 -0700
@@ -61,6 +61,7 @@
import java.util.Set;
import java.util.function.BiFunction;
import java.util.function.BiPredicate;
+import java.util.stream.Collectors;
import com.sun.tools.javac.main.Option;
@@ -1475,16 +1476,11 @@
//not a throws undet var
return false;
}
- Infer infer = inferenceContext.infer;
- for (Type db : t.getBounds(InferenceBound.UPPER)) {
- if (t.isInterface()) continue;
- if (infer.types.asSuper(infer.syms.runtimeExceptionType, db.tsym) == null) {
- //upper bound is not a supertype of RuntimeException - give up
- return false;
- }
- }
-
- return true;
+ Types types = inferenceContext.types;
+ Symtab syms = inferenceContext.infer.syms;
+ return t.getBounds(InferenceBound.UPPER).stream()
+ .filter(b -> !inferenceContext.free(b))
+ .allMatch(u -> types.isSubtype(syms.runtimeExceptionType, u));
}
@Override
--- a/langtools/src/jdk.javadoc/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AbstractBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AbstractBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2003, 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -124,7 +124,7 @@
/**
* Build the documentation.
*
- * @throws IOException if there was a problem writing the output.
+ * @throws IOException if there is a problem writing the output
*/
public abstract void build() throws IOException;
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/api/JavadocTaskImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/api/JavadocTaskImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -34,8 +34,6 @@
import com.sun.tools.javac.util.ClientCodeException;
import com.sun.tools.javac.util.Context;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import jdk.javadoc.internal.tool.Start;
/**
@@ -68,14 +66,12 @@
setLocale(Locale.getDefault());
}
- @DefinedBy(Api.COMPILER)
public void setLocale(Locale locale) {
if (used.get())
throw new IllegalStateException();
this.locale = locale;
}
- @DefinedBy(Api.COMPILER)
public Boolean call() {
if (!used.getAndSet(true)) {
initContext();
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/api/JavadocTool.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/api/JavadocTool.java Tue Aug 30 08:45:21 2016 -0700
@@ -49,8 +49,6 @@
import com.sun.tools.javac.file.BaseFileManager;
import com.sun.tools.javac.util.ClientCodeException;
import com.sun.tools.javac.util.Context;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import com.sun.tools.javac.util.Log;
import jdk.javadoc.internal.tool.ToolOption;
@@ -64,7 +62,7 @@
* or deletion without notice.</b></p>
*/
public class JavadocTool implements DocumentationTool {
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public DocumentationTask getTask(
Writer out,
JavaFileManager fileManager,
@@ -129,7 +127,7 @@
}
// TODO: used shared static method in JavacFileManager
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public StandardJavaFileManager getStandardFileManager(
DiagnosticListener<? super JavaFileObject> diagnosticListener,
Locale locale,
@@ -145,7 +143,7 @@
return new JavacFileManager(context, true, charset);
}
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public int run(InputStream in, OutputStream out, OutputStream err, String... arguments) {
PrintWriter err_pw = new PrintWriter(err == null ? System.err : err, true);
PrintWriter out_pw = new PrintWriter(out == null ? System.out : out);
@@ -157,13 +155,13 @@
}
}
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public Set<SourceVersion> getSourceVersions() {
return Collections.unmodifiableSet(
EnumSet.range(SourceVersion.RELEASE_3, SourceVersion.latest()));
}
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public int isSupportedOption(String option) {
if (option == null)
throw new NullPointerException();
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractExecutableMemberWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractExecutableMemberWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -39,8 +39,6 @@
import javax.lang.model.type.TypeVariable;
import javax.lang.model.util.SimpleTypeVisitor9;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.toolkit.Content;
@@ -314,27 +312,27 @@
SimpleTypeVisitor9<Boolean, Void> stv = new SimpleTypeVisitor9<Boolean, Void>() {
boolean foundTypeVariable = false;
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitArray(ArrayType t, Void p) {
visit(t.getComponentType());
buf.append(utils.getDimension(t));
return foundTypeVariable;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitTypeVariable(TypeVariable t, Void p) {
buf.append(utils.asTypeElement(t).getQualifiedName());
foundTypeVariable = true;
return foundTypeVariable;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitDeclared(DeclaredType t, Void p) {
buf.append(utils.getQualifiedTypeName(t));
return foundTypeVariable;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Boolean defaultAction(TypeMirror e, Void p) {
buf.append(e);
return foundTypeVariable;
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractIndexWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractIndexWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -26,7 +26,6 @@
package jdk.javadoc.internal.doclets.formats.html;
import java.io.*;
-import java.nio.file.*;
import java.util.*;
import java.util.zip.*;
@@ -38,7 +37,6 @@
import javax.lang.model.util.SimpleElementVisitor9;
import com.sun.source.doctree.DocTree;
-import com.sun.tools.javac.util.DefinedBy;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
@@ -46,9 +44,9 @@
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocFile;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.IndexBuilder;
/**
@@ -93,6 +91,7 @@
*
* @return a content tree for the tree label
*/
+ @Override
protected Content getNavLinkIndex() {
Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, contents.indexLabel);
return li;
@@ -183,7 +182,7 @@
SearchIndexItem si = new SearchIndexItem();
new SimpleElementVisitor9<Void, Void>() {
- @Override @DefinedBy(DefinedBy.Api.LANGUAGE_MODEL)
+ @Override
public Void visitModule(ModuleElement e, Void p) {
if (configuration.showModules) {
addDescription(e, dl, si);
@@ -192,21 +191,21 @@
return null;
}
- @Override @DefinedBy(DefinedBy.Api.LANGUAGE_MODEL)
+ @Override
public Void visitPackage(PackageElement e, Void p) {
addDescription(e, dl, si);
configuration.packageSearchIndex.add(si);
return null;
}
- @Override @DefinedBy(DefinedBy.Api.LANGUAGE_MODEL)
+ @Override
public Void visitType(TypeElement e, Void p) {
addDescription(e, dl, si);
configuration.typeSearchIndex.add(si);
return null;
}
- @Override @DefinedBy(DefinedBy.Api.LANGUAGE_MODEL)
+ @Override
protected Void defaultAction(Element e, Void p) {
addDescription(e, dl, si);
configuration.memberSearchIndex.add(si);
@@ -242,6 +241,7 @@
*
* @param pkg the package to be documented
* @param dlTree the content tree to which the description will be added
+ * @param si the search index item to be updated
*/
protected void addDescription(PackageElement pkg, Content dlTree, SearchIndexItem si) {
Content link = getPackageLink(pkg, new StringContent(utils.getPackageName(pkg)));
@@ -265,6 +265,7 @@
*
* @param typeElement the class being documented
* @param dlTree the content tree to which the description will be added
+ * @param si the search index item to be updated
*/
protected void addDescription(TypeElement typeElement, Content dlTree, SearchIndexItem si) {
Content link = getLink(new LinkInfoImpl(configuration,
@@ -332,9 +333,9 @@
}
protected void addDescription(SearchIndexItem sii, Content dlTree) {
- String path = pathToRoot.isEmpty() ? "" : pathToRoot.getPath() + "/";
- path += sii.getUrl();
- HtmlTree labelLink = HtmlTree.A(path, new StringContent(sii.getLabel()));
+ String siiPath = pathToRoot.isEmpty() ? "" : pathToRoot.getPath() + "/";
+ siiPath += sii.getUrl();
+ HtmlTree labelLink = HtmlTree.A(siiPath, new StringContent(sii.getLabel()));
Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.searchTagLink, labelLink));
dt.addContent(" - ");
dt.addContent(contents.getContent("doclet.Search_tag_in", sii.getHolder()));
@@ -430,7 +431,10 @@
return "I:" + getName(unicode);
}
- protected void createSearchIndexFiles() {
+ /**
+ * @throws DocFileIOException if there is a problem creating any of the search index files
+ */
+ protected void createSearchIndexFiles() throws DocFileIOException {
if (configuration.showModules) {
createSearchIndexFile(DocPaths.MODULE_SEARCH_INDEX_JSON, DocPaths.MODULE_SEARCH_INDEX_ZIP,
configuration.moduleSearchIndex);
@@ -445,54 +449,37 @@
configuration.tagSearchIndex);
}
+ /**
+ * @throws DocFileIOException if there is a problem creating the search index file
+ */
protected void createSearchIndexFile(DocPath searchIndexFile, DocPath searchIndexZip,
- List<SearchIndexItem> searchIndex) {
+ List<SearchIndexItem> searchIndex) throws DocFileIOException {
if (!searchIndex.isEmpty()) {
- try {
- StringBuilder searchVar = new StringBuilder("[");
- boolean first = true;
- DocFile searchFile = DocFile.createFileForOutput(configuration, searchIndexFile);
- Path p = Paths.get(searchFile.getPath());
- for (SearchIndexItem item : searchIndex) {
- if (first) {
- searchVar.append(item.toString());
- first = false;
- } else {
- searchVar.append(",").append(item.toString());
- }
+ StringBuilder searchVar = new StringBuilder("[");
+ boolean first = true;
+ for (SearchIndexItem item : searchIndex) {
+ if (first) {
+ searchVar.append(item.toString());
+ first = false;
+ } else {
+ searchVar.append(",").append(item.toString());
}
- searchVar.append("]");
- Files.write(p, searchVar.toString().getBytes());
- DocFile zipFile = DocFile.createFileForOutput(configuration, searchIndexZip);
- try (FileOutputStream fos = new FileOutputStream(zipFile.getPath());
- ZipOutputStream zos = new ZipOutputStream(fos)) {
- zipFile(searchFile.getPath(), searchIndexFile, zos);
+ }
+ searchVar.append("]");
+
+ DocFile zipFile = DocFile.createFileForOutput(configuration, searchIndexZip);
+ try (OutputStream fos = zipFile.openOutputStream();
+ ZipOutputStream zos = new ZipOutputStream(fos)) {
+ try {
+ ZipEntry ze = new ZipEntry(searchIndexFile.getPath());
+ zos.putNextEntry(ze);
+ zos.write(searchVar.toString().getBytes());
+ } finally {
+ zos.closeEntry();
}
- Files.delete(p);
} catch (IOException ie) {
- throw new DocletAbortException(ie);
+ throw new DocFileIOException(zipFile, DocFileIOException.Mode.WRITE, ie);
}
}
}
-
- protected void zipFile(String inputFile, DocPath file, ZipOutputStream zos) {
- try {
- try {
- ZipEntry ze = new ZipEntry(file.getPath());
- zos.putNextEntry(ze);
- try (FileInputStream fis = new FileInputStream(new File(inputFile))) {
- byte[] buf = new byte[2048];
- int len = fis.read(buf);
- while (len > 0) {
- zos.write(buf, 0, len);
- len = fis.read(buf);
- }
- }
- } finally {
- zos.closeEntry();
- }
- } catch (IOException e) {
- throw new DocletAbortException(e);
- }
- }
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractModuleIndexWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractModuleIndexWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
@@ -39,6 +38,7 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
/**
@@ -123,8 +123,9 @@
*
* @param title the title of the window.
* @param includeScript boolean set true if windowtitle script is to be included
+ * @throws DocFileIOException if there is a problem building the module index file
*/
- protected void buildModuleIndexFile(String title, boolean includeScript) throws IOException {
+ protected void buildModuleIndexFile(String title, boolean includeScript) throws DocFileIOException {
String windowOverview = configuration.getText(title);
Content body = getBody(includeScript, getWindowTitle(windowOverview));
addNavigationBarHeader(body);
@@ -144,9 +145,10 @@
* @param title the title of the window.
* @param includeScript boolean set true if windowtitle script is to be included
* @param mdle the name of the module being documented
+ * @throws DocFileIOException if there is an exception building the module packages index file
*/
protected void buildModulePackagesIndexFile(String title,
- boolean includeScript, ModuleElement mdle) throws IOException {
+ boolean includeScript, ModuleElement mdle) throws DocFileIOException {
String windowOverview = configuration.getText(title);
Content body = getBody(includeScript, getWindowTitle(windowOverview));
addNavigationBarHeader(body);
@@ -163,8 +165,7 @@
*
* @param body the document tree to which the overview will be added
*/
- protected void addOverview(Content body) throws IOException {
- }
+ protected void addOverview(Content body) { }
/**
* Adds the frame or non-frame module index to the documentation tree.
@@ -259,6 +260,7 @@
*
* @return a Content object to be added to the documentation tree
*/
+ @Override
protected Content getNavLinkContents() {
Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, contents.overviewLabel);
return li;
@@ -269,22 +271,19 @@
*
* @param div the document tree to which the all classes link will be added
*/
- protected void addAllClassesLink(Content div) {
- }
+ protected void addAllClassesLink(Content div) { }
/**
* Do nothing. This will be overridden in ModuleIndexFrameWriter.
*
* @param div the document tree to which the all packages link will be added
*/
- protected void addAllPackagesLink(Content div) {
- }
+ protected void addAllPackagesLink(Content div) { }
/**
* Do nothing. This will be overridden in ModulePackageIndexFrameWriter.
*
* @param div the document tree to which the all modules link will be added
*/
- protected void addAllModulesLink(Content div) {
- }
+ protected void addAllModulesLink(Content div) { }
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractPackageIndexWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractPackageIndexWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.PackageElement;
@@ -36,6 +35,7 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
/**
@@ -109,8 +109,9 @@
*
* @param title the title of the window.
* @param includeScript boolean set true if windowtitle script is to be included
+ * @throws DocFileIOException if there is a problem building the package index file
*/
- protected void buildPackageIndexFile(String title, boolean includeScript) throws IOException {
+ protected void buildPackageIndexFile(String title, boolean includeScript) throws DocFileIOException {
String windowOverview = configuration.getText(title);
Content body = getBody(includeScript, getWindowTitle(windowOverview));
addNavigationBarHeader(body);
@@ -127,8 +128,7 @@
*
* @param body the document tree to which the overview will be added
*/
- protected void addOverview(Content body) throws IOException {
- }
+ protected void addOverview(Content body) { }
/**
* Adds the frame or non-frame package index to the documentation tree.
@@ -190,6 +190,7 @@
*
* @return a Content object to be added to the documentation tree
*/
+ @Override
protected Content getNavLinkContents() {
Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, contents.overviewLabel);
return li;
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractTreeWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractTreeWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.TypeElement;
@@ -37,7 +36,6 @@
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
@@ -67,8 +65,6 @@
* @param configuration The current configuration
* @param filename File to be generated.
* @param classtree Tree built by {@link ClassTree}.
- * @throws IOException
- * @throws DocletAbortException
*/
protected AbstractTreeWriter(ConfigurationImpl configuration,
DocPath filename, ClassTree classtree) {
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AllClassesFrameWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AllClassesFrameWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.IOException;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
@@ -35,10 +34,9 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.IndexBuilder;
@@ -75,8 +73,6 @@
* @param configuration The current configuration
* @param filename Path to the file which is getting generated.
* @param indexbuilder Unicode based Index from {@link IndexBuilder}
- * @throws IOException
- * @throws DocletAbortException
*/
public AllClassesFrameWriter(ConfigurationImpl configuration,
DocPath filename, IndexBuilder indexbuilder) {
@@ -90,10 +86,10 @@
* destination directory.
*
* @param indexBuilder IndexBuilder object for all classes index.
- * @throws DocletAbortException
+ * @throws DocFileIOException
*/
public static void generate(ConfigurationImpl configuration,
- IndexBuilder indexBuilder) {
+ IndexBuilder indexBuilder) throws DocFileIOException {
if (configuration.frames) {
generate(configuration, indexBuilder, DocPaths.ALLCLASSES_FRAME, true);
generate(configuration, indexBuilder, DocPaths.ALLCLASSES_NOFRAME, false);
@@ -103,27 +99,19 @@
}
private static void generate(ConfigurationImpl configuration, IndexBuilder indexBuilder,
- DocPath fileName, boolean wantFrames) {
- try {
- AllClassesFrameWriter allclassgen = new AllClassesFrameWriter(configuration,
- fileName, indexBuilder);
- allclassgen.buildAllClassesFile(wantFrames);
- allclassgen = new AllClassesFrameWriter(configuration,
- fileName, indexBuilder);
- allclassgen.buildAllClassesFile(false);
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), fileName);
- throw new DocletAbortException(exc);
- }
+ DocPath fileName, boolean wantFrames) throws DocFileIOException {
+ AllClassesFrameWriter allclassgen = new AllClassesFrameWriter(configuration,
+ fileName, indexBuilder);
+ allclassgen.buildAllClassesFile(wantFrames);
+ allclassgen = new AllClassesFrameWriter(configuration,
+ fileName, indexBuilder);
}
/**
* Print all the classes in the file.
* @param wantFrames True if we want frames.
*/
- protected void buildAllClassesFile(boolean wantFrames) throws IOException {
+ protected void buildAllClassesFile(boolean wantFrames) throws DocFileIOException {
String label = configuration.getText("doclet.All_Classes");
Content body = getBody(false, getWindowTitle(label));
Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING,
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AnnotationTypeWriterImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AnnotationTypeWriterImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.IOException;
import java.util.List;
import javax.lang.model.element.PackageElement;
@@ -42,9 +41,9 @@
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.builders.MemberSummaryBuilder;
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
/**
@@ -78,11 +77,9 @@
* @param annotationType the annotation type being documented.
* @param prevType the previous class that was documented.
* @param nextType the next class being documented.
- * @throws java.lang.Exception
*/
public AnnotationTypeWriterImpl(ConfigurationImpl configuration,
- TypeElement annotationType, TypeMirror prevType, TypeMirror nextType)
- throws Exception {
+ TypeElement annotationType, TypeMirror prevType, TypeMirror nextType) {
super(configuration, DocPath.forClass(configuration.utils, annotationType));
this.annotationType = annotationType;
configuration.currentTypeElement = annotationType;
@@ -243,7 +240,7 @@
* {@inheritDoc}
*/
@Override
- public void printDocument(Content contentTree) throws IOException {
+ public void printDocument(Content contentTree) throws DocFileIOException {
printHtmlDocument(configuration.metakeywords.getMetaKeywords(annotationType),
true, contentTree);
}
@@ -352,22 +349,17 @@
*/
@Override
protected void addSummaryDetailLinks(Content subDiv) {
- try {
- Content div = HtmlTree.DIV(getNavSummaryLinks());
- div.addContent(getNavDetailLinks());
- subDiv.addContent(div);
- } catch (Exception e) {
- throw new DocletAbortException(e);
- }
+ Content div = HtmlTree.DIV(getNavSummaryLinks());
+ div.addContent(getNavDetailLinks());
+ subDiv.addContent(div);
}
/**
* Get summary links for navigation bar.
*
* @return the content tree for the navigation summary links
- * @throws java.lang.Exception
*/
- protected Content getNavSummaryLinks() throws Exception {
+ protected Content getNavSummaryLinks() {
Content li = HtmlTree.LI(contents.summaryLabel);
li.addContent(Contents.SPACE);
Content ulNav = HtmlTree.UL(HtmlStyle.subNavList, li);
@@ -417,9 +409,8 @@
* Get detail links for the navigation bar.
*
* @return the content tree for the detail links
- * @throws java.lang.Exception
*/
- protected Content getNavDetailLinks() throws Exception {
+ protected Content getNavDetailLinks() {
Content li = HtmlTree.LI(contents.detailLabel);
li.addContent(Contents.SPACE);
Content ulNav = HtmlTree.UL(HtmlStyle.subNavList, li);
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ClassUseWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ClassUseWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
@@ -47,12 +46,11 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
import jdk.javadoc.internal.doclets.toolkit.util.ClassUseMapper;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
* Generate class usage information.
@@ -112,12 +110,10 @@
* Constructor.
*
* @param filename the file to be generated.
- * @throws IOException
- * @throws DocletAbortException
*/
public ClassUseWriter(ConfigurationImpl configuration,
ClassUseMapper mapper, DocPath filename,
- TypeElement typeElement) throws IOException {
+ TypeElement typeElement) {
super(configuration, filename);
this.typeElement = typeElement;
if (mapper.classToPackageAnnotations.containsKey(typeElement)) {
@@ -175,9 +171,12 @@
/**
* Write out class use pages.
- * @throws DocletAbortException
+ *
+ * @param configuration the configuration for this doclet
+ * @param classtree the class tree hierarchy
+ * @throws DocFileIOException if there is an error while generating the documentation
*/
- public static void generate(ConfigurationImpl configuration, ClassTree classtree) {
+ public static void generate(ConfigurationImpl configuration, ClassTree classtree) throws DocFileIOException {
ClassUseMapper mapper = new ClassUseMapper(configuration, classtree);
for (TypeElement aClass : configuration.docEnv.getIncludedTypeElements()) {
// If -nodeprecated option is set and the containing package is marked
@@ -217,28 +216,25 @@
/**
* Generate a class page.
+ *
+ * @throws DocFileIOException if there is a problem while generating the documentation
*/
public static void generate(ConfigurationImpl configuration, ClassUseMapper mapper,
- TypeElement typeElement) {
+ TypeElement typeElement) throws DocFileIOException {
ClassUseWriter clsgen;
DocPath path = DocPath.forPackage(configuration.utils, typeElement)
.resolve(DocPaths.CLASS_USE)
.resolve(DocPath.forName(configuration.utils, typeElement));
- try {
- clsgen = new ClassUseWriter(configuration, mapper, path, typeElement);
- clsgen.generateClassUseFile();
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), path.getPath());
- throw new DocletAbortException(exc);
- }
+ clsgen = new ClassUseWriter(configuration, mapper, path, typeElement);
+ clsgen.generateClassUseFile();
}
/**
* Generate the class use elements.
+ *
+ * @throws DocFileIOException if there is a problem while generating the documentation
*/
- protected void generateClassUseFile() throws IOException {
+ protected void generateClassUseFile() throws DocFileIOException {
HtmlTree body = getClassUseHeader();
HtmlTree div = new HtmlTree(HtmlTag.DIV);
div.addStyle(HtmlStyle.classUseContainer);
@@ -270,7 +266,7 @@
*
* @param contentTree the content tree to which the class use information will be added
*/
- protected void addClassUse(Content contentTree) throws IOException {
+ protected void addClassUse(Content contentTree) {
HtmlTree ul = new HtmlTree(HtmlTag.UL);
ul.addStyle(HtmlStyle.blockList);
if (configuration.packages.size() > 1) {
@@ -286,7 +282,7 @@
*
* @param contentTree the content tree to which the packages elements will be added
*/
- protected void addPackageList(Content contentTree) throws IOException {
+ protected void addPackageList(Content contentTree) {
Content caption = getTableCaption(configuration.getContent(
"doclet.ClassUse_Packages.that.use.0",
getLink(new LinkInfoImpl(configuration,
@@ -314,7 +310,7 @@
*
* @param contentTree the content tree to which the package annotation elements will be added
*/
- protected void addPackageAnnotationList(Content contentTree) throws IOException {
+ protected void addPackageAnnotationList(Content contentTree) {
if (!utils.isAnnotationType(typeElement) ||
pkgToPackageAnnotations == null ||
pkgToPackageAnnotations.isEmpty()) {
@@ -352,7 +348,7 @@
*
* @param contentTree the content tree to which the class elements will be added
*/
- protected void addClassList(Content contentTree) throws IOException {
+ protected void addClassList(Content contentTree) {
HtmlTree ul = new HtmlTree(HtmlTag.UL);
ul.addStyle(HtmlStyle.blockList);
for (PackageElement pkg : pkgSet) {
@@ -383,7 +379,7 @@
* @param pkg the package that uses the given class
* @param contentTree the content tree to which the package use information will be added
*/
- protected void addPackageUse(PackageElement pkg, Content contentTree) throws IOException {
+ protected void addPackageUse(PackageElement pkg, Content contentTree) {
Content tdFirst = HtmlTree.TD(HtmlStyle.colFirst,
getHyperLink(getPackageAnchorName(pkg), new StringContent(utils.getPackageName(pkg))));
contentTree.addContent(tdFirst);
@@ -399,7 +395,7 @@
* @param pkg the package that uses the given class
* @param contentTree the content tree to which the class use information will be added
*/
- protected void addClassUse(PackageElement pkg, Content contentTree) throws IOException {
+ protected void addClassUse(PackageElement pkg, Content contentTree) {
Content classLink = getLink(new LinkInfoImpl(configuration,
LinkInfoImpl.Kind.CLASS_USE_HEADER, typeElement));
Content pkgLink = getPackageLink(pkg, utils.getPackageName(pkg));
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ClassWriterImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ClassWriterImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.IOException;
import java.util.*;
import javax.lang.model.element.AnnotationMirror;
@@ -37,8 +36,6 @@
import javax.lang.model.util.SimpleElementVisitor8;
import com.sun.source.doctree.DocTree;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
@@ -50,9 +47,9 @@
import jdk.javadoc.internal.doclets.toolkit.taglets.ParamTaglet;
import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap.Kind;
@@ -91,11 +88,9 @@
* @param prevClass the previous class that was documented.
* @param nextClass the next class being documented.
* @param classTree the class tree for the given class.
- * @throws java.io.IOException
*/
public ClassWriterImpl(ConfigurationImpl configuration, TypeElement typeElement,
- TypeElement prevClass, TypeElement nextClass, ClassTree classTree)
- throws IOException {
+ TypeElement prevClass, TypeElement nextClass, ClassTree classTree) {
super(configuration, DocPath.forClass(configuration.utils, typeElement));
this.typeElement = typeElement;
configuration.currentTypeElement = typeElement;
@@ -272,7 +267,7 @@
* {@inheritDoc}
*/
@Override
- public void printDocument(Content contentTree) throws IOException {
+ public void printDocument(Content contentTree) throws DocFileIOException {
printHtmlDocument(configuration.metakeywords.getMetaKeywords(typeElement),
true, contentTree);
}
@@ -563,7 +558,7 @@
if (outerClass == null)
return;
new SimpleElementVisitor8<Void, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitType(TypeElement e, Void p) {
Content label = utils.isInterface(e)
? contents.enclosingInterfaceLabel
@@ -677,14 +672,11 @@
*
* @param subDiv the content tree to which the summary detail links will be added
*/
+ @Override
protected void addSummaryDetailLinks(Content subDiv) {
- try {
- Content div = HtmlTree.DIV(getNavSummaryLinks());
- div.addContent(getNavDetailLinks());
- subDiv.addContent(div);
- } catch (Exception e) {
- throw new DocletAbortException(e);
- }
+ Content div = HtmlTree.DIV(getNavSummaryLinks());
+ div.addContent(getNavDetailLinks());
+ subDiv.addContent(div);
}
/**
@@ -692,7 +684,7 @@
*
* @return the content tree for the navigation summary links
*/
- protected Content getNavSummaryLinks() throws Exception {
+ protected Content getNavSummaryLinks() {
Content li = HtmlTree.LI(contents.summaryLabel);
li.addContent(Contents.SPACE);
Content ulNav = HtmlTree.UL(HtmlStyle.subNavList, li);
@@ -727,9 +719,8 @@
* Get detail links for the navigation bar.
*
* @return the content tree for the detail links
- * @throws java.lang.Exception
*/
- protected Content getNavDetailLinks() throws Exception {
+ protected Content getNavDetailLinks() {
Content li = HtmlTree.LI(contents.detailLabel);
li.addContent(Contents.SPACE);
Content ulNav = HtmlTree.UL(HtmlStyle.subNavList, li);
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConfigurationImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConfigurationImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -50,7 +50,6 @@
import jdk.javadoc.internal.doclets.toolkit.util.DocFile;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
import static javax.tools.Diagnostic.Kind.*;
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConstantsSummaryWriterImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConstantsSummaryWriterImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -41,6 +41,7 @@
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.ConstantsSummaryWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocLink;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
@@ -379,7 +380,8 @@
/**
* {@inheritDoc}
*/
- public void printDocument(Content contentTree) throws IOException {
+ @Override
+ public void printDocument(Content contentTree) throws DocFileIOException {
printHtmlDocument(null, true, contentTree);
}
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/DeprecatedListWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/DeprecatedListWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.ArrayList;
import java.util.EnumMap;
import java.util.List;
@@ -35,13 +34,11 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
import jdk.javadoc.internal.doclets.toolkit.util.DeprecatedAPIListBuilder;
+import jdk.javadoc.internal.doclets.toolkit.util.DeprecatedAPIListBuilder.DeprElementKind;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
-
-import static jdk.javadoc.internal.doclets.toolkit.util.DeprecatedAPIListBuilder.*;
/**
* Generate File to list all the deprecated classes and class members with the
@@ -189,11 +186,11 @@
/**
* Constructor.
*
- * @param filename the file to be generated.
+ * @param configuration the configuration for this doclet
+ * @param filename the file to be generated
*/
- public DeprecatedListWriter(ConfigurationImpl configuration,
- DocPath filename) throws IOException {
+ public DeprecatedListWriter(ConfigurationImpl configuration, DocPath filename) {
super(configuration, filename);
this.configuration = configuration;
NestedClassWriterImpl classW = new NestedClassWriterImpl(this);
@@ -236,29 +233,23 @@
* Then instantiate DeprecatedListWriter and generate File.
*
* @param configuration the current configuration of the doclet.
+ * @throws DocFileIOException if there is a problem writing the deprecated list
*/
- public static void generate(ConfigurationImpl configuration) {
+ public static void generate(ConfigurationImpl configuration) throws DocFileIOException {
DocPath filename = DocPaths.DEPRECATED_LIST;
- try {
- DeprecatedListWriter depr =
- new DeprecatedListWriter(configuration, filename);
- depr.generateDeprecatedListFile(
- new DeprecatedAPIListBuilder(configuration));
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
+ DeprecatedListWriter depr = new DeprecatedListWriter(configuration, filename);
+ depr.generateDeprecatedListFile(
+ new DeprecatedAPIListBuilder(configuration));
}
/**
* Generate the deprecated API list.
*
* @param deprapi list of deprecated API built already.
+ * @throws DocFileIOException if there is a problem writing the deprecated list
*/
protected void generateDeprecatedListFile(DeprecatedAPIListBuilder deprapi)
- throws IOException {
+ throws DocFileIOException {
HtmlTree body = getHeader();
HtmlTree htmlTree = (configuration.allowTag(HtmlTag.MAIN))
? HtmlTree.MAIN()
@@ -378,6 +369,7 @@
*
* @return a content tree for the deprecated label
*/
+ @Override
protected Content getNavLinkDeprecated() {
Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, contents.deprecatedLabel);
return li;
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/FrameOutputWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/FrameOutputWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,17 +25,14 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
-
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlAttr;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
@@ -67,7 +64,6 @@
*
* @param configuration for this run
* @param filename File to be generated.
- * @throws java.io.IOException
*/
public FrameOutputWriter(ConfigurationImpl configuration, DocPath filename) {
super(configuration, filename);
@@ -79,28 +75,20 @@
* file which will have the description of all the frames in the
* documentation. The name of the generated file is "index.html" which is
* the default first file for Html documents.
- * @throws DocletAbortException
+ * @param configuration the configuration for this doclet
+ * @throws DocFileIOException if there is a problem generating the frame file
*/
- public static void generate(ConfigurationImpl configuration) {
- FrameOutputWriter framegen;
- DocPath filename = DocPath.empty;
- try {
- filename = DocPaths.INDEX;
- framegen = new FrameOutputWriter(configuration, filename);
- framegen.generateFrameFile();
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
+ public static void generate(ConfigurationImpl configuration) throws DocFileIOException {
+ FrameOutputWriter framegen = new FrameOutputWriter(configuration, DocPaths.INDEX);
+ framegen.generateFrameFile();
}
/**
* Generate the constants in the "index.html" file. Print the frame details
* as well as warning if browser is not supporting the Html frames.
+ * @throws DocFileIOException if there is a problem generating the frame file
*/
- protected void generateFrameFile() throws IOException {
+ protected void generateFrameFile() throws DocFileIOException {
Content frame = getFrameDetails();
HtmlTree body = new HtmlTree(HtmlTag.BODY);
body.addAttr(HtmlAttr.ONLOAD, "loadFrames()");
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HelpWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HelpWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,18 +25,15 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
-
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
@@ -68,27 +65,21 @@
* file. The name of the generated file is "help-doc.html". The help file
* will get generated if and only if "-helpfile" and "-nohelp" is not used
* on the command line.
- * @throws DocletAbortException
+ *
+ * @throws DocFileIOException if there is a problem while generating the documentation
*/
- public static void generate(ConfigurationImpl configuration) {
- HelpWriter helpgen;
- DocPath filename = DocPath.empty;
- try {
- filename = DocPaths.HELP_DOC;
- helpgen = new HelpWriter(configuration, filename);
- helpgen.generateHelpFile();
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
+ public static void generate(ConfigurationImpl configuration) throws DocFileIOException {
+ DocPath filename = DocPaths.HELP_DOC;
+ HelpWriter helpgen = new HelpWriter(configuration, filename);
+ helpgen.generateHelpFile();
}
/**
* Generate the help file contents.
+ *
+ * @throws DocFileIOException if there is a problem while generating the documentation
*/
- protected void generateHelpFile() throws IOException {
+ protected void generateHelpFile() throws DocFileIOException {
String title = configuration.getText("doclet.Window_Help_title");
HtmlTree body = getBody(true, getWindowTitle(title));
HtmlTree htmlTree = (configuration.allowTag(HtmlTag.HEADER))
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDoclet.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDoclet.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.ModuleElement;
@@ -36,14 +35,14 @@
import jdk.javadoc.doclet.DocletEnvironment;
import jdk.javadoc.doclet.Reporter;
import jdk.javadoc.internal.doclets.toolkit.AbstractDoclet;
-import jdk.javadoc.internal.doclets.toolkit.Configuration;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.Messages;
import jdk.javadoc.internal.doclets.toolkit.builders.AbstractBuilder;
import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
import jdk.javadoc.internal.doclets.toolkit.util.DocFile;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.IndexBuilder;
/**
@@ -92,25 +91,27 @@
* Create the configuration instance.
* Override this method to use a different
* configuration.
+ * @return the configuration for this doclet
*/
@Override // defined by AbstractDoclet
- public Configuration configuration() {
+ public ConfigurationImpl configuration() {
return configuration;
}
/**
* Start the generation of files. Call generate methods in the individual
- * writers, which will in turn genrate the documentation files. Call the
+ * writers, which will in turn generate the documentation files. Call the
* TreeWriter generation first to ensure the Class Hierarchy is built
* first and then can be used in the later generation.
*
* For new format.
*
+ * @throws DocletException if there is a problem while writing the other files
* @see jdk.doclet.DocletEnvironment
*/
@Override // defined by AbstractDoclet
protected void generateOtherFiles(DocletEnvironment docEnv, ClassTree classtree)
- throws Exception {
+ throws DocletException {
super.generateOtherFiles(docEnv, classtree);
if (configuration.linksource) {
SourceToHTMLConverter.convertRoot(configuration,
@@ -191,7 +192,7 @@
}
}
- protected void copyJqueryFiles() {
+ protected void copyJqueryFiles() throws DocletException {
List<String> files = Arrays.asList(
"jquery-1.10.2.js",
"jquery-ui.js",
@@ -232,7 +233,8 @@
* {@inheritDoc}
*/
@Override // defined by AbstractDoclet
- protected void generateClassFiles(SortedSet<TypeElement> arr, ClassTree classtree) {
+ protected void generateClassFiles(SortedSet<TypeElement> arr, ClassTree classtree)
+ throws DocletException {
List<TypeElement> list = new ArrayList<>(arr);
ListIterator<TypeElement> iterator = list.listIterator();
TypeElement klass = null;
@@ -241,32 +243,24 @@
klass = iterator.next();
TypeElement next = iterator.nextIndex() == list.size()
? null : list.get(iterator.nextIndex());
+
if (utils.isHidden(klass) ||
!(configuration.isGeneratedDoc(klass) && utils.isIncluded(klass))) {
continue;
}
- try {
- if (utils.isAnnotationType(klass)) {
- AbstractBuilder annotationTypeBuilder =
- configuration.getBuilderFactory()
- .getAnnotationTypeBuilder(klass,
- prev == null ? null : prev.asType(),
- next == null ? null : next.asType());
- annotationTypeBuilder.build();
- } else {
- AbstractBuilder classBuilder =
- configuration.getBuilderFactory().getClassBuilder(klass,
- prev, next, classtree);
- classBuilder.build();
- }
- } catch (IOException e) {
- throw new DocletAbortException(e);
- } catch (DocletAbortException de) {
- de.printStackTrace();
- throw de;
- } catch (Exception e) {
- e.printStackTrace();
- throw new DocletAbortException(e);
+
+ if (utils.isAnnotationType(klass)) {
+ AbstractBuilder annotationTypeBuilder =
+ configuration.getBuilderFactory()
+ .getAnnotationTypeBuilder(klass,
+ prev == null ? null : prev.asType(),
+ next == null ? null : next.asType());
+ annotationTypeBuilder.build();
+ } else {
+ AbstractBuilder classBuilder =
+ configuration.getBuilderFactory().getClassBuilder(klass,
+ prev, next, classtree);
+ classBuilder.build();
}
}
}
@@ -275,7 +269,7 @@
* {@inheritDoc}
*/
@Override // defined by AbstractDoclet
- protected void generateModuleFiles() throws Exception {
+ protected void generateModuleFiles() throws DocletException {
if (configuration.showModules) {
if (configuration.frames) {
ModuleIndexFrameWriter.generate(configuration);
@@ -313,7 +307,7 @@
* {@inheritDoc}
*/
@Override // defined by AbstractDoclet
- protected void generatePackageFiles(ClassTree classtree) throws Exception {
+ protected void generatePackageFiles(ClassTree classtree) throws DocletException {
Set<PackageElement> packages = configuration.packages;
if (packages.size() > 1 && configuration.frames) {
PackageIndexFrameWriter.generate(configuration);
@@ -356,24 +350,18 @@
return configuration.getSupportedOptions();
}
- private void performCopy(String filename) {
+ private void performCopy(String filename) throws DocFileIOException {
if (filename.isEmpty())
return;
- try {
- DocFile fromfile = DocFile.createFileForInput(configuration, filename);
- DocPath path = DocPath.create(fromfile.getName());
- DocFile toFile = DocFile.createFileForOutput(configuration, path);
- if (toFile.isSameFile(fromfile))
- return;
+ DocFile fromfile = DocFile.createFileForInput(configuration, filename);
+ DocPath path = DocPath.create(fromfile.getName());
+ DocFile toFile = DocFile.createFileForOutput(configuration, path);
+ if (toFile.isSameFile(fromfile))
+ return;
- messages.notice("doclet.Copying_File_0_To_File_1",
- fromfile.toString(), path.getPath());
- toFile.copyFile(fromfile);
- } catch (IOException exc) {
- messages.error("doclet.perform_copy_exception_encountered",
- exc.toString());
- throw new DocletAbortException(exc);
- }
+ messages.notice("doclet.Copying_File_0_To_File_1",
+ fromfile.toString(), path.getPath());
+ toFile.copyFile(fromfile);
}
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.text.SimpleDateFormat;
import java.util.*;
import java.util.regex.Matcher;
@@ -55,16 +54,14 @@
import com.sun.source.doctree.EndElementTree;
import com.sun.source.doctree.EntityTree;
import com.sun.source.doctree.ErroneousTree;
+import com.sun.source.doctree.IndexTree;
import com.sun.source.doctree.InheritDocTree;
-import com.sun.source.doctree.IndexTree;
import com.sun.source.doctree.LinkTree;
import com.sun.source.doctree.LiteralTree;
import com.sun.source.doctree.SeeTree;
import com.sun.source.doctree.StartElementTree;
import com.sun.source.doctree.TextTree;
import com.sun.source.util.SimpleDocTreeVisitor;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import jdk.javadoc.internal.doclets.formats.html.markup.Comment;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
@@ -87,14 +84,15 @@
import jdk.javadoc.internal.doclets.toolkit.Resources;
import jdk.javadoc.internal.doclets.toolkit.taglets.DocRootTaglet;
import jdk.javadoc.internal.doclets.toolkit.taglets.TagletWriter;
+import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
import jdk.javadoc.internal.doclets.toolkit.util.DocFile;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocLink;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
import jdk.javadoc.internal.doclets.toolkit.util.ImplementedMethods;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
-import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
import static com.sun.source.doctree.AttributeTree.ValueKind.*;
import static com.sun.source.doctree.DocTree.Kind.*;
@@ -439,9 +437,10 @@
* @param includeScript true if printing windowtitle script
* false for files that appear in the left-hand frames
* @param body the body htmltree to be included in the document
+ * @throws DocFileIOException if there is a problem writing the file
*/
public void printHtmlDocument(List<String> metakeywords, boolean includeScript,
- Content body) throws IOException {
+ Content body) throws DocFileIOException {
Content htmlDocType = configuration.isOutputHtml5()
? DocType.HTML5
: DocType.TRANSITIONAL;
@@ -1834,7 +1833,7 @@
return false;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitAttribute(AttributeTree node, Content c) {
StringBuilder sb = new StringBuilder(SPACER).append(node.getName());
if (node.getValueKind() == ValueKind.EMPTY) {
@@ -1883,7 +1882,7 @@
return false;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitComment(CommentTree node, Content c) {
if (isFirstSentence && isFirst(node)) {
commentRemoved = true;
@@ -1901,7 +1900,7 @@
return content;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitDocRoot(DocRootTree node, Content c) {
Content docRootContent = TagletWriter.getInlineTagOutput(element,
configuration.tagletManager,
@@ -1916,20 +1915,20 @@
return false;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitEndElement(EndElementTree node, Content c) {
RawHtml rawHtml = new RawHtml("</" + node.getName() + ">");
result.addContent(rawHtml);
return false;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitEntity(EntityTree node, Content c) {
result.addContent(new RawHtml(node.toString()));
return false;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitErroneous(ErroneousTree node, Content c) {
messages.warning(ch.getDocTreePath(node),
"doclet.tag.invalid_usage", node);
@@ -1937,7 +1936,7 @@
return false;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitInheritDoc(InheritDocTree node, Content c) {
Content output = TagletWriter.getInlineTagOutput(element,
configuration.tagletManager, holderTag,
@@ -1947,7 +1946,7 @@
return (isFirstSentence && !output.isEmpty());
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitIndex(IndexTree node, Content p) {
Content output = TagletWriter.getInlineTagOutput(element,
configuration.tagletManager, holderTag, tag,
@@ -1958,14 +1957,14 @@
return false;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitLink(LinkTree node, Content c) {
// we need to pass the DocTreeImpl here, so ignore node
result.addContent(seeTagToContent(element, tag));
return false;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitLiteral(LiteralTree node, Content c) {
String s = node.getBody().toString();
Content content = new StringContent(utils.normalizeNewlines(s));
@@ -1975,14 +1974,14 @@
return false;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitSee(SeeTree node, Content c) {
// we need to pass the DocTreeImpl here, so ignore node
result.addContent(seeTagToContent(element, tag));
return false;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitStartElement(StartElementTree node, Content c) {
String text = "<" + node.getName();
RawHtml rawHtml = new RawHtml(utils.normalizeNewlines(text));
@@ -2010,7 +2009,7 @@
return utils.normalizeNewlines(text);
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Boolean visitText(TextTree node, Content c) {
String text = node.getBody();
result.addContent(new RawHtml(textCleanup(text, isLast(node), commentRemoved)));
@@ -2018,7 +2017,7 @@
return false;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
protected Boolean defaultAction(DocTree node, Content c) {
Content output = TagletWriter.getInlineTagOutput(element,
configuration.tagletManager, holderTag, tag,
@@ -2096,27 +2095,27 @@
}
DocPath redirectPathFromRoot = new SimpleElementVisitor9<DocPath, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public DocPath visitType(TypeElement e, Void p) {
return DocPath.forPackage(utils.containingPackage(e));
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public DocPath visitPackage(PackageElement e, Void p) {
return DocPath.forPackage(e);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public DocPath visitVariable(VariableElement e, Void p) {
return DocPath.forPackage(utils.containingPackage(e));
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public DocPath visitExecutable(ExecutableElement e, Void p) {
return DocPath.forPackage(utils.containingPackage(e));
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected DocPath defaultAction(Element e, Void p) {
return null;
}
@@ -2180,8 +2179,8 @@
head.addContent(javascript);
if (configuration.createindex) {
if (pathToRoot != null && script != null) {
- String path = pathToRoot.isEmpty() ? "." : pathToRoot.getPath();
- script.addContent(new RawHtml("var pathtoroot = \"" + path + "/\";loadScripts(document, \'script\');"));
+ String ptrPath = pathToRoot.isEmpty() ? "." : pathToRoot.getPath();
+ script.addContent(new RawHtml("var pathtoroot = \"" + ptrPath + "/\";loadScripts(document, \'script\');"));
}
addJQueryFile(head, DocPaths.JSZIP_MIN);
addJQueryFile(head, DocPaths.JSZIPUTILS_MIN);
@@ -2377,13 +2376,13 @@
List<AnnotationValue> annotationTypeValues = new ArrayList<>();
new SimpleAnnotationValueVisitor9<Void, List<AnnotationValue>>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitArray(List<? extends AnnotationValue> vals, List<AnnotationValue> p) {
p.addAll(vals);
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Void defaultAction(Object o, List<AnnotationValue> p) {
p.add(annotationValue);
return null;
@@ -2405,7 +2404,7 @@
List<AnnotationValue> annotationTypeValues = new ArrayList<>();
for (AnnotationValue a : pairs.values()) {
new SimpleAnnotationValueVisitor9<Void, List<AnnotationValue>>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitArray(List<? extends AnnotationValue> vals, List<AnnotationValue> annotationTypeValues) {
for (AnnotationValue av : vals) {
annotationTypeValues.add(av);
@@ -2481,12 +2480,12 @@
AnnotationValue annotationValue = map.get(element);
List<AnnotationValue> annotationTypeValues = new ArrayList<>();
new SimpleAnnotationValueVisitor9<Void, AnnotationValue>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitArray(List<? extends AnnotationValue> vals, AnnotationValue p) {
annotationTypeValues.addAll(vals);
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Void defaultAction(Object o, AnnotationValue p) {
annotationTypeValues.add(p);
return null;
@@ -2519,13 +2518,13 @@
for (ExecutableElement ee : pairs.keySet()) {
annotationValue = pairs.get(ee);
boolean rvalue = new SimpleAnnotationValueVisitor9<Boolean, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitArray(List<? extends AnnotationValue> vals, Void p) {
if (vals.size() > 1) {
if (vals.get(0) instanceof AnnotationMirror) {
isContainerDocumented = true;
return new SimpleAnnotationValueVisitor9<Boolean, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitAnnotation(AnnotationMirror a, Void p) {
isContainerDocumented = true;
Element asElement = a.getAnnotationType().asElement();
@@ -2534,7 +2533,7 @@
}
return true;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Boolean defaultAction(Object o, Void p) {
return false;
}
@@ -2544,7 +2543,7 @@
return false;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Boolean defaultAction(Object o, Void p) {
return false;
}
@@ -2559,10 +2558,10 @@
private Content annotationValueToContent(AnnotationValue annotationValue) {
return new SimpleAnnotationValueVisitor9<Content, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Content visitType(TypeMirror t, Void p) {
return new SimpleTypeVisitor9<Content, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Content visitDeclared(DeclaredType t, Void p) {
LinkInfoImpl linkInfo = new LinkInfoImpl(configuration,
LinkInfoImpl.Kind.ANNOTATION, t);
@@ -2572,13 +2571,13 @@
linkInfo.label = new StringContent(name + utils.getDimension(t) + ".class");
return getLink(linkInfo);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Content defaultAction(TypeMirror e, Void p) {
return new StringContent(t + utils.getDimension(t) + ".class");
}
}.visit(t);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Content visitAnnotation(AnnotationMirror a, Void p) {
List<Content> list = getAnnotations(0, a, false);
ContentBuilder buf = new ContentBuilder();
@@ -2587,12 +2586,12 @@
}
return buf;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Content visitEnumConstant(VariableElement c, Void p) {
return getDocLink(LinkInfoImpl.Kind.ANNOTATION,
c, c.getSimpleName(), false);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Content visitArray(List<? extends AnnotationValue> vals, Void p) {
ContentBuilder buf = new ContentBuilder();
String sep = "";
@@ -2603,7 +2602,7 @@
}
return buf;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Content defaultAction(Object o, Void p) {
return new StringContent(annotationValue.toString());
}
@@ -2615,6 +2614,7 @@
*
* @return the configuration for this doclet.
*/
+ @Override
public Configuration configuration() {
return configuration;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/IndexRedirectWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/IndexRedirectWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,8 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.IOException;
-
import jdk.javadoc.internal.doclets.formats.html.markup.Comment;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.DocType;
@@ -37,10 +35,9 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import static jdk.javadoc.internal.doclets.formats.html.markup.HtmlDocWriter.CONTENT_TYPE;
@@ -53,28 +50,23 @@
*/
public class IndexRedirectWriter extends HtmlDocletWriter {
- public static void generate(ConfigurationImpl configuration) {
+ public static void generate(ConfigurationImpl configuration)
+ throws DocFileIOException {
IndexRedirectWriter indexRedirect;
- DocPath filename = DocPath.empty;
- try {
- filename = DocPaths.INDEX;
+ DocPath filename = DocPaths.INDEX;
indexRedirect = new IndexRedirectWriter(configuration, filename);
indexRedirect.generateIndexFile();
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error(
- "doclet.exception_encountered",
- exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
}
- IndexRedirectWriter(ConfigurationImpl configuration, DocPath filename)
- throws IOException {
+ IndexRedirectWriter(ConfigurationImpl configuration, DocPath filename) {
super(configuration, filename);
}
- void generateIndexFile() throws IOException {
+ /**
+ * Generate an index file that redirects to an alternate file.
+ * @throws DocFileIOException if there is a problem generating the file
+ */
+ void generateIndexFile() throws DocFileIOException {
Content htmlDocType = configuration.isOutputHtml5()
? DocType.HTML5
: DocType.TRANSITIONAL;
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleFrameWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleFrameWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.ModuleElement;
@@ -39,8 +38,8 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
@@ -76,8 +75,7 @@
* @param configuration the configuration of the doclet.
* @param moduleElement moduleElement under consideration.
*/
- public ModuleFrameWriter(ConfigurationImpl configuration, ModuleElement moduleElement)
- throws IOException {
+ public ModuleFrameWriter(ConfigurationImpl configuration, ModuleElement moduleElement) {
super(configuration, DocPaths.moduleTypeFrame(moduleElement));
this.mdle = moduleElement;
if (configuration.getSpecifiedPackages().isEmpty()) {
@@ -91,35 +89,29 @@
*
* @param configuration the current configuration of the doclet.
* @param moduleElement The package for which "module_name-type-frame.html" is to be generated.
+ * @throws DocFileIOException if there is a problem generating the module summary file
*/
- public static void generate(ConfigurationImpl configuration, ModuleElement moduleElement) {
- ModuleFrameWriter mdlgen;
- try {
- mdlgen = new ModuleFrameWriter(configuration, moduleElement);
- String mdlName = moduleElement.getQualifiedName().toString();
- Content mdlLabel = new StringContent(mdlName);
- HtmlTree body = mdlgen.getBody(false, mdlgen.getWindowTitle(mdlName));
- HtmlTree htmlTree = (configuration.allowTag(HtmlTag.MAIN))
- ? HtmlTree.MAIN()
- : body;
- Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, HtmlStyle.bar,
- mdlgen.getHyperLink(DocPaths.moduleSummary(moduleElement), mdlLabel, "", "classFrame"));
- htmlTree.addContent(heading);
- HtmlTree div = new HtmlTree(HtmlTag.DIV);
- div.addStyle(HtmlStyle.indexContainer);
- mdlgen.addClassListing(div);
- htmlTree.addContent(div);
- if (configuration.allowTag(HtmlTag.MAIN)) {
- body.addContent(htmlTree);
- }
- mdlgen.printHtmlDocument(
- configuration.metakeywords.getMetaKeywordsForModule(moduleElement), false, body);
- } catch (IOException exc) {
- configuration.messages.error(
- "doclet.exception_encountered",
- exc.toString(), DocPaths.moduleTypeFrame(moduleElement).getPath());
- throw new DocletAbortException(exc);
+ public static void generate(ConfigurationImpl configuration, ModuleElement moduleElement)
+ throws DocFileIOException {
+ ModuleFrameWriter mdlgen = new ModuleFrameWriter(configuration, moduleElement);
+ String mdlName = moduleElement.getQualifiedName().toString();
+ Content mdlLabel = new StringContent(mdlName);
+ HtmlTree body = mdlgen.getBody(false, mdlgen.getWindowTitle(mdlName));
+ HtmlTree htmlTree = (configuration.allowTag(HtmlTag.MAIN))
+ ? HtmlTree.MAIN()
+ : body;
+ Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, HtmlStyle.bar,
+ mdlgen.getHyperLink(DocPaths.moduleSummary(moduleElement), mdlLabel, "", "classFrame"));
+ htmlTree.addContent(heading);
+ HtmlTree div = new HtmlTree(HtmlTag.DIV);
+ div.addStyle(HtmlStyle.indexContainer);
+ mdlgen.addClassListing(div);
+ htmlTree.addContent(div);
+ if (configuration.allowTag(HtmlTag.MAIN)) {
+ body.addContent(htmlTree);
}
+ mdlgen.printHtmlDocument(
+ configuration.metakeywords.getMetaKeywordsForModule(moduleElement), false, body);
}
/**
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleIndexFrameWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleIndexFrameWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.Map;
import java.util.Set;
@@ -39,10 +38,9 @@
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
* Generate the module index for the left-hand frame in the generated output.
@@ -65,27 +63,19 @@
* @param filename Name of the module index file to be generated.
*/
public ModuleIndexFrameWriter(ConfigurationImpl configuration,
- DocPath filename) throws IOException {
+ DocPath filename) {
super(configuration, filename);
}
/**
* Generate the module index file named "module-overview-frame.html".
- * @throws DocletAbortException
+ * @throws DocFileIOException
* @param configuration the configuration object
*/
- public static void generate(ConfigurationImpl configuration) {
- ModuleIndexFrameWriter modulegen;
+ public static void generate(ConfigurationImpl configuration) throws DocFileIOException {
DocPath filename = DocPaths.MODULE_OVERVIEW_FRAME;
- try {
- modulegen = new ModuleIndexFrameWriter(configuration, filename);
- modulegen.buildModuleIndexFile("doclet.Window_Overview", false);
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
+ ModuleIndexFrameWriter modulegen = new ModuleIndexFrameWriter(configuration, filename);
+ modulegen.buildModuleIndexFile("doclet.Window_Overview", false);
}
/**
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleIndexWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleIndexWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,13 +25,11 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.ModuleElement;
import javax.lang.model.element.PackageElement;
-import jdk.javadoc.doclet.DocletEnvironment;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
@@ -39,10 +37,9 @@
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.Group;
/**
@@ -68,15 +65,14 @@
/**
* HTML tree for main tag.
*/
- private HtmlTree htmlTree = HtmlTree.MAIN();
+ private final HtmlTree htmlTree = HtmlTree.MAIN();
/**
* Construct the ModuleIndexWriter.
* @param configuration the configuration object
* @param filename the name of the generated file
- * @throws java.io.IOException
*/
- public ModuleIndexWriter(ConfigurationImpl configuration, DocPath filename) throws IOException {
+ public ModuleIndexWriter(ConfigurationImpl configuration, DocPath filename) {
super(configuration, filename);
modules = configuration.modules;
}
@@ -85,20 +81,12 @@
* Generate the module index page for the right-hand frame.
*
* @param configuration the current configuration of the doclet.
+ * @throws DocFileIOException if there is a problem generating the module index page
*/
- public static void generate(ConfigurationImpl configuration) {
- ModuleIndexWriter mdlgen;
+ public static void generate(ConfigurationImpl configuration) throws DocFileIOException {
DocPath filename = DocPaths.overviewSummary(configuration.frames);
- try {
- mdlgen = new ModuleIndexWriter(configuration, filename);
- mdlgen.buildModuleIndexFile("doclet.Window_Overview_Summary", true);
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error(
- "doclet.exception_encountered",
- exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
+ ModuleIndexWriter mdlgen = new ModuleIndexWriter(configuration, filename);
+ mdlgen.buildModuleIndexFile("doclet.Window_Overview_Summary", true);
}
/**
@@ -106,6 +94,7 @@
*
* @param body the documentation tree to which the index will be added
*/
+ @Override
protected void addIndex(Content body) {
if (modules != null && !modules.isEmpty()) {
addIndexContents(configuration.getText("doclet.Modules"),
@@ -190,6 +179,7 @@
*
* @param body the documentation tree to which the overview header will be added
*/
+ @Override
protected void addOverviewHeader(Content body) {
addConfigurationTitle(body);
if (!utils.getBody(configuration.overviewElement).isEmpty()) {
@@ -233,9 +223,9 @@
* "-overview" option on the command line.
*
* @param body the documentation tree to which the overview will be added
- * @throws java.io.IOException
*/
- protected void addOverview(Content body) throws IOException {
+ @Override
+ protected void addOverview(Content body) {
HtmlTree div = new HtmlTree(HtmlTag.DIV);
div.addStyle(HtmlStyle.contentContainer);
addOverviewComment(div);
@@ -254,6 +244,7 @@
*
* @param body the documentation tree to which the navigation bar header will be added
*/
+ @Override
protected void addNavigationBarHeader(Content body) {
Content htmlTree = (configuration.allowTag(HtmlTag.HEADER))
? HtmlTree.HEADER()
@@ -271,6 +262,7 @@
*
* @param body the documentation tree to which the navigation bar footer will be added
*/
+ @Override
protected void addNavigationBarFooter(Content body) {
Content htmltree = (configuration.allowTag(HtmlTag.FOOTER))
? HtmlTree.FOOTER()
@@ -282,10 +274,12 @@
}
}
+ @Override
protected void addModulePackagesList(Map<ModuleElement, Set<PackageElement>> modules, String text,
String tableSummary, Content body, ModuleElement mdle) {
}
+ @Override
protected void addModulesList(Map<ModuleElement, Set<PackageElement>> modules, String text,
String tableSummary, Content body) {
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModulePackageIndexFrameWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModulePackageIndexFrameWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
@@ -41,10 +40,9 @@
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
* Generate the module package index for the left-hand frame in the generated output.
@@ -66,29 +64,20 @@
* @param configuration the configuration object
* @param filename Name of the package index file to be generated.
*/
- public ModulePackageIndexFrameWriter(ConfigurationImpl configuration,
- DocPath filename) throws IOException {
+ public ModulePackageIndexFrameWriter(ConfigurationImpl configuration, DocPath filename) {
super(configuration, filename);
}
/**
* Generate the module package index file.
- * @throws DocletAbortException
+ * @throws DocFileIOException
* @param configuration the configuration object
* @param mdle the module being documented
*/
- public static void generate(ConfigurationImpl configuration, ModuleElement mdle) {
- ModulePackageIndexFrameWriter modpackgen;
+ public static void generate(ConfigurationImpl configuration, ModuleElement mdle) throws DocFileIOException {
DocPath filename = DocPaths.moduleFrame(mdle);
- try {
- modpackgen = new ModulePackageIndexFrameWriter(configuration, filename);
- modpackgen.buildModulePackagesIndexFile("doclet.Window_Overview", false, mdle);
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
+ ModulePackageIndexFrameWriter modpackgen = new ModulePackageIndexFrameWriter(configuration, filename);
+ modpackgen.buildModulePackagesIndexFile("doclet.Window_Overview", false, mdle);
}
/**
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleWriterImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleWriterImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.ArrayList;
import java.util.EnumMap;
import java.util.List;
@@ -46,8 +45,8 @@
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.ModuleSummaryWriter;
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
* Class to generate file for each module contents in the right-hand
@@ -515,12 +514,8 @@
* @param subDiv the content tree to which the summary detail links will be added
*/
protected void addSummaryDetailLinks(Content subDiv) {
- try {
- Content div = HtmlTree.DIV(getNavSummaryLinks());
- subDiv.addContent(div);
- } catch (Exception e) {
- throw new DocletAbortException(e);
- }
+ Content div = HtmlTree.DIV(getNavSummaryLinks());
+ subDiv.addContent(div);
}
/**
@@ -528,7 +523,7 @@
*
* @return the content tree for the navigation summary links
*/
- protected Content getNavSummaryLinks() throws Exception {
+ protected Content getNavSummaryLinks() {
Content li = HtmlTree.LI(contents.moduleSubNavLabel);
li.addContent(Contents.SPACE);
Content ulNav = HtmlTree.UL(HtmlStyle.subNavList, li);
@@ -591,7 +586,8 @@
/**
* {@inheritDoc}
*/
- public void printDocument(Content contentTree) throws IOException {
+ @Override
+ public void printDocument(Content contentTree) throws DocFileIOException {
printHtmlDocument(configuration.metakeywords.getMetaKeywordsForModule(mdle),
true, contentTree);
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageFrameWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageFrameWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.PackageElement;
@@ -38,10 +37,9 @@
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Configuration;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
@@ -62,7 +60,7 @@
/**
* The package being documented.
*/
- private PackageElement packageElement;
+ private final PackageElement packageElement;
/**
* The classes to be documented. Use this to filter out classes
@@ -96,35 +94,29 @@
*
* @param configuration the current configuration of the doclet.
* @param packageElement The package for which "pacakge-frame.html" is to be generated.
+ * @throws DocFileIOException if there is a problem generating the package summary page
*/
- public static void generate(ConfigurationImpl configuration, PackageElement packageElement) {
- PackageFrameWriter packgen;
- try {
- packgen = new PackageFrameWriter(configuration, packageElement);
- String pkgName = configuration.utils.getPackageName(packageElement);
- HtmlTree body = packgen.getBody(false, packgen.getWindowTitle(pkgName));
- Content pkgNameContent = new StringContent(pkgName);
- HtmlTree htmlTree = (configuration.allowTag(HtmlTag.MAIN))
- ? HtmlTree.MAIN()
- : body;
- Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, HtmlStyle.bar,
- packgen.getTargetPackageLink(packageElement, "classFrame", pkgNameContent));
- htmlTree.addContent(heading);
- HtmlTree div = new HtmlTree(HtmlTag.DIV);
- div.addStyle(HtmlStyle.indexContainer);
- packgen.addClassListing(div);
- htmlTree.addContent(div);
- if (configuration.allowTag(HtmlTag.MAIN)) {
- body.addContent(htmlTree);
- }
- packgen.printHtmlDocument(
- configuration.metakeywords.getMetaKeywords(packageElement), false, body);
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), DocPaths.PACKAGE_FRAME.getPath());
- throw new DocletAbortException(exc);
+ public static void generate(ConfigurationImpl configuration, PackageElement packageElement)
+ throws DocFileIOException {
+ PackageFrameWriter packgen = new PackageFrameWriter(configuration, packageElement);
+ String pkgName = configuration.utils.getPackageName(packageElement);
+ HtmlTree body = packgen.getBody(false, packgen.getWindowTitle(pkgName));
+ Content pkgNameContent = new StringContent(pkgName);
+ HtmlTree htmlTree = (configuration.allowTag(HtmlTag.MAIN))
+ ? HtmlTree.MAIN()
+ : body;
+ Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, HtmlStyle.bar,
+ packgen.getTargetPackageLink(packageElement, "classFrame", pkgNameContent));
+ htmlTree.addContent(heading);
+ HtmlTree div = new HtmlTree(HtmlTag.DIV);
+ div.addStyle(HtmlStyle.indexContainer);
+ packgen.addClassListing(div);
+ htmlTree.addContent(div);
+ if (configuration.allowTag(HtmlTag.MAIN)) {
+ body.addContent(htmlTree);
}
+ packgen.printHtmlDocument(
+ configuration.metakeywords.getMetaKeywords(packageElement), false, body);
}
/**
@@ -168,7 +160,7 @@
/**
* Add specific class kind listing. Also add label to the listing.
*
- * @param arr Array of specific class kinds, namely Class or Interface or Exception or Error
+ * @param list list of specific class kinds, namely Class or Interface or Exception or Error
* @param labelContent content tree of the label to be added
* @param contentTree the content tree to which the class kind listing will be added
*/
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageIndexFrameWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageIndexFrameWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.IOException;
import java.util.Collection;
import javax.lang.model.element.PackageElement;
@@ -37,10 +36,9 @@
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
@@ -62,32 +60,24 @@
*
* @param filename Name of the package index file to be generated.
*/
- public PackageIndexFrameWriter(ConfigurationImpl configuration,
- DocPath filename) throws IOException {
+ public PackageIndexFrameWriter(ConfigurationImpl configuration, DocPath filename) {
super(configuration, filename);
}
/**
* Generate the package index file named "overview-frame.html".
- * @throws DocletAbortException
+ * @throws DocFileIOException
*/
- public static void generate(ConfigurationImpl configuration) {
- PackageIndexFrameWriter packgen;
+ public static void generate(ConfigurationImpl configuration) throws DocFileIOException {
DocPath filename = DocPaths.OVERVIEW_FRAME;
- try {
- packgen = new PackageIndexFrameWriter(configuration, filename);
- packgen.buildPackageIndexFile("doclet.Window_Overview", false);
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
+ PackageIndexFrameWriter packgen = new PackageIndexFrameWriter(configuration, filename);
+ packgen.buildPackageIndexFile("doclet.Window_Overview", false);
}
/**
* {@inheritDoc}
*/
+ @Override
protected void addPackagesList(Collection<PackageElement> packages, String text,
String tableSummary, Content body) {
Content heading = HtmlTree.HEADING(HtmlConstants.PACKAGE_HEADING, true,
@@ -135,6 +125,7 @@
/**
* {@inheritDoc}
*/
+ @Override
protected void addNavigationBarHeader(Content body) {
Content headerContent;
if (configuration.packagesheader.length() > 0) {
@@ -150,6 +141,7 @@
/**
* Do nothing as there is no overview information in this page.
*/
+ @Override
protected void addOverviewHeader(Content body) {
}
@@ -159,6 +151,7 @@
*
* @param ul the Content object to which the "All Classes" link should be added
*/
+ @Override
protected void addAllClassesLink(Content ul) {
Content linkContent = getHyperLink(DocPaths.ALLCLASSES_FRAME,
contents.allClassesLabel, "", "packageFrame");
@@ -172,6 +165,7 @@
*
* @param ul the Content object to which the "All Modules" link should be added
*/
+ @Override
protected void addAllModulesLink(Content ul) {
Content linkContent = getHyperLink(DocPaths.MODULE_OVERVIEW_FRAME,
contents.allModulesLabel, "", "packageListFrame");
@@ -182,6 +176,7 @@
/**
* {@inheritDoc}
*/
+ @Override
protected void addNavigationBarFooter(Content body) {
Content p = HtmlTree.P(Contents.SPACE);
body.addContent(p);
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageIndexWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageIndexWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,22 +25,19 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.PackageElement;
-import jdk.javadoc.doclet.DocletEnvironment;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.Group;
/**
@@ -58,38 +55,35 @@
*/
public class PackageIndexWriter extends AbstractPackageIndexWriter {
- /**
- * Root of the program structure. Used for "overview" documentation.
- */
- private DocletEnvironment docEnv;
/**
* Map representing the group of packages as specified on the command line.
*
* @see Group
*/
- private Map<String, SortedSet<PackageElement>> groupPackageMap;
+ private final Map<String, SortedSet<PackageElement>> groupPackageMap;
/**
* List to store the order groups as specified on the command line.
*/
- private List<String> groupList;
+ private final List<String> groupList;
/**
* HTML tree for main tag.
*/
- private HtmlTree htmlTree = HtmlTree.MAIN();
+ private final HtmlTree htmlTree = HtmlTree.MAIN();
/**
* Construct the PackageIndexWriter. Also constructs the grouping
* information as provided on the command line by "-group" option. Stores
* the order of groups specified by the user.
*
+ * @param configuration the configuration for this doclet
+ * @param filename the path of the page to be generated
* @see Group
*/
- public PackageIndexWriter(ConfigurationImpl configuration, DocPath filename) throws IOException {
+ public PackageIndexWriter(ConfigurationImpl configuration, DocPath filename) {
super(configuration, filename);
- this.docEnv = configuration.docEnv;
groupPackageMap = configuration.group.groupPackages(packages);
groupList = configuration.group.getGroupList();
}
@@ -98,19 +92,12 @@
* Generate the package index page for the right-hand frame.
*
* @param configuration the current configuration of the doclet.
+ * @throws DocFileIOException if there is a problem generating the package index page
*/
- public static void generate(ConfigurationImpl configuration) {
- PackageIndexWriter packgen;
+ public static void generate(ConfigurationImpl configuration) throws DocFileIOException {
DocPath filename = DocPaths.overviewSummary(configuration.frames);
- try {
- packgen = new PackageIndexWriter(configuration, filename);
- packgen.buildPackageIndexFile("doclet.Window_Overview_Summary", true);
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
+ PackageIndexWriter packgen = new PackageIndexWriter(configuration, filename);
+ packgen.buildPackageIndexFile("doclet.Window_Overview_Summary", true);
}
/**
@@ -119,6 +106,7 @@
*
* @param body the documentation tree to which the index will be added
*/
+ @Override
protected void addIndex(Content body) {
for (String groupname : groupList) {
SortedSet<PackageElement> list = groupPackageMap.get(groupname);
@@ -133,6 +121,7 @@
/**
* {@inheritDoc}
*/
+ @Override
protected void addPackagesList(Collection<PackageElement> packages, String text,
String tableSummary, Content body) {
Content table = (configuration.isOutputHtml5())
@@ -183,6 +172,7 @@
*
* @param body the documentation tree to which the overview header will be added
*/
+ @Override
protected void addOverviewHeader(Content body) {
addConfigurationTitle(body);
if (!utils.getBody(configuration.overviewElement).isEmpty()) {
@@ -227,7 +217,8 @@
*
* @param body the documentation tree to which the overview will be added
*/
- protected void addOverview(Content body) throws IOException {
+ @Override
+ protected void addOverview(Content body) {
HtmlTree div = new HtmlTree(HtmlTag.DIV);
div.addStyle(HtmlStyle.contentContainer);
addOverviewComment(div);
@@ -246,6 +237,7 @@
*
* @param body the documentation tree to which the navigation bar header will be added
*/
+ @Override
protected void addNavigationBarHeader(Content body) {
Content htmlTree = (configuration.allowTag(HtmlTag.HEADER))
? HtmlTree.HEADER()
@@ -263,6 +255,7 @@
*
* @param body the documentation tree to which the navigation bar footer will be added
*/
+ @Override
protected void addNavigationBarFooter(Content body) {
Content htmlTree = (configuration.allowTag(HtmlTag.FOOTER))
? HtmlTree.FOOTER()
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageTreeWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageTreeWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,8 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
-
import javax.lang.model.element.PackageElement;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
@@ -34,11 +32,10 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
@@ -77,14 +74,11 @@
* @param packageElement the current package
* @param prev the previous package
* @param next the next package
- * @throws IOException
- * @throws DocletAbortException
*/
public PackageTreeWriter(ConfigurationImpl configuration,
DocPath path,
PackageElement packageElement,
- PackageElement prev, PackageElement next)
- throws IOException {
+ PackageElement prev, PackageElement next) {
super(configuration, path,
new ClassTree(configuration.typeElementCatalog.allClasses(packageElement), configuration));
this.packageElement = packageElement;
@@ -102,30 +96,22 @@
* @param next Next package in the alpha-ordered list.
* @param noDeprecated If true, do not generate any information for
* deprecated classe or interfaces.
- * @throws DocletAbortException
+ * @throws DocFileIOException if there is a problem generating the package tree page
*/
public static void generate(ConfigurationImpl configuration,
PackageElement pkg, PackageElement prev,
- PackageElement next, boolean noDeprecated) {
- PackageTreeWriter packgen;
+ PackageElement next, boolean noDeprecated)
+ throws DocFileIOException {
DocPath path = DocPath.forPackage(pkg).resolve(DocPaths.PACKAGE_TREE);
- try {
- packgen = new PackageTreeWriter(configuration, path, pkg,
- prev, next);
- packgen.generatePackageTreeFile();
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), path.getPath());
- throw new DocletAbortException(exc);
- }
+ PackageTreeWriter packgen = new PackageTreeWriter(configuration, path, pkg, prev, next);
+ packgen.generatePackageTreeFile();
}
/**
* Generate a separate tree file for each package.
- * @throws java.io.IOException
+ * @throws DocFileIOException if there is a problem generating the package tree file
*/
- protected void generatePackageTreeFile() throws IOException {
+ protected void generatePackageTreeFile() throws DocFileIOException {
HtmlTree body = getPackageTreeHeader();
HtmlTree htmlTree = (configuration.allowTag(HtmlTag.MAIN))
? HtmlTree.MAIN()
@@ -200,6 +186,7 @@
*
* @return a content tree for the link
*/
+ @Override
protected Content getNavLinkPrevious() {
if (prev == null) {
return getNavLinkPrevious(null);
@@ -214,6 +201,7 @@
*
* @return a content tree for the link
*/
+ @Override
protected Content getNavLinkNext() {
if (next == null) {
return getNavLinkNext(null);
@@ -241,6 +229,7 @@
*
* @return a content tree for the package link
*/
+ @Override
protected Content getNavLinkPackage() {
Content linkContent = getHyperLink(DocPaths.PACKAGE_SUMMARY,
contents.packageLabel);
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageUseWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageUseWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.PackageElement;
@@ -38,11 +37,10 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
import jdk.javadoc.internal.doclets.toolkit.util.ClassUseMapper;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
* Generate package usage information.
@@ -65,12 +63,10 @@
* Constructor.
*
* @param filename the file to be generated.
- * @throws IOException
- * @throws DocletAbortException
*/
public PackageUseWriter(ConfigurationImpl configuration,
ClassUseMapper mapper, DocPath filename,
- PackageElement pkgElement) throws IOException {
+ PackageElement pkgElement) {
super(configuration, DocPath.forPackage(pkgElement).resolve(filename));
this.packageElement = pkgElement;
@@ -101,25 +97,21 @@
* @param configuration the current configuration of the doclet.
* @param mapper the mapping of the class usage.
* @param pkgElement the package being documented.
+ * @throws DocFileIOException if there is a problem generating the package use page
*/
public static void generate(ConfigurationImpl configuration,
- ClassUseMapper mapper, PackageElement pkgElement) {
- PackageUseWriter pkgusegen;
+ ClassUseMapper mapper, PackageElement pkgElement)
+ throws DocFileIOException {
DocPath filename = DocPaths.PACKAGE_USE;
- try {
- pkgusegen = new PackageUseWriter(configuration, mapper, filename, pkgElement);
- pkgusegen.generatePackageUseFile();
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error(exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
+ PackageUseWriter pkgusegen = new PackageUseWriter(configuration, mapper, filename, pkgElement);
+ pkgusegen.generatePackageUseFile();
}
/**
* Generate the package use list.
+ * @throws DocFileIOException if there is a problem generating the package use page
*/
- protected void generatePackageUseFile() throws IOException {
+ protected void generatePackageUseFile() throws DocFileIOException {
HtmlTree body = getPackageUseHeader();
HtmlTree div = new HtmlTree(HtmlTag.DIV);
div.addStyle(HtmlStyle.contentContainer);
@@ -150,7 +142,7 @@
*
* @param contentTree the content tree to which the package use information will be added
*/
- protected void addPackageUse(Content contentTree) throws IOException {
+ protected void addPackageUse(Content contentTree) {
HtmlTree ul = new HtmlTree(HtmlTag.UL);
ul.addStyle(HtmlStyle.blockList);
if (configuration.packages.size() > 1) {
@@ -165,7 +157,7 @@
*
* @param contentTree the content tree to which the package list will be added
*/
- protected void addPackageList(Content contentTree) throws IOException {
+ protected void addPackageList(Content contentTree) {
Content caption = getTableCaption(configuration.getContent(
"doclet.ClassUse_Packages.that.use.0",
getPackageLink(packageElement, utils.getPackageName(packageElement))));
@@ -193,7 +185,7 @@
*
* @param contentTree the content tree to which the class list will be added
*/
- protected void addClassList(Content contentTree) throws IOException {
+ protected void addClassList(Content contentTree) {
List<String> classTableHeader = Arrays.asList(
configuration.getText("doclet.0_and_1",
configuration.getText("doclet.Class"),
@@ -254,7 +246,7 @@
* @param pkg the package that used the given package
* @param contentTree the content tree to which the information will be added
*/
- protected void addPackageUse(PackageElement pkg, Content contentTree) throws IOException {
+ protected void addPackageUse(PackageElement pkg, Content contentTree) {
Content tdFirst = HtmlTree.TD(HtmlStyle.colFirst,
getHyperLink(utils.getPackageName(pkg),
new StringContent(utils.getPackageName(pkg))));
@@ -320,6 +312,7 @@
*
* @return a content tree for the package link
*/
+ @Override
protected Content getNavLinkPackage() {
Content linkContent = getHyperLink(DocPaths.PACKAGE_SUMMARY,
contents.packageLabel);
@@ -332,6 +325,7 @@
*
* @return a content tree for the use link
*/
+ @Override
protected Content getNavLinkClassUse() {
Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, contents.useLabel);
return li;
@@ -342,6 +336,7 @@
*
* @return a content tree for the tree link
*/
+ @Override
protected Content getNavLinkTree() {
Content linkContent = getHyperLink(DocPaths.PACKAGE_TREE,
contents.treeLabel);
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageWriterImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageWriterImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.ModuleElement;
@@ -42,6 +41,7 @@
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.PackageSummaryWriter;
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
@@ -112,6 +112,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public Content getPackageHeader(String heading) {
HtmlTree bodyTree = getBody(true, getWindowTitle(utils.getPackageName(packageElement)));
HtmlTree htmlTree = (configuration.allowTag(HtmlTag.HEADER))
@@ -166,6 +167,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public Content getContentHeader() {
HtmlTree div = new HtmlTree(HtmlTag.DIV);
div.addStyle(HtmlStyle.contentContainer);
@@ -198,6 +200,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public Content getSummaryHeader() {
HtmlTree ul = new HtmlTree(HtmlTag.UL);
ul.addStyle(HtmlStyle.blockList);
@@ -207,6 +210,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public void addClassesSummary(SortedSet<TypeElement> classes, String label,
String tableSummary, List<String> tableHeader, Content summaryContentTree) {
if(!classes.isEmpty()) {
@@ -252,6 +256,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public void addPackageDescription(Content packageContentTree) {
if (!utils.getBody(packageElement).isEmpty()) {
packageContentTree.addContent(
@@ -273,6 +278,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public void addPackageTags(Content packageContentTree) {
Content htmlTree = (configuration.allowTag(HtmlTag.SECTION))
? sectionTree
@@ -283,6 +289,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public void addPackageContent(Content contentTree, Content packageContentTree) {
if (configuration.allowTag(HtmlTag.MAIN)) {
packageContentTree.addContent(sectionTree);
@@ -296,6 +303,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public void addPackageFooter(Content contentTree) {
Content htmlTree = (configuration.allowTag(HtmlTag.FOOTER))
? HtmlTree.FOOTER()
@@ -310,7 +318,8 @@
/**
* {@inheritDoc}
*/
- public void printDocument(Content contentTree) throws IOException {
+ @Override
+ public void printDocument(Content contentTree) throws DocFileIOException {
printHtmlDocument(configuration.metakeywords.getMetaKeywords(packageElement),
true, contentTree);
}
@@ -320,6 +329,7 @@
*
* @return a content tree for the class use link
*/
+ @Override
protected Content getNavLinkClassUse() {
Content useLink = getHyperLink(DocPaths.PACKAGE_USE,
contents.useLabel, "", "");
@@ -332,6 +342,7 @@
*
* @return a content tree for the previous link
*/
+ @Override
public Content getNavLinkPrevious() {
Content li;
if (prev == null) {
@@ -349,6 +360,7 @@
*
* @return a content tree for the next link
*/
+ @Override
public Content getNavLinkNext() {
Content li;
if (next == null) {
@@ -367,6 +379,7 @@
*
* @return a content tree for the tree link
*/
+ @Override
protected Content getNavLinkTree() {
Content useLink = getHyperLink(DocPaths.PACKAGE_TREE,
contents.treeLabel, "", "");
@@ -392,6 +405,7 @@
*
* @return a content tree for the package link
*/
+ @Override
protected Content getNavLinkPackage() {
Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, contents.packageLabel);
return li;
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SerializedFormWriterImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SerializedFormWriterImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.TypeElement;
@@ -39,8 +38,8 @@
import jdk.javadoc.internal.doclets.toolkit.SerializedFormWriter;
import jdk.javadoc.internal.doclets.toolkit.SerializedFormWriter.SerialFieldWriter;
import jdk.javadoc.internal.doclets.toolkit.SerializedFormWriter.SerialMethodWriter;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
* Generate the Serialized Form Information Page.
@@ -64,11 +63,8 @@
/**
* @param configuration the configuration data for the doclet
- * @throws IOException
- * @throws DocletAbortException
*/
- public SerializedFormWriterImpl(ConfigurationImpl configuration)
- throws IOException {
+ public SerializedFormWriterImpl(ConfigurationImpl configuration) {
super(configuration, DocPaths.SERIALIZED_FORM);
visibleClasses = configuration.docEnv.getIncludedTypeElements();
}
@@ -277,7 +273,8 @@
/**
* {@inheritDoc}
*/
- public void printDocument(Content serializedTree) throws IOException {
+ @Override
+ public void printDocument(Content serializedTree) throws DocFileIOException {
printHtmlDocument(null, true, serializedTree);
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SingleIndexWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SingleIndexWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.*;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
@@ -33,10 +32,9 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.IndexBuilder;
@@ -62,42 +60,37 @@
* Construct the SingleIndexWriter with filename "index-all.html" and the
* {@link IndexBuilder}
*
+ * @param configuration the configuration for this doclet
* @param filename Name of the index file to be generated.
* @param indexbuilder Unicode based Index from {@link IndexBuilder}
*/
public SingleIndexWriter(ConfigurationImpl configuration,
DocPath filename,
- IndexBuilder indexbuilder) throws IOException {
+ IndexBuilder indexbuilder) {
super(configuration, filename, indexbuilder);
}
/**
* Generate single index file, for all Unicode characters.
*
+ * @param configuration the configuration for this doclet
* @param indexbuilder IndexBuilder built by {@link IndexBuilder}
- * @throws DocletAbortException
+ * @throws DocFileIOException if there is a problem generating the index
*/
public static void generate(ConfigurationImpl configuration,
- IndexBuilder indexbuilder) {
- SingleIndexWriter indexgen;
+ IndexBuilder indexbuilder) throws DocFileIOException {
DocPath filename = DocPaths.INDEX_ALL;
- try {
- indexgen = new SingleIndexWriter(configuration,
- filename, indexbuilder);
- indexgen.generateIndexFile();
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
+ SingleIndexWriter indexgen = new SingleIndexWriter(configuration,
+ filename, indexbuilder);
+ indexgen.generateIndexFile();
}
/**
* Generate the contents of each index file, with Header, Footer,
* Member Field, Method and Constructor Description.
+ * @throws DocFileIOException if there is a problem generating the index
*/
- protected void generateIndexFile() throws IOException {
+ protected void generateIndexFile() throws DocFileIOException {
String title = configuration.getText("doclet.Window_Single_Index");
HtmlTree body = getBody(true, getWindowTitle(title));
HtmlTree htmlTree = (configuration.allowTag(HtmlTag.HEADER))
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SourceToHTMLConverter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SourceToHTMLConverter.java Tue Aug 30 08:45:21 2016 -0700
@@ -42,10 +42,11 @@
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.Messages;
import jdk.javadoc.internal.doclets.toolkit.util.DocFile;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
+import jdk.javadoc.internal.doclets.toolkit.util.SimpleDocletException;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
/**
@@ -79,7 +80,7 @@
private final DocletEnvironment docEnv;
- private DocPath outputdir;
+ private final DocPath outputdir;
/**
* Relative path from the documentation root to the file that is being
@@ -102,13 +103,15 @@
* @param configuration the configuration.
* @param docEnv the DocletEnvironment to convert.
* @param outputdir the name of the directory to output to.
+ * @throws DocFileIOException if there is a problem generating an output file
+ * @throws SimpleDocletException if there is a problem reading a source file
*/
public static void convertRoot(ConfigurationImpl configuration, DocletEnvironment docEnv,
- DocPath outputdir) {
+ DocPath outputdir) throws DocFileIOException, SimpleDocletException {
new SourceToHTMLConverter(configuration, docEnv, outputdir).generate();
}
- void generate() {
+ void generate() throws DocFileIOException, SimpleDocletException {
if (docEnv == null || outputdir == null) {
return;
}
@@ -129,12 +132,15 @@
}
/**
- * Convert the Classes in the given Package to an HTML.
+ * Convert the Classes in the given Package to an HTML file.
*
* @param pkg the Package to convert.
* @param outputdir the name of the directory to output to.
+ * @throws DocFileIOException if there is a problem generating an output file
+ * @throws SimpleDocletException if there is a problem reading a source file
*/
- public void convertPackage(PackageElement pkg, DocPath outputdir) {
+ public void convertPackage(PackageElement pkg, DocPath outputdir)
+ throws DocFileIOException, SimpleDocletException {
if (pkg == null) {
return;
}
@@ -152,16 +158,20 @@
* Convert the given Class to an HTML.
*
* @param te the class to convert.
- * @param outputdir the name of the directory to output to.
+ * @param outputdir the name of the directory to output to
+ * @throws DocFileIOException if there is a problem generating the output file
+ * @throws SimpleDocletException if there is a problem reading the source file
*/
- public void convertClass(TypeElement te, DocPath outputdir) {
+ public void convertClass(TypeElement te, DocPath outputdir)
+ throws DocFileIOException, SimpleDocletException {
if (te == null) {
return;
}
+ FileObject fo = utils.getFileObject(te);
+ if (fo == null)
+ return;
+
try {
- FileObject fo = utils.getFileObject(te);
- if (fo == null)
- return;
Reader r = fo.openReader(true);
int lineno = 1;
String line;
@@ -182,7 +192,8 @@
body.addContent((configuration.allowTag(HtmlTag.MAIN)) ? HtmlTree.MAIN(div) : div);
writeToFile(body, outputdir.resolve(DocPath.forClass(utils, te)));
} catch (IOException e) {
- throw new DocletAbortException(e);
+ String message = configuration.resources.getText("doclet.exception.read.file", fo.getName());
+ throw new SimpleDocletException(message, e);
}
}
@@ -192,7 +203,7 @@
* @param body the documentation content to be written to the file.
* @param path the path for the file.
*/
- private void writeToFile(Content body, DocPath path) throws IOException {
+ private void writeToFile(Content body, DocPath path) throws DocFileIOException {
Content htmlDocType = configuration.isOutputHtml5()
? DocType.HTML5
: DocType.TRANSITIONAL;
@@ -207,6 +218,8 @@
DocFile df = DocFile.createFileForOutput(configuration, path);
try (Writer w = df.openWriter()) {
htmlDocument.write(w, true);
+ } catch (IOException e) {
+ throw new DocFileIOException(df, DocFileIOException.Mode.WRITE, e);
}
}
@@ -287,9 +300,10 @@
}
/**
- * Given a <code>Doc</code>, return an anchor name for it.
+ * Given an element, return an anchor name for it.
*
- * @param d the <code>Doc</code> to check.
+ * @param utils the utility class, used to get the line number of the element
+ * @param e the element to check.
* @return the name of the anchor.
*/
public static String getAnchorName(Utils utils, Element e) {
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SplitIndexWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SplitIndexWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
@@ -38,10 +37,9 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.IndexBuilder;
@@ -71,20 +69,24 @@
*/
protected int next;
- private List<Character> indexElements;
+ private final List<Character> indexElements;
/**
* Construct the SplitIndexWriter. Uses path to this file and relative path
* from this file.
*
+ * @param configuration the configuration for this doclet
* @param path Path to the file which is getting generated.
* @param indexbuilder Unicode based Index from {@link IndexBuilder}
+ * @param elements the collection of characters for which to generate index files
+ * @param prev the previous character that was indexed
+ * @param next the next character to be indexed
*/
public SplitIndexWriter(ConfigurationImpl configuration,
DocPath path,
IndexBuilder indexbuilder,
Collection<Character> elements,
- int prev, int next) throws IOException {
+ int prev, int next) {
super(configuration, path, indexbuilder);
this.indexElements = new ArrayList<>(elements);
this.prev = prev;
@@ -95,34 +97,26 @@
* Generate separate index files, for each Unicode character, listing all
* the members starting with the particular unicode character.
*
+ * @param configuration the configuration for this doclet
* @param indexbuilder IndexBuilder built by {@link IndexBuilder}
- * @throws DocletAbortException
+ * @throws DocFileIOException if there is a problem generating the index files
*/
public static void generate(ConfigurationImpl configuration,
- IndexBuilder indexbuilder) {
- SplitIndexWriter indexgen;
- DocPath filename = DocPath.empty;
+ IndexBuilder indexbuilder) throws DocFileIOException {
DocPath path = DocPaths.INDEX_FILES;
- try {
- Set<Character> keys = new TreeSet<>(indexbuilder.getIndexMap().keySet());
- keys.addAll(configuration.tagSearchIndexKeys);
- ListIterator<Character> li = new ArrayList<>(keys).listIterator();
- while (li.hasNext()) {
- Object ch = li.next();
- filename = DocPaths.indexN(li.nextIndex());
- indexgen = new SplitIndexWriter(configuration,
- path.resolve(filename),
- indexbuilder, keys, li.previousIndex(), li.nextIndex());
- indexgen.generateIndexFile((Character) ch);
- if (!li.hasNext()) {
- indexgen.createSearchIndexFiles();
- }
+ Set<Character> keys = new TreeSet<>(indexbuilder.getIndexMap().keySet());
+ keys.addAll(configuration.tagSearchIndexKeys);
+ ListIterator<Character> li = new ArrayList<>(keys).listIterator();
+ while (li.hasNext()) {
+ Object ch = li.next();
+ DocPath filename = DocPaths.indexN(li.nextIndex());
+ SplitIndexWriter indexgen = new SplitIndexWriter(configuration,
+ path.resolve(filename),
+ indexbuilder, keys, li.previousIndex(), li.nextIndex());
+ indexgen.generateIndexFile((Character) ch);
+ if (!li.hasNext()) {
+ indexgen.createSearchIndexFiles();
}
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), filename.getPath());
- throw new DocletAbortException(exc);
}
}
@@ -132,8 +126,9 @@
*
* @param unicode Unicode character referring to the character for the
* index.
+ * @throws DocFileIOException if there is a problem generating an index file
*/
- protected void generateIndexFile(Character unicode) throws IOException {
+ protected void generateIndexFile(Character unicode) throws DocFileIOException {
String title = configuration.getText("doclet.Window_Split_Index",
unicode.toString());
HtmlTree body = getBody(true, getWindowTitle(title));
@@ -188,6 +183,7 @@
*
* @return a content tree for the link
*/
+ @Override
public Content getNavLinkPrevious() {
Content prevletterLabel = contents.prevLetter;
if (prev == -1) {
@@ -205,6 +201,7 @@
*
* @return a content tree for the link
*/
+ @Override
public Content getNavLinkNext() {
Content nextletterLabel = contents.nextLetter;
if (next == -1) {
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -37,7 +37,6 @@
import com.sun.source.doctree.DocTree;
import com.sun.source.doctree.IndexTree;
-import com.sun.tools.javac.util.DefinedBy;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
@@ -113,14 +112,14 @@
si.setLabel(tagText);
si.setDescription(desc);
new SimpleElementVisitor9<Void, Void>() {
- @Override @DefinedBy(DefinedBy.Api.LANGUAGE_MODEL)
+ @Override
public Void visitModule(ModuleElement e, Void p) {
si.setUrl(DocPaths.moduleSummary(e).getPath() + "#" + anchorName);
si.setHolder(utils.getSimpleName(element));
return null;
}
- @Override @DefinedBy(DefinedBy.Api.LANGUAGE_MODEL)
+ @Override
public Void visitPackage(PackageElement e, Void p) {
si.setUrl(DocPath.forPackage(e).getPath()
+ "/" + DocPaths.PACKAGE_SUMMARY.getPath() + "#" + anchorName);
@@ -128,14 +127,14 @@
return null;
}
- @Override @DefinedBy(DefinedBy.Api.LANGUAGE_MODEL)
+ @Override
public Void visitType(TypeElement e, Void p) {
si.setUrl(DocPath.forClass(utils, e).getPath() + "#" + anchorName);
si.setHolder(utils.getFullyQualifiedName(e));
return null;
}
- @Override @DefinedBy(DefinedBy.Api.LANGUAGE_MODEL)
+ @Override
public Void visitVariable(VariableElement e, Void p) {
TypeElement te = utils.getEnclosingTypeElement(e);
si.setUrl(DocPath.forClass(utils, te).getPath() + "#" + anchorName);
@@ -143,7 +142,7 @@
return null;
}
- @Override @DefinedBy(DefinedBy.Api.LANGUAGE_MODEL)
+ @Override
protected Void defaultAction(Element e, Void p) {
TypeElement te = utils.getEnclosingTypeElement(e);
si.setUrl(DocPath.forClass(utils, te).getPath() + "#" + anchorName);
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TreeWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TreeWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.IOException;
import java.util.SortedSet;
import javax.lang.model.element.PackageElement;
@@ -36,11 +35,10 @@
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
* Generate Class Hierarchy page for all the Classes in this run. Use
@@ -67,7 +65,7 @@
* True if there are no packages specified on the command line,
* False otherwise.
*/
- private boolean classesonly;
+ private final boolean classesOnly;
/**
* Constructor to construct TreeWriter object.
@@ -76,39 +74,33 @@
* @param filename String filename
* @param classtree the tree being built.
*/
- public TreeWriter(ConfigurationImpl configuration,
- DocPath filename, ClassTree classtree) throws IOException {
+ public TreeWriter(ConfigurationImpl configuration, DocPath filename, ClassTree classtree) {
super(configuration, filename, classtree);
packages = configuration.packages;
- classesonly = packages.isEmpty();
+ classesOnly = packages.isEmpty();
}
/**
* Create a TreeWriter object and use it to generate the
* "overview-tree.html" file.
*
+ * @param configuration the configuration for this doclet
* @param classtree the class tree being documented.
- * @throws DocletAbortException
+ * @throws DocFileIOException if there is a problem generating the overview tree page
*/
public static void generate(ConfigurationImpl configuration,
- ClassTree classtree) {
- TreeWriter treegen;
+ ClassTree classtree) throws DocFileIOException {
DocPath filename = DocPaths.OVERVIEW_TREE;
- try {
- treegen = new TreeWriter(configuration, filename, classtree);
- treegen.generateTreeFile();
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), filename);
- throw new DocletAbortException(exc);
- }
+ TreeWriter treegen = new TreeWriter(configuration, filename, classtree);
+ treegen.generateTreeFile();
}
/**
* Generate the interface hierarchy and class hierarchy.
+ *
+ * @throws DocFileIOException if there is a problem generating the overview tree page
*/
- public void generateTreeFile() throws IOException {
+ public void generateTreeFile() throws DocFileIOException {
HtmlTree body = getTreeHeader();
Content headContent = contents.hierarchyForAllPackages;
Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, false,
@@ -152,7 +144,7 @@
if (isUnnamedPackage()) {
return;
}
- if (!classesonly) {
+ if (!classesOnly) {
Content span = HtmlTree.SPAN(HtmlStyle.packageHierarchyLabel,
contents.packageHierarchies);
contentTree.addContent(span);
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/WriterFactoryImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/WriterFactoryImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html;
-import java.io.IOException;
import javax.lang.model.element.ModuleElement;
import javax.lang.model.element.PackageElement;
@@ -69,7 +68,7 @@
* {@inheritDoc}
*/
@Override
- public ConstantsSummaryWriter getConstantsSummaryWriter() throws Exception {
+ public ConstantsSummaryWriter getConstantsSummaryWriter() {
return new ConstantsSummaryWriterImpl(configuration);
}
@@ -78,7 +77,7 @@
*/
@Override
public PackageSummaryWriter getPackageSummaryWriter(PackageElement packageElement,
- PackageElement prevPkg, PackageElement nextPkg) throws Exception {
+ PackageElement prevPkg, PackageElement nextPkg) {
return new PackageWriterImpl(configuration, packageElement, prevPkg, nextPkg);
}
@@ -86,7 +85,7 @@
* {@inheritDoc}
*/
public ModuleSummaryWriter getModuleSummaryWriter(ModuleElement mdle,
- ModuleElement prevModule, ModuleElement nextModule) throws Exception {
+ ModuleElement prevModule, ModuleElement nextModule) {
return new ModuleWriterImpl(configuration, mdle,
prevModule, nextModule);
}
@@ -96,7 +95,7 @@
*/
@Override
public ClassWriter getClassWriter(TypeElement typeElement, TypeElement prevClass,
- TypeElement nextClass, ClassTree classTree) throws IOException {
+ TypeElement nextClass, ClassTree classTree) {
return new ClassWriterImpl(configuration, typeElement, prevClass, nextClass, classTree);
}
@@ -105,7 +104,7 @@
*/
@Override
public AnnotationTypeWriter getAnnotationTypeWriter(TypeElement annotationType,
- TypeMirror prevType, TypeMirror nextType) throws Exception {
+ TypeMirror prevType, TypeMirror nextType) {
return new AnnotationTypeWriterImpl(configuration, annotationType, prevType, nextType);
}
@@ -113,8 +112,8 @@
* {@inheritDoc}
*/
@Override
- public AnnotationTypeFieldWriter
- getAnnotationTypeFieldWriter(AnnotationTypeWriter annotationTypeWriter) throws Exception {
+ public AnnotationTypeFieldWriter getAnnotationTypeFieldWriter(
+ AnnotationTypeWriter annotationTypeWriter) {
TypeElement te = annotationTypeWriter.getAnnotationTypeElement();
return new AnnotationTypeFieldWriterImpl(
(SubWriterHolderWriter) annotationTypeWriter, te);
@@ -124,9 +123,8 @@
* {@inheritDoc}
*/
@Override
- public AnnotationTypeOptionalMemberWriter
- getAnnotationTypeOptionalMemberWriter(
- AnnotationTypeWriter annotationTypeWriter) throws Exception {
+ public AnnotationTypeOptionalMemberWriter getAnnotationTypeOptionalMemberWriter(
+ AnnotationTypeWriter annotationTypeWriter) {
TypeElement te = annotationTypeWriter.getAnnotationTypeElement();
return new AnnotationTypeOptionalMemberWriterImpl(
(SubWriterHolderWriter) annotationTypeWriter, te);
@@ -136,8 +134,8 @@
* {@inheritDoc}
*/
@Override
- public AnnotationTypeRequiredMemberWriter
- getAnnotationTypeRequiredMemberWriter(AnnotationTypeWriter annotationTypeWriter) throws Exception {
+ public AnnotationTypeRequiredMemberWriter getAnnotationTypeRequiredMemberWriter(
+ AnnotationTypeWriter annotationTypeWriter) {
TypeElement te = annotationTypeWriter.getAnnotationTypeElement();
return new AnnotationTypeRequiredMemberWriterImpl(
(SubWriterHolderWriter) annotationTypeWriter, te);
@@ -147,8 +145,7 @@
* {@inheritDoc}
*/
@Override
- public EnumConstantWriterImpl getEnumConstantWriter(ClassWriter classWriter)
- throws Exception {
+ public EnumConstantWriterImpl getEnumConstantWriter(ClassWriter classWriter) {
return new EnumConstantWriterImpl((SubWriterHolderWriter) classWriter,
classWriter.getTypeElement());
}
@@ -157,8 +154,7 @@
* {@inheritDoc}
*/
@Override
- public FieldWriterImpl getFieldWriter(ClassWriter classWriter)
- throws Exception {
+ public FieldWriterImpl getFieldWriter(ClassWriter classWriter) {
return new FieldWriterImpl((SubWriterHolderWriter) classWriter, classWriter.getTypeElement());
}
@@ -166,8 +162,7 @@
* {@inheritDoc}
*/
@Override
- public PropertyWriterImpl getPropertyWriter(ClassWriter classWriter)
- throws Exception {
+ public PropertyWriterImpl getPropertyWriter(ClassWriter classWriter) {
return new PropertyWriterImpl((SubWriterHolderWriter) classWriter,
classWriter.getTypeElement());
}
@@ -176,8 +171,7 @@
* {@inheritDoc}
*/
@Override
- public MethodWriterImpl getMethodWriter(ClassWriter classWriter)
- throws Exception {
+ public MethodWriterImpl getMethodWriter(ClassWriter classWriter) {
return new MethodWriterImpl((SubWriterHolderWriter) classWriter, classWriter.getTypeElement());
}
@@ -185,8 +179,7 @@
* {@inheritDoc}
*/
@Override
- public ConstructorWriterImpl getConstructorWriter(ClassWriter classWriter)
- throws Exception {
+ public ConstructorWriterImpl getConstructorWriter(ClassWriter classWriter) {
return new ConstructorWriterImpl((SubWriterHolderWriter) classWriter,
classWriter.getTypeElement());
}
@@ -195,9 +188,8 @@
* {@inheritDoc}
*/
@Override
- public MemberSummaryWriter getMemberSummaryWriter(
- ClassWriter classWriter, VisibleMemberMap.Kind memberType)
- throws Exception {
+ public MemberSummaryWriter getMemberSummaryWriter(ClassWriter classWriter,
+ VisibleMemberMap.Kind memberType) {
switch (memberType) {
case CONSTRUCTORS:
return getConstructorWriter(classWriter);
@@ -221,9 +213,8 @@
* {@inheritDoc}
*/
@Override
- public MemberSummaryWriter getMemberSummaryWriter(
- AnnotationTypeWriter annotationTypeWriter, VisibleMemberMap.Kind memberType)
- throws Exception {
+ public MemberSummaryWriter getMemberSummaryWriter(AnnotationTypeWriter annotationTypeWriter,
+ VisibleMemberMap.Kind memberType) {
switch (memberType) {
case ANNOTATION_TYPE_FIELDS:
return (AnnotationTypeFieldWriterImpl)
@@ -243,7 +234,7 @@
* {@inheritDoc}
*/
@Override
- public SerializedFormWriter getSerializedFormWriter() throws Exception {
+ public SerializedFormWriter getSerializedFormWriter() {
return new SerializedFormWriterImpl(configuration);
}
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Comment.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Comment.java Tue Aug 30 08:45:21 2016 -0700
@@ -29,7 +29,6 @@
import java.io.Writer;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
/**
@@ -59,25 +58,21 @@
* This method is not supported by the class.
*
* @param content content that needs to be added
- * @throws DocletAbortException this method will always throw a
- * DocletAbortException because it
- * is not supported.
+ * @throws UnsupportedOperationException always
*/
public void addContent(Content content) {
- throw new DocletAbortException("not supported");
+ throw new UnsupportedOperationException();
}
/**
* This method is not supported by the class.
*
* @param stringContent string content that needs to be added
- * @throws DocletAbortException this method will always throw a
- * DocletAbortException because it
- * is not supported.
+ * @throws UnsupportedOperationException always
*/
@Override
public void addContent(CharSequence stringContent) {
- throw new DocletAbortException("not supported");
+ throw new UnsupportedOperationException();
}
/**
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/DocType.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/DocType.java Tue Aug 30 08:45:21 2016 -0700
@@ -29,7 +29,6 @@
import java.io.Writer;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
/**
@@ -73,25 +72,21 @@
* This method is not supported by the class.
*
* @param content content that needs to be added
- * @throws DocletAbortException this method will always throw a
- * DocletAbortException because it
- * is not supported.
+ * @throws UnsupportedOperationException always
*/
public void addContent(Content content) {
- throw new DocletAbortException("not supported");
+ throw new UnsupportedOperationException();
}
/**
* This method is not supported by the class.
*
* @param stringContent string content that needs to be added
- * @throws DocletAbortException this method will always throw a
- * DocletAbortException because it
- * is not supported.
+ * @throws UnsupportedOperationException always
*/
@Override
public void addContent(CharSequence stringContent) {
- throw new DocletAbortException("not supported");
+ throw new UnsupportedOperationException();
}
/**
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/FixedStringContent.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/FixedStringContent.java Tue Aug 30 08:45:21 2016 -0700
@@ -28,7 +28,6 @@
import java.io.Writer;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
/**
@@ -57,13 +56,11 @@
* This method is not supported by the class.
*
* @param content content that needs to be added
- * @throws DocletAbortException this method will always throw a
- * DocletAbortException because it
- * is not supported.
+ * @throws UnsupportedOperationException always
*/
@Override
public void addContent(Content content) {
- throw new DocletAbortException("not supported");
+ throw new UnsupportedOperationException();
}
/**
@@ -71,13 +68,11 @@
* HTML characters for the string content that is added.
*
* @param strContent string content to be added
- * @throws DocletAbortException this method will always throw a
- * DocletAbortException because it
- * is not supported.
+ * @throws UnsupportedOperationException always
*/
@Override
public void addContent(CharSequence strContent) {
- throw new DocletAbortException("not supported");
+ throw new UnsupportedOperationException();
}
/**
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlDocWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlDocWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.formats.html.markup;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.ModuleElement;
@@ -38,6 +37,7 @@
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.Messages;
import jdk.javadoc.internal.doclets.toolkit.util.DocFile;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocLink;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
@@ -66,6 +66,7 @@
* Constructor. Initializes the destination file name through the super
* class HtmlWriter.
*
+ * @param configuration the configuration for this doclet
* @param filename String file name.
*/
public HtmlDocWriter(Configuration configuration, DocPath filename) {
@@ -78,6 +79,7 @@
/**
* Accessor for configuration.
+ * @return the configuration for this doclet
*/
public abstract Configuration configuration();
@@ -289,13 +291,9 @@
DocLink mtFrameLink = new DocLink(DocPaths.moduleTypeFrame(mdle));
DocLink cFrameLink = new DocLink(DocPaths.moduleSummary(mdle));
HtmlTree anchor = HtmlTree.A(mdlLink.toString(), label);
- StringBuilder onclickStr = new StringBuilder("updateModuleFrame('")
- .append(mtFrameLink.toString())
- .append("','")
- .append(cFrameLink.toString())
- .append("');");
+ String onclickStr = "updateModuleFrame('" + mtFrameLink + "','" + cFrameLink + "');";
anchor.addAttr(HtmlAttr.TARGET, target);
- anchor.addAttr(HtmlAttr.ONCLICK, onclickStr.toString());
+ anchor.addAttr(HtmlAttr.ONCLICK, onclickStr);
return anchor;
}
@@ -318,9 +316,10 @@
* @param title Title of this HTML document
* @param configuration the configuration object
* @param body the body content tree to be added to the HTML document
+ * @throws DocFileIOException if there is an error writing the frames document
*/
public void printFramesDocument(String title, ConfigurationImpl configuration,
- HtmlTree body) throws IOException {
+ HtmlTree body) throws DocFileIOException {
Content htmlDocType = configuration.isOutputHtml5()
? DocType.HTML5
: DocType.TRANSITIONAL;
@@ -345,6 +344,7 @@
/**
* Returns a link to the stylesheet file.
*
+ * @param configuration the configuration for this doclet
* @return an HtmlTree for the lINK tag which provides the stylesheet location
*/
public HtmlTree getStyleSheetProperties(ConfigurationImpl configuration) {
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlDocument.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlDocument.java Tue Aug 30 08:45:21 2016 -0700
@@ -30,7 +30,6 @@
import java.util.*;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
/**
* Class for generating an HTML document for javadoc output.
@@ -86,13 +85,11 @@
* This method is not supported by the class.
*
* @param stringContent string content that needs to be added
- * @throws DocletAbortException this method will always throw a
- * DocletAbortException because it
- * is not supported.
+ * @throws UnsupportedOperationException always
*/
@Override
public void addContent(CharSequence stringContent) {
- throw new DocletAbortException("not supported");
+ throw new UnsupportedOperationException();
}
/**
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -32,6 +32,7 @@
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.Resources;
import jdk.javadoc.internal.doclets.toolkit.util.DocFile;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
import jdk.javadoc.internal.doclets.toolkit.util.MethodTypes;
@@ -147,9 +148,11 @@
resources.getText("doclet.Type"));
}
- public void write(Content c) throws IOException {
+ public void write(Content c) throws DocFileIOException {
try (Writer writer = docFile.openWriter()) {
c.write(writer, true);
+ } catch (IOException e) {
+ throw new DocFileIOException(docFile, DocFileIOException.Mode.WRITE, e);
}
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/RawHtml.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/RawHtml.java Tue Aug 30 08:45:21 2016 -0700
@@ -29,7 +29,6 @@
import java.io.Writer;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
/**
@@ -61,25 +60,21 @@
* This method is not supported by the class.
*
* @param content content that needs to be added
- * @throws DocletAbortException this method will always throw a
- * DocletAbortException because it
- * is not supported.
+ * @throws UnsupportedOperationException always
*/
public void addContent(Content content) {
- throw new DocletAbortException("not supported");
+ throw new UnsupportedOperationException();
}
/**
* This method is not supported by the class.
*
* @param stringContent string content that needs to be added
- * @throws DocletAbortException this method will always throw a
- * DocletAbortException because it
- * is not supported.
+ * @throws UnsupportedOperationException always
*/
@Override
public void addContent(CharSequence stringContent) {
- throw new DocletAbortException("not supported");
+ throw new UnsupportedOperationException();
}
/**
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/StringContent.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/StringContent.java Tue Aug 30 08:45:21 2016 -0700
@@ -29,7 +29,6 @@
import java.io.Writer;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
/**
@@ -44,7 +43,7 @@
*/
public class StringContent extends Content {
- private StringBuilder stringContent;
+ private final StringBuilder stringContent;
/**
* Constructor to construct StringContent object.
@@ -67,13 +66,11 @@
* This method is not supported by the class.
*
* @param content content that needs to be added
- * @throws DocletAbortException this method will always throw a
- * DocletAbortException because it
- * is not supported.
+ * @throws UnsupportedOperationException always
*/
@Override
public void addContent(Content content) {
- throw new DocletAbortException("not supported");
+ throw new UnsupportedOperationException();
}
/**
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties Tue Aug 30 08:45:21 2016 -0700
@@ -189,7 +189,6 @@
doclet.Error_in_packagelist=Error in using -group option: {0} {1}
doclet.Groupname_already_used=In -group option, groupname already used: {0}
doclet.Same_package_name_used=Package name format used twice: {0}
-doclet.exception_encountered=Exception encountered while processing {1}\n{0}
# option specifiers
doclet.usage.d.parameters=<directory>
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/AbstractDoclet.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/AbstractDoclet.java Tue Aug 30 08:45:21 2016 -0700
@@ -34,12 +34,17 @@
import jdk.javadoc.doclet.Doclet;
import jdk.javadoc.doclet.DocletEnvironment;
+import jdk.javadoc.doclets.StandardDoclet;
+import jdk.javadoc.internal.doclets.formats.html.HtmlDoclet;
import jdk.javadoc.internal.doclets.toolkit.builders.AbstractBuilder;
import jdk.javadoc.internal.doclets.toolkit.builders.BuilderFactory;
import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
+import jdk.javadoc.internal.doclets.toolkit.util.InternalException;
import jdk.javadoc.internal.doclets.toolkit.util.PackageListWriter;
+import jdk.javadoc.internal.doclets.toolkit.util.ResourceIOException;
+import jdk.javadoc.internal.doclets.toolkit.util.SimpleDocletException;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
import static javax.tools.Diagnostic.Kind.*;
@@ -107,30 +112,61 @@
return false;
}
+ boolean dumpOnError = false; // set true to always show stack traces
+
try {
startGeneration(docEnv);
- } catch (Configuration.Fault f) {
- configuration.reporter.print(ERROR, f.getMessage());
- return false;
- } catch (DocletAbortException e) {
- Throwable cause = e.getCause();
- if (cause != null) {
- if (cause.getLocalizedMessage() != null) {
- configuration.reporter.print(ERROR, cause.getLocalizedMessage());
- } else {
- configuration.reporter.print(ERROR, cause.toString());
- }
+ return true;
+
+ } catch (DocFileIOException e) {
+ switch (e.mode) {
+ case READ:
+ messages.error("doclet.exception.read.file",
+ e.fileName.getPath(), e.getCause());
+ break;
+ case WRITE:
+ messages.error("doclet.exception.write.file",
+ e.fileName.getPath(), e.getCause());
}
- return false;
- } catch (Exception exc) {
- exc.printStackTrace(System.err);
- return false;
+ dumpStack(dumpOnError, e);
+
+ } catch (ResourceIOException e) {
+ messages.error("doclet.exception.read.resource",
+ e.resource.getPath(), e.getCause());
+ dumpStack(dumpOnError, e);
+
+ } catch (SimpleDocletException e) {
+ configuration.reporter.print(ERROR, e.getMessage());
+ dumpStack(dumpOnError, e);
+
+ } catch (InternalException e) {
+ configuration.reporter.print(ERROR, e.getMessage());
+ reportInternalError(e.getCause());
+
+ } catch (DocletException | RuntimeException | Error e) {
+ messages.error("doclet.internal.exception", e);
+ reportInternalError(e);
}
- return true;
+
+ return false;
+ }
+
+ private void reportInternalError(Throwable t) {
+ if (getClass().equals(StandardDoclet.class) || getClass().equals(HtmlDoclet.class)) {
+ System.err.println(configuration.getResources().getText("doclet.internal.report.bug"));
+ }
+ dumpStack(true, t);
+ }
+
+ private void dumpStack(boolean enabled, Throwable t) {
+ if (enabled && t != null) {
+ t.printStackTrace(System.err);
+ }
}
/**
* Returns the SourceVersion indicating the features supported by this doclet.
+ *
* @return SourceVersion
*/
@Override
@@ -141,6 +177,7 @@
/**
* Create the configuration instance and returns it.
+ *
* @return the configuration of the doclet.
*/
public abstract Configuration configuration();
@@ -152,8 +189,9 @@
* first and then can be used in the later generation.
*
* @see jdk.doclet.DocletEnvironment
+ * @throws DocletException if there is a problem while generating the documentation
*/
- private void startGeneration(DocletEnvironment docEnv) throws Configuration.Fault, Exception {
+ private void startGeneration(DocletEnvironment docEnv) throws DocletException {
if (docEnv.getIncludedTypeElements().isEmpty()) {
messages.error("doclet.No_Public_Classes_To_Document");
return;
@@ -166,7 +204,6 @@
ClassTree classtree = new ClassTree(configuration, configuration.nodeprecated);
generateClassFiles(docEnv, classtree);
- configuration.utils.copyDocFiles(DocPaths.DOC_FILES);
PackageListWriter.generate(configuration);
generatePackageFiles(classtree);
@@ -179,10 +216,12 @@
/**
* Generate additional documentation that is added to the API documentation.
*
- * @param docEnv the DocletEnvironment.
- * @param classtree the data structure representing the class tree.
+ * @param docEnv the DocletEnvironment
+ * @param classtree the data structure representing the class tree
+ * @throws DocletException if there is a problem while generating the documentation
*/
- protected void generateOtherFiles(DocletEnvironment docEnv, ClassTree classtree) throws Exception {
+ protected void generateOtherFiles(DocletEnvironment docEnv, ClassTree classtree)
+ throws DocletException {
BuilderFactory builderFactory = configuration.getBuilderFactory();
AbstractBuilder constantsSummaryBuilder = builderFactory.getConstantsSummaryBuilder();
constantsSummaryBuilder.build();
@@ -193,50 +232,59 @@
/**
* Generate the module documentation.
*
+ * @throws DocletException if there is a problem while generating the documentation
+ *
*/
- protected abstract void generateModuleFiles() throws Exception;
+ protected abstract void generateModuleFiles() throws DocletException;
/**
* Generate the package documentation.
*
- * @param classtree the data structure representing the class tree.
+ * @param classtree the data structure representing the class tree
+ * @throws DocletException if there is a problem while generating the documentation
*/
- protected abstract void generatePackageFiles(ClassTree classtree) throws Exception;
+ protected abstract void generatePackageFiles(ClassTree classtree) throws DocletException;
/**
* Generate the class documentation.
*
- * @param classtree the data structure representing the class tree.
+ * @param arr the set of types to be documented
+ * @param classtree the data structure representing the class tree
+ * @throws DocletException if there is a problem while generating the documentation
*/
- protected abstract void generateClassFiles(SortedSet<TypeElement> arr, ClassTree classtree);
+ protected abstract void generateClassFiles(SortedSet<TypeElement> arr, ClassTree classtree)
+ throws DocletException;
/**
* Iterate through all classes and construct documentation for them.
*
- * @param docEnv the DocletEnvironment.
- * @param classtree the data structure representing the class tree.
+ * @param docEnv the DocletEnvironment
+ * @param classtree the data structure representing the class tree
+ * @throws DocletException if there is a problem while generating the documentation
*/
- protected void generateClassFiles(DocletEnvironment docEnv, ClassTree classtree) {
+ protected void generateClassFiles(DocletEnvironment docEnv, ClassTree classtree)
+ throws DocletException {
generateClassFiles(classtree);
SortedSet<PackageElement> packages = new TreeSet<>(utils.makePackageComparator());
packages.addAll(configuration.getSpecifiedPackages());
configuration.modulePackages.values().stream().forEach(pset -> {
packages.addAll(pset);
});
- packages.stream().forEach((pkg) -> {
+ for (PackageElement pkg : packages) {
generateClassFiles(utils.getAllClasses(pkg), classtree);
- });
+ }
}
/**
* Generate the class files for single classes specified on the command line.
*
- * @param classtree the data structure representing the class tree.
+ * @param classtree the data structure representing the class tree
+ * @throws DocletException if there is a problem while generating the documentation
*/
- private void generateClassFiles(ClassTree classtree) {
+ private void generateClassFiles(ClassTree classtree) throws DocletException {
SortedSet<PackageElement> packages = configuration.typeElementCatalog.packages();
- packages.stream().forEach((pkg) -> {
+ for (PackageElement pkg : packages) {
generateClassFiles(configuration.typeElementCatalog.allClasses(pkg), classtree);
- });
+ }
}
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/AnnotationTypeWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/AnnotationTypeWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,9 +25,9 @@
package jdk.javadoc.internal.doclets.toolkit;
-import java.io.*;
+import javax.lang.model.element.TypeElement;
-import javax.lang.model.element.TypeElement;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
/**
* The interface for writing annotation type output.
@@ -152,8 +152,9 @@
* Print the document.
*
* @param contentTree content tree that will be printed as a document
+ * @throws DocFileIOException if there is a problem while writing the document
*/
- public void printDocument(Content contentTree) throws IOException;
+ public void printDocument(Content contentTree) throws DocFileIOException;
/**
* Return the {@link TypeElement} being documented.
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ClassWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ClassWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,9 +25,9 @@
package jdk.javadoc.internal.doclets.toolkit;
-import java.io.*;
+import javax.lang.model.element.TypeElement;
-import javax.lang.model.element.TypeElement;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
/**
* The interface for writing class output.
@@ -193,8 +193,9 @@
* Print the document.
*
* @param contentTree content tree that will be printed as a document
+ * @throws DocFileIOException if there is a problem while writing the document
*/
- public void printDocument(Content contentTree) throws IOException;
+ public void printDocument(Content contentTree) throws DocFileIOException;
/**
* Return the TypeElement being documented.
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/Configuration.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/Configuration.java Tue Aug 30 08:45:21 2016 -0700
@@ -44,11 +44,12 @@
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;
@@ -73,21 +74,6 @@
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;
@@ -105,7 +91,7 @@
/**
* 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
@@ -302,13 +288,17 @@
/**
* 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();
@@ -638,8 +628,8 @@
* 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 {
- ensureOutputDirExists();
+ private void finishOptionSettings0() throws DocletException {
+ initDestDirectory();
if (urlForLink != null && pkglistUrlForLink != null)
extern.link(urlForLink, pkglistUrlForLink, reporter, false);
if (urlForLinkOffline != null && pkglistUrlForLinkOffline != null)
@@ -658,43 +648,42 @@
* 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 {
- try {
- initPackages();
- initModules();
- finishOptionSettings0();
- if (!finishOptionSettings())
- return false;
+ public boolean setOptions() throws DocletException {
+ initPackages();
+ initModules();
+ finishOptionSettings0();
+ if (!finishOptionSettings())
+ return false;
- } catch (Fault f) {
- throw new DocletAbortException(f.getMessage());
- }
return true;
}
- private void ensureOutputDirExists() throws Fault {
- DocFile destDir = DocFile.createFileForDirectory(this, destDirName);
- if (!destDir.exists()) {
- //Create the output directory (in case it doesn't exist yet)
- if (!destDirName.isEmpty())
+ private void initDestDirectory() throws DocletException {
+ if (!destDirName.isEmpty()) {
+ DocFile destDir = DocFile.createFileForDirectory(this, destDirName);
+ if (!destDir.exists()) {
+ //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(
- "doclet.destination_directory_not_directory_0",
- destDir.getPath()));
- } else if (!destDir.canWrite()) {
- throw new Fault(getText(
- "doclet.destination_directory_not_writable_0",
- destDir.getPath()));
+ destDir.mkdirs();
+ } else if (!destDir.isDirectory()) {
+ throw new SimpleDocletException(getText(
+ "doclet.destination_directory_not_directory_0",
+ destDir.getPath()));
+ } else if (!destDir.canWrite()) {
+ 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.
*/
@@ -819,7 +808,7 @@
if (!checkOutputFileEncoding(docencoding)) {
return false;
}
- };
+ }
}
if (!docencodingfound && (encoding != null && !encoding.isEmpty())) {
if (!checkOutputFileEncoding(encoding)) {
@@ -858,6 +847,7 @@
/**
* 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.
*/
@@ -867,7 +857,9 @@
/**
* 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") ||
@@ -888,6 +880,7 @@
/**
* 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
*/
@@ -931,6 +924,7 @@
* 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
@@ -942,6 +936,7 @@
* 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
@@ -1009,6 +1004,7 @@
/**
* Return the doclet specific instance of a writer factory.
+ *
* @return the {@link WriterFactory} for the doclet.
*/
public abstract WriterFactory getWriterFactory();
@@ -1017,9 +1013,9 @@
* 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();
@@ -1027,6 +1023,7 @@
/**
* Return the Locale for this document.
+ *
* @return the current locale
*/
public abstract Locale getLocale();
@@ -1040,6 +1037,7 @@
/**
* Return the current file manager.
+ *
* @return JavaFileManager
*/
public abstract JavaFileManager getFileManager();
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ConstantsSummaryWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ConstantsSummaryWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,13 +25,14 @@
package jdk.javadoc.internal.doclets.toolkit;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
+
/**
* The interface for writing constants summary output.
*
@@ -144,7 +145,8 @@
* Print the constants summary document.
*
* @param contentTree content tree which should be printed
+ * @throws DocFileIOException if there is a problem while writing the document
*/
- public abstract void printDocument(Content contentTree) throws IOException;
+ public abstract void printDocument(Content contentTree) throws DocFileIOException;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/Content.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/Content.java Tue Aug 30 08:45:21 2016 -0700
@@ -30,9 +30,6 @@
import java.io.Writer;
import java.util.Objects;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
-
-
/**
* A class to create content for javadoc output pages.
*
@@ -57,7 +54,7 @@
write(out, true);
} catch (IOException e) {
// cannot happen from StringWriter
- throw new DocletAbortException(e);
+ throw new AssertionError(e);
}
return out.toString();
}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/DocletException.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.javadoc.internal.doclets.toolkit;
+
+
+/**
+ * Supertype for all checked doclet exceptions.
+ *
+ * <p><b>This is NOT part of any supported API.
+ * If you write code that depends on this, you do so at your own risk.
+ * This code and its internal interfaces are subject to change or
+ * deletion without notice.</b>
+ *
+ * @apiNote This is primarily intended for the benefit of the builder API
+ * in {@code jdk.javadoc.internal.doclets.toolkit.builders}.
+ */
+public class DocletException extends Exception {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Creates a DocletException with a given detail message.
+ *
+ * The message may or may not be intended for presentation to the end user.
+ *
+ * @param message the detail message.
+ */
+ protected DocletException(String message) {
+ super(message);
+ if (message == null || message.isEmpty()) {
+ throw new IllegalArgumentException();
+ }
+ }
+
+ /**
+ * Creates a DocletException with a given detail message and underlying cause.
+ *
+ * The message may or may not be intended for presentation to the end user.
+ *
+ * @param message the detail message.
+ * @param cause the underlying cause
+ */
+ protected DocletException(String message, Throwable cause) {
+ super(message, cause);
+ if (message == null || message.isEmpty()) {
+ throw new IllegalArgumentException();
+ }
+ }
+}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ModuleSummaryWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ModuleSummaryWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,10 +25,7 @@
package jdk.javadoc.internal.doclets.toolkit;
-import java.io.*;
-import java.util.Set;
-
-import javax.lang.model.element.PackageElement;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
/**
* The interface for writing module summary output.
@@ -130,6 +127,7 @@
* Print the module summary document.
*
* @param contentTree the content tree that will be printed
+ * @throws DocFileIOException if there is a problem while writing the document
*/
- public abstract void printDocument(Content contentTree) throws IOException;
+ public abstract void printDocument(Content contentTree) throws DocFileIOException;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/OverviewElement.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/OverviewElement.java Tue Aug 30 08:45:21 2016 -0700
@@ -35,8 +35,6 @@
import javax.lang.model.element.Name;
import javax.lang.model.type.TypeMirror;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import jdk.javadoc.doclet.DocletEnvironment;
/**
@@ -56,52 +54,52 @@
this.docEnv = docEnv;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public TypeMirror asType() {
throw new UnsupportedOperationException("Unsupported method");
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public ElementKind getKind() {
return ElementKind.OTHER;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Set<javax.lang.model.element.Modifier> getModifiers() {
throw new UnsupportedOperationException("Unsupported method");
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Name getSimpleName() {
throw new UnsupportedOperationException("Unsupported method");
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Element getEnclosingElement() {
throw new UnsupportedOperationException("Unsupported method");
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public java.util.List<? extends Element> getEnclosedElements() {
throw new UnsupportedOperationException("Unsupported method");
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public java.util.List<? extends AnnotationMirror> getAnnotationMirrors() {
throw new UnsupportedOperationException("Unsupported method");
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public <A extends Annotation> A getAnnotation(Class<A> annotationType) {
throw new UnsupportedOperationException("Unsupported method");
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public <R, P> R accept(ElementVisitor<R, P> v, P p) {
return v.visitUnknown(this, p);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType) {
throw new UnsupportedOperationException("Unsupported method");
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/PackageSummaryWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/PackageSummaryWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,13 +25,13 @@
package jdk.javadoc.internal.doclets.toolkit;
-import java.io.*;
-
import java.util.List;
import java.util.SortedSet;
import javax.lang.model.element.TypeElement;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
+
/**
* The interface for writing package summary output.
*
@@ -118,7 +118,8 @@
* Print the package summary document.
*
* @param contentTree the content tree that will be printed
+ * @throws DocFileIOException if there is a problem while writing the document
*/
- public abstract void printDocument(Content contentTree) throws IOException;
+ public abstract void printDocument(Content contentTree) throws DocFileIOException;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/SerializedFormWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/SerializedFormWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,13 +25,12 @@
package jdk.javadoc.internal.doclets.toolkit;
-import java.io.*;
-
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
import com.sun.source.doctree.DocTree;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
/**
* The interface for writing serialized form output.
@@ -124,15 +123,17 @@
public Content getClassContentHeader();
/**
- * Return an instance of a SerialFieldWriter.
+ * Return an instance of a SerialFieldWriter for a class.
*
+ * @param typeElement the class
* @return an instance of a SerialFieldWriter.
*/
public SerialFieldWriter getSerialFieldWriter(TypeElement typeElement);
/**
- * Return an instance of a SerialMethodWriter.
+ * Return an instance of a SerialMethodWriter for a class.
*
+ * @param typeElement the class
* @return an instance of a SerialMethodWriter.
*/
public SerialMethodWriter getSerialMethodWriter(TypeElement typeElement);
@@ -156,8 +157,9 @@
* Print the serialized form document.
*
* @param serializedTree the content tree that will be printed
+ * @throws DocFileIOException if there is a problem while writing the document
*/
- public abstract void printDocument(Content serializedTree) throws IOException;
+ public abstract void printDocument(Content serializedTree) throws DocFileIOException;
/**
* Write the serialized form for a given field.
@@ -199,7 +201,7 @@
/**
* Adds the description text for this member.
*
- * @param field the field to document.
+ * @param field the field to document
* @param contentTree content tree to which the member description will be added
*/
public void addMemberDescription(VariableElement field, Content contentTree);
@@ -207,7 +209,8 @@
/**
* Adds the description text for this member represented by the tag.
*
- * @param serialFieldTag the field to document (represented by tag).
+ * @param field the field to document
+ * @param serialFieldTag the field to document (represented by tag)
* @param contentTree content tree to which the member description will be added
*/
public void addMemberDescription(VariableElement field, DocTree serialFieldTag, Content contentTree);
@@ -215,7 +218,7 @@
/**
* Adds the tag information for this member.
*
- * @param field the field to document.
+ * @param field the field to document
* @param contentTree content tree to which the member tags will be added
*/
public void addMemberTags(VariableElement field, Content contentTree);
@@ -223,11 +226,11 @@
/**
* Adds the member header.
*
- * @param fieldType the type of the field.
+ * @param fieldType the type of the field
* @param fieldTypeStr the type of the field in string format. We will
- * print this out if we can't link to the type.
- * @param fieldDimensions the dimensions of the field.
- * @param fieldName the name of the field.
+ * print this out if we can't link to the type
+ * @param fieldDimensions the dimensions of the field
+ * @param fieldName the name of the field
* @param contentTree content tree to which the member header will be added
*/
public void addMemberHeader(TypeElement fieldType, String fieldTypeStr,
@@ -239,7 +242,7 @@
* for deprecation info, inline comment or tags,
* do not print overview details.
*
- * @param field the field to check overview details for.
+ * @param field the field to check overview details for
* @return true if overview details need to be printed
*/
public boolean shouldPrintOverview(VariableElement field);
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/WorkArounds.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/WorkArounds.java Tue Aug 30 08:45:21 2016 -0700
@@ -44,6 +44,7 @@
import javax.lang.model.element.VariableElement;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.util.Elements;
+import javax.tools.JavaFileManager.Location;
import javax.tools.JavaFileObject;
import com.sun.source.tree.CompilationUnitTree;
@@ -57,6 +58,7 @@
import com.sun.tools.javac.code.Symbol;
import com.sun.tools.javac.code.Symbol.ClassSymbol;
import com.sun.tools.javac.code.Symbol.MethodSymbol;
+import com.sun.tools.javac.code.Symbol.ModuleSymbol;
import com.sun.tools.javac.code.Symbol.VarSymbol;
import com.sun.tools.javac.comp.AttrContext;
import com.sun.tools.javac.comp.Env;
@@ -289,6 +291,14 @@
return ((DocEnvImpl)(configuration.docEnv)).etable.shouldDocument(e);
}
+ // TODO: jx.l.m ?
+ public Location getLocationForModule(ModuleElement mdle) {
+ ModuleSymbol msym = (ModuleSymbol)mdle;
+ return msym.sourceLocation != null
+ ? msym.sourceLocation
+ : msym.classLocation;
+ }
+
//------------------Start of Serializable Implementation---------------------//
private final static Map<TypeElement, NewSerializedForm> serializedForms = new HashMap<>();
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/WriterFactory.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/WriterFactory.java Tue Aug 30 08:45:21 2016 -0700
@@ -52,8 +52,7 @@
* @return the writer for the constant summary. Return null if this
* writer is not supported by the doclet.
*/
- public abstract ConstantsSummaryWriter getConstantsSummaryWriter()
- throws Exception;
+ public abstract ConstantsSummaryWriter getConstantsSummaryWriter();
/**
* Return the writer for the package summary.
@@ -65,8 +64,7 @@
* writer is not supported by the doclet.
*/
public abstract PackageSummaryWriter getPackageSummaryWriter(PackageElement
- packageElement, PackageElement prevPkg, PackageElement nextPkg)
- throws Exception;
+ packageElement, PackageElement prevPkg, PackageElement nextPkg);
/**
* Return the writer for the module summary.
@@ -78,8 +76,7 @@
* writer is not supported by the doclet.
*/
public abstract ModuleSummaryWriter getModuleSummaryWriter(
- ModuleElement mdle, ModuleElement prevModule, ModuleElement nextModule)
- throws Exception;
+ ModuleElement mdle, ModuleElement prevModule, ModuleElement nextModule);
/**
* Return the writer for a class.
@@ -92,8 +89,7 @@
* writer is not supported by the doclet.
*/
public abstract ClassWriter getClassWriter(TypeElement typeElement,
- TypeElement prevClass, TypeElement nextClass, ClassTree classTree)
- throws Exception;
+ TypeElement prevClass, TypeElement nextClass, ClassTree classTree);
/**
* Return the writer for an annotation type.
@@ -105,8 +101,7 @@
* writer is not supported by the doclet.
*/
public abstract AnnotationTypeWriter getAnnotationTypeWriter(
- TypeElement annotationType, TypeMirror prevType, TypeMirror nextType)
- throws Exception;
+ TypeElement annotationType, TypeMirror prevType, TypeMirror nextType);
/**
* Return the method writer for a given class.
@@ -115,8 +110,7 @@
* @return the method writer for the give class. Return null if this
* writer is not supported by the doclet.
*/
- public abstract MethodWriter getMethodWriter(ClassWriter classWriter)
- throws Exception;
+ public abstract MethodWriter getMethodWriter(ClassWriter classWriter);
/**
* Return the annotation type field writer for a given annotation type.
@@ -128,7 +122,7 @@
*/
public abstract AnnotationTypeFieldWriter
getAnnotationTypeFieldWriter(
- AnnotationTypeWriter annotationTypeWriter) throws Exception;
+ AnnotationTypeWriter annotationTypeWriter);
/**
* Return the annotation type optional member writer for a given annotation
@@ -141,7 +135,7 @@
*/
public abstract AnnotationTypeOptionalMemberWriter
getAnnotationTypeOptionalMemberWriter(
- AnnotationTypeWriter annotationTypeWriter) throws Exception;
+ AnnotationTypeWriter annotationTypeWriter);
/**
* Return the annotation type required member writer for a given annotation type.
@@ -153,7 +147,7 @@
*/
public abstract AnnotationTypeRequiredMemberWriter
getAnnotationTypeRequiredMemberWriter(
- AnnotationTypeWriter annotationTypeWriter) throws Exception;
+ AnnotationTypeWriter annotationTypeWriter);
/**
* Return the enum constant writer for a given class.
@@ -163,7 +157,7 @@
* writer is not supported by the doclet.
*/
public abstract EnumConstantWriter getEnumConstantWriter(
- ClassWriter classWriter) throws Exception;
+ ClassWriter classWriter);
/**
* Return the field writer for a given class.
@@ -172,8 +166,7 @@
* @return the field writer for the give class. Return null if this
* writer is not supported by the doclet.
*/
- public abstract FieldWriter getFieldWriter(ClassWriter classWriter)
- throws Exception;
+ public abstract FieldWriter getFieldWriter(ClassWriter classWriter);
/**
* Return the property writer for a given class.
@@ -182,8 +175,7 @@
* @return the property writer for the give class. Return null if this
* writer is not supported by the doclet.
*/
- public abstract PropertyWriter getPropertyWriter(ClassWriter classWriter)
- throws Exception;
+ public abstract PropertyWriter getPropertyWriter(ClassWriter classWriter);
/**
* Return the constructor writer for a given class.
@@ -193,8 +185,7 @@
* writer is not supported by the doclet.
*/
public abstract ConstructorWriter getConstructorWriter(
- ClassWriter classWriter)
- throws Exception;
+ ClassWriter classWriter);
/**
* Return the specified member summary writer for a given class.
@@ -206,11 +197,9 @@
* writer is not supported by the doclet.
*
* @see VisibleMemberMap
- * @throws IllegalArgumentException if memberType is unknown.
*/
public abstract MemberSummaryWriter getMemberSummaryWriter(
- ClassWriter classWriter, VisibleMemberMap.Kind memberType)
- throws Exception;
+ ClassWriter classWriter, VisibleMemberMap.Kind memberType);
/**
* Return the specified member summary writer for a given annotation type.
@@ -223,16 +212,14 @@
* writer is not supported by the doclet.
*
* @see VisibleMemberMap
- * @throws IllegalArgumentException if memberType is unknown.
*/
public abstract MemberSummaryWriter getMemberSummaryWriter(
- AnnotationTypeWriter annotationTypeWriter, VisibleMemberMap.Kind memberType)
- throws Exception;
+ AnnotationTypeWriter annotationTypeWriter, VisibleMemberMap.Kind memberType);
/**
* Return the writer for the serialized form.
*
* @return the writer for the serialized form.
*/
- public SerializedFormWriter getSerializedFormWriter() throws Exception;
+ public SerializedFormWriter getSerializedFormWriter();
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.toolkit.builders;
-import java.io.*;
import java.lang.reflect.*;
import java.util.*;
@@ -33,8 +32,11 @@
import jdk.javadoc.internal.doclets.toolkit.Configuration;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.Messages;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
+import jdk.javadoc.internal.doclets.toolkit.Resources;
+import jdk.javadoc.internal.doclets.toolkit.util.InternalException;
+import jdk.javadoc.internal.doclets.toolkit.util.SimpleDocletException;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
import static javax.tools.Diagnostic.Kind.*;
@@ -91,6 +93,7 @@
protected final Configuration configuration;
protected final Messages messages;
+ protected final Resources resources;
protected final Utils utils;
/**
@@ -109,12 +112,12 @@
/**
* Construct a Builder.
- * @param configuration the configuration used in this run
- * of the doclet.
+ * @param c a context providing information used in this run of the doclet
*/
public AbstractBuilder(Context c) {
this.configuration = c.configuration;
this.messages = configuration.getMessages();
+ this.resources = configuration.getResources();
this.utils = configuration.utils;
this.containingPackagesSeen = c.containingPackagesSeen;
this.layoutParser = c.layoutParser;
@@ -130,39 +133,55 @@
/**
* Build the documentation.
*
- * @throws IOException there was a problem writing the output.
+ * @throws DocletException if there is a problem building the documentation
*/
- public abstract void build() throws IOException;
+ public abstract void build() throws DocletException;
/**
* Build the documentation, as specified by the given XML element.
*
* @param node the XML element that specifies which component to document.
* @param contentTree content tree to which the documentation will be added
+ * @throws DocletException if there is a problem building the documentation
*/
- protected void build(XMLNode node, Content contentTree) {
+ protected void build(XMLNode node, Content contentTree) throws DocletException {
String component = node.name;
try {
- invokeMethod("build" + component,
- new Class<?>[]{XMLNode.class, Content.class},
- new Object[]{node, contentTree});
+ String methodName = "build" + component;
+ if (DEBUG) {
+ configuration.reporter.print(ERROR,
+ "DEBUG: " + getClass().getName() + "." + methodName);
+ }
+ Method method = getClass().getMethod(methodName, XMLNode.class, Content.class);
+ method.invoke(this, node, contentTree);
+
} catch (NoSuchMethodException e) {
- e.printStackTrace(System.err);
- configuration.reporter.print(ERROR, "Unknown element: " + component);
- throw new DocletAbortException(e);
+ // Use SimpleDocletException instead of InternalException because there is nothing
+ // informative about about the place the exception occurred, here in this method.
+ // The problem is either a misconfigured doclet.xml file or a missing method in the
+ // user-supplied(?) doclet
+ String message = resources.getText("doclet.builder.unknown.component", component);
+ throw new SimpleDocletException(message, e);
+
} catch (InvocationTargetException e) {
Throwable cause = e.getCause();
- if (cause instanceof DocletAbortException) {
- throw (DocletAbortException) cause;
+ if (cause instanceof DocletException) {
+ throw (DocletException) cause;
} else {
- throw new DocletAbortException(e.getCause());
+ // use InternalException, so that a stacktrace showing the position of
+ // the internal exception is generated
+ String message = resources.getText("doclet.builder.exception.in.component", component,
+ e.getCause());
+ throw new InternalException(message, e.getCause());
}
- } catch (Exception e) {
- e.printStackTrace(System.err);
- configuration.reporter.print(ERROR, "Exception " +
- e.getClass().getName() +
- " thrown while processing element: " + component);
- throw new DocletAbortException(e);
+
+ } catch (ReflectiveOperationException e) {
+ // Use SimpleDocletException instead of InternalException because there is nothing
+ // informative about about the place the exception occurred, here in this method.
+ // The problem is specific to the method being invoked, such as illegal access
+ // or illegal argument.
+ String message = resources.getText("doclet.builder.exception.in.component", component, e);
+ throw new SimpleDocletException(message, e.getCause());
}
}
@@ -171,29 +190,10 @@
*
* @param node the XML element that specifies which components to document.
* @param contentTree content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the children
*/
- protected void buildChildren(XMLNode node, Content contentTree) {
+ protected void buildChildren(XMLNode node, Content contentTree) throws DocletException {
for (XMLNode child : node.children)
build(child, contentTree);
}
-
- /**
- * Given the name and parameters, invoke the method in the builder. This
- * method is required to invoke the appropriate build method as instructed
- * by the builder XML file.
- *
- * @param methodName the name of the method that we would like to invoke.
- * @param paramClasses the types for each parameter.
- * @param params the parameters of the method.
- */
- protected void invokeMethod(String methodName, Class<?>[] paramClasses,
- Object[] params)
- throws Exception {
- if (DEBUG) {
- configuration.reporter.print(ERROR, "DEBUG: " +
- this.getClass().getName() + "." + methodName);
- }
- Method method = this.getClass().getMethod(methodName, paramClasses);
- method.invoke(this, params);
- }
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractMemberBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractMemberBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -26,7 +26,7 @@
package jdk.javadoc.internal.doclets.toolkit.builders;
import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
/**
* The superclass for all member builders. Member builders are only executed
@@ -44,7 +44,7 @@
/**
* Construct a SubBuilder.
- * @param configuration the configuration used in this run
+ * @param context a context object, providing information used in this run
* of the doclet.
*/
public AbstractMemberBuilder(Context context) {
@@ -54,32 +54,33 @@
/**
* This method is not supported by sub-builders.
*
- * @throws DocletAbortException this method will always throw a
- * DocletAbortException because it is not supported.
+ * @throws AssertionError always
*/
- public void build() throws DocletAbortException {
- //You may not call the build method in a subbuilder.
- throw new DocletAbortException("not supported");
+ @Override
+ public void build() {
+ // You may not call the build method in a subbuilder.
+ throw new AssertionError();
}
/**
- * Build the sub component if there is anything to document.
+ * Builds the sub component if there is anything to document.
*
* @param node the XML element that specifies which components to document.
* @param contentTree content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
@Override
- public void build(XMLNode node, Content contentTree) {
+ public void build(XMLNode node, Content contentTree) throws DocletException {
if (hasMembersToDocument()) {
super.build(node, contentTree);
}
}
/**
- * Return true if this subbuilder has anything to document.
+ * Returns true if this subbuilder has anything to document.
*
- * @return true if this subbuilder has anything to document.
+ * @return true if this subbuilder has anything to document
*/
public abstract boolean hasMembersToDocument();
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,13 +25,12 @@
package jdk.javadoc.internal.doclets.toolkit.builders;
-import java.io.*;
-
import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement;
import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
/**
@@ -83,54 +82,59 @@
}
/**
- * Construct a new ClassBuilder.
+ * Construct a new AnnotationTypeBuilder.
*
* @param context the build context.
* @param annotationTypeDoc the class being documented.
* @param writer the doclet specific writer.
+ * @return an AnnotationTypeBuilder
*/
public static AnnotationTypeBuilder getInstance(Context context,
TypeElement annotationTypeDoc,
- AnnotationTypeWriter writer)
- throws Exception {
+ AnnotationTypeWriter writer) {
return new AnnotationTypeBuilder(context, annotationTypeDoc, writer);
}
/**
* {@inheritDoc}
*/
- public void build() throws IOException {
+ @Override
+ public void build() throws DocletException {
build(layoutParser.parseXML(ROOT), contentTree);
}
/**
* {@inheritDoc}
*/
+ @Override
public String getName() {
return ROOT;
}
/**
- * Build the annotation type documentation.
- *
- * @param node the XML element that specifies which components to document
- * @param contentTree the content tree to which the documentation will be added
- */
- public void buildAnnotationTypeDoc(XMLNode node, Content contentTree) throws Exception {
- contentTree = writer.getHeader(configuration.getText("doclet.AnnotationType") +
- " " + utils.getSimpleName(annotationType));
- Content annotationContentTree = writer.getAnnotationContentHeader();
- buildChildren(node, annotationContentTree);
- writer.addAnnotationContentTree(contentTree, annotationContentTree);
- writer.addFooter(contentTree);
- writer.printDocument(contentTree);
- copyDocFiles();
- }
+ * Build the annotation type documentation.
+ *
+ * @param node the XML element that specifies which components to document
+ * @param contentTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem building the documentation
+ */
+ public void buildAnnotationTypeDoc(XMLNode node, Content contentTree) throws DocletException {
+ contentTree = writer.getHeader(configuration.getText("doclet.AnnotationType") +
+ " " + utils.getSimpleName(annotationType));
+ Content annotationContentTree = writer.getAnnotationContentHeader();
+ buildChildren(node, annotationContentTree);
+ writer.addAnnotationContentTree(contentTree, annotationContentTree);
+ writer.addFooter(contentTree);
+ writer.printDocument(contentTree);
+ copyDocFiles();
+ }
- /**
- * Copy the doc files for the current TypeElement if necessary.
- */
- private void copyDocFiles() {
+ /**
+ * Copy the doc files for the current TypeElement if necessary.
+ *
+ * @throws DocletException if there is a problem building the documentation
+ */
+ private void copyDocFiles() throws DocletException {
PackageElement containingPackage = utils.containingPackage(annotationType);
if((configuration.packages == null ||
!configuration.packages.contains(containingPackage) &&
@@ -141,15 +145,17 @@
utils.copyDocFiles(containingPackage);
containingPackagesSeen.add(containingPackage);
}
- }
+ }
/**
* Build the annotation information tree documentation.
*
* @param node the XML element that specifies which components to document
* @param annotationContentTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem building the documentation
*/
- public void buildAnnotationTypeInfo(XMLNode node, Content annotationContentTree) {
+ public void buildAnnotationTypeInfo(XMLNode node, Content annotationContentTree)
+ throws DocletException {
Content annotationInfoTree = writer.getAnnotationInfoTreeHeader();
buildChildren(node, annotationInfoTree);
annotationContentTree.addContent(writer.getAnnotationInfo(annotationInfoTree));
@@ -201,9 +207,9 @@
*
* @param node the XML element that specifies which components to document
* @param annotationContentTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem building the documentation
*/
- public void buildMemberSummary(XMLNode node, Content annotationContentTree)
- throws Exception {
+ public void buildMemberSummary(XMLNode node, Content annotationContentTree) throws DocletException {
Content memberSummaryTree = writer.getMemberTreeHeader();
configuration.getBuilderFactory().
getMemberSummaryBuilder(writer).buildChildren(node, memberSummaryTree);
@@ -215,8 +221,10 @@
*
* @param node the XML element that specifies which components to document
* @param annotationContentTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem building the documentation
*/
- public void buildAnnotationTypeMemberDetails(XMLNode node, Content annotationContentTree) {
+ public void buildAnnotationTypeMemberDetails(XMLNode node, Content annotationContentTree)
+ throws DocletException {
Content memberDetailsTree = writer.getMemberTreeHeader();
buildChildren(node, memberDetailsTree);
if (memberDetailsTree.isValid()) {
@@ -229,9 +237,10 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem building the documentation
*/
public void buildAnnotationTypeFieldDetails(XMLNode node, Content memberDetailsTree)
- throws Exception {
+ throws DocletException {
configuration.getBuilderFactory().
getAnnotationTypeFieldsBuilder(writer).buildChildren(node, memberDetailsTree);
}
@@ -241,9 +250,10 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem building the documentation
*/
public void buildAnnotationTypeOptionalMemberDetails(XMLNode node, Content memberDetailsTree)
- throws Exception {
+ throws DocletException {
configuration.getBuilderFactory().
getAnnotationTypeOptionalMemberBuilder(writer).buildChildren(node, memberDetailsTree);
}
@@ -253,9 +263,10 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem building the documentation
*/
public void buildAnnotationTypeRequiredMemberDetails(XMLNode node, Content memberDetailsTree)
- throws Exception {
+ throws DocletException {
configuration.getBuilderFactory().
getAnnotationTypeRequiredMemberBuilder(writer).buildChildren(node, memberDetailsTree);
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeFieldBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeFieldBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -33,6 +33,7 @@
import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeFieldWriter;
import jdk.javadoc.internal.doclets.toolkit.Configuration;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
@@ -100,6 +101,7 @@
* @param context the build context.
* @param typeElement the class whose members are being documented.
* @param writer the doclet specific writer.
+ * @return the new AnnotationTypeFieldBuilder
*/
public static AnnotationTypeFieldBuilder getInstance(
Context context, TypeElement typeElement,
@@ -138,7 +140,8 @@
}
/**
- * summaryOrder.size()
+ * Returns whether or not there are members to document.
+ * @return whether or not there are members to document
*/
@Override
public boolean hasMembersToDocument() {
@@ -150,8 +153,10 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildAnnotationTypeField(XMLNode node, Content memberDetailsTree) {
+ public void buildAnnotationTypeField(XMLNode node, Content memberDetailsTree)
+ throws DocletException {
buildAnnotationTypeMember(node, memberDetailsTree);
}
@@ -160,8 +165,10 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildAnnotationTypeMember(XMLNode node, Content memberDetailsTree) {
+ public void buildAnnotationTypeMember(XMLNode node, Content memberDetailsTree)
+ throws DocletException {
if (writer == null) {
return;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeOptionalMemberBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeOptionalMemberBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -30,6 +30,7 @@
import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeOptionalMemberWriter;
import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeRequiredMemberWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
@@ -67,6 +68,7 @@
* @param context the build context.
* @param typeElement the class whose members are being documented.
* @param writer the doclet specific writer.
+ * @return the new AnnotationTypeMemberBuilder
*/
public static AnnotationTypeOptionalMemberBuilder getInstance(
Context context, TypeElement typeElement,
@@ -88,8 +90,10 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildAnnotationTypeOptionalMember(XMLNode node, Content memberDetailsTree) {
+ public void buildAnnotationTypeOptionalMember(XMLNode node, Content memberDetailsTree)
+ throws DocletException {
buildAnnotationTypeMember(node, memberDetailsTree);
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeRequiredMemberBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeRequiredMemberBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -33,6 +33,7 @@
import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeRequiredMemberWriter;
import jdk.javadoc.internal.doclets.toolkit.Configuration;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
@@ -139,7 +140,8 @@
}
/**
- * summaryOrder.size()
+ * Returns whether or not there are members to document.
+ * @return whether or not there are members to document
*/
@Override
public boolean hasMembersToDocument() {
@@ -151,8 +153,10 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildAnnotationTypeRequiredMember(XMLNode node, Content memberDetailsTree) {
+ public void buildAnnotationTypeRequiredMember(XMLNode node, Content memberDetailsTree)
+ throws DocletException {
buildAnnotationTypeMember(node, memberDetailsTree);
}
@@ -162,7 +166,8 @@
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
*/
- public void buildAnnotationTypeMember(XMLNode node, Content memberDetailsTree) {
+ public void buildAnnotationTypeMember(XMLNode node, Content memberDetailsTree)
+ throws DocletException {
if (writer == null) {
return;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/BuilderFactory.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/BuilderFactory.java Tue Aug 30 08:45:21 2016 -0700
@@ -83,7 +83,7 @@
* Return the builder that builds the constant summary.
* @return the builder that builds the constant summary.
*/
- public AbstractBuilder getConstantsSummaryBuilder() throws Exception {
+ public AbstractBuilder getConstantsSummaryBuilder() {
return ConstantsSummaryBuilder.getInstance(context,
writerFactory.getConstantsSummaryWriter());
}
@@ -97,7 +97,7 @@
* @return the builder that builds the constant summary.
*/
public AbstractBuilder getPackageSummaryBuilder(PackageElement pkg, PackageElement prevPkg,
- PackageElement nextPkg) throws Exception {
+ PackageElement nextPkg) {
return PackageSummaryBuilder.getInstance(context, pkg,
writerFactory.getPackageSummaryWriter(pkg, prevPkg, nextPkg));
}
@@ -111,7 +111,7 @@
* @return the builder that builds the module summary.
*/
public AbstractBuilder getModuleSummaryBuilder(ModuleElement mdle, ModuleElement prevModule,
- ModuleElement nextModule) throws Exception {
+ ModuleElement nextModule) {
return ModuleSummaryBuilder.getInstance(context, mdle,
writerFactory.getModuleSummaryWriter(mdle, prevModule, nextModule));
}
@@ -127,8 +127,7 @@
* writer is not supported by the doclet.
*/
public AbstractBuilder getClassBuilder(TypeElement typeElement,
- TypeElement prevClass, TypeElement nextClass, ClassTree classTree)
- throws Exception {
+ TypeElement prevClass, TypeElement nextClass, ClassTree classTree) {
return ClassBuilder.getInstance(context, typeElement,
writerFactory.getClassWriter(typeElement, prevClass, nextClass, classTree));
}
@@ -143,8 +142,7 @@
* writer is not supported by the doclet.
*/
public AbstractBuilder getAnnotationTypeBuilder(
- TypeElement annotationType, TypeMirror prevType, TypeMirror nextType)
- throws Exception {
+ TypeElement annotationType, TypeMirror prevType, TypeMirror nextType) {
return AnnotationTypeBuilder.getInstance(context, annotationType,
writerFactory.getAnnotationTypeWriter(annotationType, prevType, nextType));
}
@@ -154,8 +152,7 @@
*
* @return an instance of the method builder for the given class.
*/
- public AbstractBuilder getMethodBuilder(ClassWriter classWriter)
- throws Exception {
+ public AbstractBuilder getMethodBuilder(ClassWriter classWriter) {
return MethodBuilder.getInstance(context, classWriter.getTypeElement(),
writerFactory.getMethodWriter(classWriter));
}
@@ -168,8 +165,7 @@
* annotation type.
*/
public AbstractBuilder getAnnotationTypeFieldsBuilder(
- AnnotationTypeWriter annotationTypeWriter)
- throws Exception {
+ AnnotationTypeWriter annotationTypeWriter) {
return AnnotationTypeFieldBuilder.getInstance(context,
annotationTypeWriter.getAnnotationTypeElement(),
writerFactory.getAnnotationTypeFieldWriter(annotationTypeWriter));
@@ -183,8 +179,7 @@
* annotation type.
*/
public AbstractBuilder getAnnotationTypeOptionalMemberBuilder(
- AnnotationTypeWriter annotationTypeWriter)
- throws Exception {
+ AnnotationTypeWriter annotationTypeWriter) {
return AnnotationTypeOptionalMemberBuilder.getInstance(context,
annotationTypeWriter.getAnnotationTypeElement(),
writerFactory.getAnnotationTypeOptionalMemberWriter(annotationTypeWriter));
@@ -198,8 +193,7 @@
* annotation type.
*/
public AbstractBuilder getAnnotationTypeRequiredMemberBuilder(
- AnnotationTypeWriter annotationTypeWriter)
- throws Exception {
+ AnnotationTypeWriter annotationTypeWriter) {
return AnnotationTypeRequiredMemberBuilder.getInstance(context,
annotationTypeWriter.getAnnotationTypeElement(),
writerFactory.getAnnotationTypeRequiredMemberWriter(annotationTypeWriter));
@@ -210,8 +204,7 @@
*
* @return an instance of the enum constants builder for the given class.
*/
- public AbstractBuilder getEnumConstantsBuilder(ClassWriter classWriter)
- throws Exception {
+ public AbstractBuilder getEnumConstantsBuilder(ClassWriter classWriter) {
return EnumConstantBuilder.getInstance(context, classWriter.getTypeElement(),
writerFactory.getEnumConstantWriter(classWriter));
}
@@ -221,7 +214,7 @@
*
* @return an instance of the field builder for the given class.
*/
- public AbstractBuilder getFieldBuilder(ClassWriter classWriter) throws Exception {
+ public AbstractBuilder getFieldBuilder(ClassWriter classWriter) {
return FieldBuilder.getInstance(context, classWriter.getTypeElement(),
writerFactory.getFieldWriter(classWriter));
}
@@ -231,7 +224,7 @@
*
* @return an instance of the field builder for the given class.
*/
- public AbstractBuilder getPropertyBuilder(ClassWriter classWriter) throws Exception {
+ public AbstractBuilder getPropertyBuilder(ClassWriter classWriter) {
final PropertyWriter propertyWriter =
writerFactory.getPropertyWriter(classWriter);
return PropertyBuilder.getInstance(context,
@@ -244,8 +237,7 @@
*
* @return an instance of the constructor builder for the given class.
*/
- public AbstractBuilder getConstructorBuilder(ClassWriter classWriter)
- throws Exception {
+ public AbstractBuilder getConstructorBuilder(ClassWriter classWriter) {
return ConstructorBuilder.getInstance(context, classWriter.getTypeElement(),
writerFactory.getConstructorWriter(classWriter));
}
@@ -255,8 +247,7 @@
*
* @return an instance of the member summary builder for the given class.
*/
- public AbstractBuilder getMemberSummaryBuilder(ClassWriter classWriter)
- throws Exception {
+ public AbstractBuilder getMemberSummaryBuilder(ClassWriter classWriter) {
return MemberSummaryBuilder.getInstance(classWriter, context);
}
@@ -267,9 +258,7 @@
* @return an instance of the member summary builder for the given
* annotation type.
*/
- public AbstractBuilder getMemberSummaryBuilder(
- AnnotationTypeWriter annotationTypeWriter)
- throws Exception {
+ public AbstractBuilder getMemberSummaryBuilder(AnnotationTypeWriter annotationTypeWriter) {
return MemberSummaryBuilder.getInstance(annotationTypeWriter, context);
}
@@ -278,8 +267,7 @@
*
* @return the builder that builds the serialized form.
*/
- public AbstractBuilder getSerializedFormBuilder()
- throws Exception {
+ public AbstractBuilder getSerializedFormBuilder() {
return SerializedFormBuilder.getInstance(context);
}
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ClassBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ClassBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,13 +25,13 @@
package jdk.javadoc.internal.doclets.toolkit.builders;
-import java.io.*;
-
import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement;
import jdk.javadoc.internal.doclets.toolkit.ClassWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
/**
@@ -105,11 +105,12 @@
}
/**
- * Construct a new ClassBuilder.
+ * Constructs a new ClassBuilder.
*
* @param context the build context
* @param typeElement the class being documented.
* @param writer the doclet specific writer.
+ * @return the new ClassBuilder
*/
public static ClassBuilder getInstance(Context context,
TypeElement typeElement, ClassWriter writer) {
@@ -119,13 +120,15 @@
/**
* {@inheritDoc}
*/
- public void build() throws IOException {
+ @Override
+ public void build() throws DocletException {
build(layoutParser.parseXML(ROOT), contentTree);
}
/**
* {@inheritDoc}
*/
+ @Override
public String getName() {
return ROOT;
}
@@ -135,8 +138,9 @@
*
* @param node the XML element that specifies which components to document
* @param contentTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildClassDoc(XMLNode node, Content contentTree) throws Exception {
+ public void buildClassDoc(XMLNode node, Content contentTree) throws DocletException {
String key;
if (isInterface) {
key = "doclet.Interface";
@@ -170,15 +174,16 @@
*
* @param node the XML element that specifies which components to document
* @param classContentTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildClassInfo(XMLNode node, Content classContentTree) {
+ public void buildClassInfo(XMLNode node, Content classContentTree) throws DocletException {
Content classInfoTree = writer.getClassInfoTreeHeader();
buildChildren(node, classInfoTree);
classContentTree.addContent(writer.getClassInfo(classInfoTree));
}
/**
- * Build the typeparameters of this class.
+ * Build the type parameters of this class.
*
* @param node the XML element that specifies which components to document
* @param classInfoTree the content tree to which the documentation will be added
@@ -269,8 +274,10 @@
/**
* Copy the doc files.
+ *
+ * @throws DocFileIOException if there is a problem while copying the files
*/
- private void copyDocFiles() {
+ private void copyDocFiles() throws DocFileIOException {
PackageElement containingPackage = utils.containingPackage(typeElement);
if((configuration.packages == null ||
!configuration.packages.contains(containingPackage)) &&
@@ -318,8 +325,9 @@
*
* @param node the XML element that specifies which components to document
* @param classContentTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildMemberSummary(XMLNode node, Content classContentTree) throws Exception {
+ public void buildMemberSummary(XMLNode node, Content classContentTree) throws DocletException {
Content memberSummaryTree = writer.getMemberTreeHeader();
configuration.getBuilderFactory().
getMemberSummaryBuilder(writer).buildChildren(node, memberSummaryTree);
@@ -331,8 +339,9 @@
*
* @param node the XML element that specifies which components to document
* @param classContentTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildMemberDetails(XMLNode node, Content classContentTree) {
+ public void buildMemberDetails(XMLNode node, Content classContentTree) throws DocletException {
Content memberDetailsTree = writer.getMemberTreeHeader();
buildChildren(node, memberDetailsTree);
classContentTree.addContent(writer.getMemberDetailsTree(memberDetailsTree));
@@ -343,9 +352,10 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
public void buildEnumConstantsDetails(XMLNode node,
- Content memberDetailsTree) throws Exception {
+ Content memberDetailsTree) throws DocletException {
configuration.getBuilderFactory().
getEnumConstantsBuilder(writer).buildChildren(node, memberDetailsTree);
}
@@ -355,9 +365,10 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
public void buildFieldDetails(XMLNode node,
- Content memberDetailsTree) throws Exception {
+ Content memberDetailsTree) throws DocletException {
configuration.getBuilderFactory().
getFieldBuilder(writer).buildChildren(node, memberDetailsTree);
}
@@ -365,10 +376,12 @@
/**
* Build the property documentation.
*
- * @param elements the XML elements that specify how a field is documented.
+ * @param node the XML element that specifies which components to document
+ * @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
public void buildPropertyDetails(XMLNode node,
- Content memberDetailsTree) throws Exception {
+ Content memberDetailsTree) throws DocletException {
configuration.getBuilderFactory().
getPropertyBuilder(writer).buildChildren(node, memberDetailsTree);
}
@@ -378,9 +391,10 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
public void buildConstructorDetails(XMLNode node,
- Content memberDetailsTree) throws Exception {
+ Content memberDetailsTree) throws DocletException {
configuration.getBuilderFactory().
getConstructorBuilder(writer).buildChildren(node, memberDetailsTree);
}
@@ -390,9 +404,10 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
public void buildMethodDetails(XMLNode node,
- Content memberDetailsTree) throws Exception {
+ Content memberDetailsTree) throws DocletException {
configuration.getBuilderFactory().
getMethodBuilder(writer).buildChildren(node, memberDetailsTree);
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstantsSummaryBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstantsSummaryBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.toolkit.builders;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.Element;
@@ -35,6 +34,7 @@
import jdk.javadoc.internal.doclets.toolkit.ConstantsSummaryWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
@@ -116,6 +116,7 @@
*
* @param context the build context.
* @param writer the writer for the summary.
+ * @return the new ConstantsSummaryBuilder
*/
public static ConstantsSummaryBuilder getInstance(Context context,
ConstantsSummaryWriter writer) {
@@ -124,9 +125,10 @@
/**
* {@inheritDoc}
+ * @throws DocletException if there is a problem while building the documentation
*/
@Override
- public void build() throws IOException {
+ public void build() throws DocletException {
if (writer == null) {
//Doclet does not support this output.
return;
@@ -147,8 +149,9 @@
*
* @param node the XML element that specifies which components to document
* @param contentTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildConstantSummary(XMLNode node, Content contentTree) throws Exception {
+ public void buildConstantSummary(XMLNode node, Content contentTree) throws DocletException {
contentTree = writer.getHeader();
buildChildren(node, contentTree);
writer.addFooter(contentTree);
@@ -177,8 +180,9 @@
*
* @param node the XML element that specifies which components to document
* @param contentTree the tree to which the summaries will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildConstantSummaries(XMLNode node, Content contentTree) {
+ public void buildConstantSummaries(XMLNode node, Content contentTree) throws DocletException {
printedPackageHeaders.clear();
Content summariesTree = writer.getConstantSummaries();
for (PackageElement aPackage : configuration.packages) {
@@ -211,8 +215,11 @@
*
* @param node the XML element that specifies which components to document
* @param summariesTree the tree to which the class constant summary will be added
+ * @throws DocletException if there is a problem while building the documentation
+ *
*/
- public void buildClassConstantSummary(XMLNode node, Content summariesTree) {
+ public void buildClassConstantSummary(XMLNode node, Content summariesTree)
+ throws DocletException {
SortedSet<TypeElement> classes = !currentPackage.isUnnamed()
? utils.getAllClasses(currentPackage)
: configuration.typeElementCatalog.allUnnamedClasses();
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstructorBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstructorBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -34,6 +34,7 @@
import jdk.javadoc.internal.doclets.toolkit.Configuration;
import jdk.javadoc.internal.doclets.toolkit.ConstructorWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
@@ -112,6 +113,7 @@
* @param context the build context.
* @param typeElement the class whoses members are being documented.
* @param writer the doclet specific writer.
+ * @return the new ConstructorBuilder
*/
public static ConstructorBuilder getInstance(Context context,
TypeElement typeElement, ConstructorWriter writer) {
@@ -139,6 +141,7 @@
* This information can be used for doclet specific documentation
* generation.
*
+ * @param typeElement the class
* @return a list of constructors that will be documented.
*/
public SortedSet<Element> members(TypeElement typeElement) {
@@ -159,8 +162,9 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException is there is a problem while building the documentation
*/
- public void buildConstructorDoc(XMLNode node, Content memberDetailsTree) {
+ public void buildConstructorDoc(XMLNode node, Content memberDetailsTree) throws DocletException {
if (writer == null) {
return;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/EnumConstantBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/EnumConstantBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -33,6 +33,7 @@
import jdk.javadoc.internal.doclets.toolkit.Configuration;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.EnumConstantWriter;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
@@ -102,6 +103,7 @@
* @param context the build context.
* @param typeElement the class whoses members are being documented.
* @param writer the doclet specific writer.
+ * @return the new EnumConstantsBuilder
*/
public static EnumConstantBuilder getInstance(Context context,
TypeElement typeElement, EnumConstantWriter writer) {
@@ -138,7 +140,9 @@
}
/**
- * summaryOrder.size()
+ * Returns whether or not there are members to document.
+ *
+ * @return whether or not there are members to document
*/
@Override
public boolean hasMembersToDocument() {
@@ -150,8 +154,9 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException is there is a problem while building the documentation
*/
- public void buildEnumConstant(XMLNode node, Content memberDetailsTree) {
+ public void buildEnumConstant(XMLNode node, Content memberDetailsTree) throws DocletException {
if (writer == null) {
return;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/FieldBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/FieldBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -33,6 +33,7 @@
import jdk.javadoc.internal.doclets.toolkit.Configuration;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.FieldWriter;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
@@ -103,6 +104,7 @@
* @param context the build context.
* @param typeElement the class whoses members are being documented.
* @param writer the doclet specific writer.
+ * @return the new FieldBuilder
*/
public static FieldBuilder getInstance(Context context,
TypeElement typeElement,
@@ -140,7 +142,9 @@
}
/**
- * summaryOrder.size()
+ * Returns whether or not there are members to document.
+ *
+ * @return whether or not there are members to document
*/
@Override
public boolean hasMembersToDocument() {
@@ -152,8 +156,9 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildFieldDoc(XMLNode node, Content memberDetailsTree) {
+ public void buildFieldDoc(XMLNode node, Content memberDetailsTree) throws DocletException {
if (writer == null) {
return;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/LayoutParser.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/LayoutParser.java Tue Aug 30 08:45:21 2016 -0700
@@ -31,7 +31,8 @@
import javax.xml.parsers.*;
import jdk.javadoc.internal.doclets.toolkit.Configuration;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
+import jdk.javadoc.internal.doclets.toolkit.util.SimpleDocletException;
import org.xml.sax.*;
import org.xml.sax.helpers.DefaultHandler;
@@ -53,7 +54,7 @@
/**
* The map of XML elements that have been parsed.
*/
- private Map<String,XMLNode> xmlElementsMap;
+ private final Map<String,XMLNode> xmlElementsMap;
private XMLNode currentNode;
private final Configuration configuration;
private String currentRoot;
@@ -77,33 +78,38 @@
/**
* Parse the XML specifying the layout of the documentation.
*
+ * @param root the name of the desired node
* @return the list of XML elements parsed.
+ * @throws DocFileIOException if there is a problem reading a user-supplied build file
+ * @throws SimpleDocletException if there is a problem reading the system build file
*/
- public XMLNode parseXML(String root) {
- if (xmlElementsMap.containsKey(root)) {
- return xmlElementsMap.get(root);
+ public XMLNode parseXML(String root) throws DocFileIOException, SimpleDocletException {
+ if (!xmlElementsMap.containsKey(root)) {
+ try {
+ currentRoot = root;
+ isParsing = false;
+ SAXParserFactory factory = SAXParserFactory.newInstance();
+ SAXParser saxParser = factory.newSAXParser();
+ InputStream in = configuration.getBuilderXML();
+ saxParser.parse(in, this);
+ } catch (IOException | ParserConfigurationException | SAXException e) {
+ String message = (configuration.builderXMLPath == null)
+ ? configuration.getResources().getText("doclet.exception.read.resource",
+ Configuration.DEFAULT_BUILDER_XML, e)
+ : configuration.getResources().getText("doclet.exception.read.file",
+ configuration.builderXMLPath, e);
+ throw new SimpleDocletException(message, e);
+ }
}
- try {
- currentRoot = root;
- isParsing = false;
- SAXParserFactory factory = SAXParserFactory.newInstance();
- SAXParser saxParser = factory.newSAXParser();
- InputStream in = configuration.getBuilderXML();
- saxParser.parse(in, this);
- return xmlElementsMap.get(root);
- } catch (Throwable t) {
- t.printStackTrace();
- throw new DocletAbortException(t);
- }
+ return xmlElementsMap.get(root);
}
/**
* {@inheritDoc}
*/
@Override
- public void startElement(String namespaceURI, String sName, String qName,
- Attributes attrs)
- throws SAXException {
+ public void startElement(String namespaceURI, String sName, String qName, Attributes attrs)
+ throws SAXException {
if (isParsing || qName.equals(currentRoot)) {
isParsing = true;
currentNode = new XMLNode(currentNode, qName);
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MemberSummaryBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MemberSummaryBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -42,7 +42,6 @@
import jdk.javadoc.internal.doclets.toolkit.WriterFactory;
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
import jdk.javadoc.internal.doclets.toolkit.util.DocFinder;
-import jdk.javadoc.internal.doclets.toolkit.util.Utils;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
import jdk.javadoc.internal.doclets.toolkit.CommentUtils;
@@ -107,8 +106,7 @@
* @param context the build context.
*/
public static MemberSummaryBuilder getInstance(
- ClassWriter classWriter, Context context)
- throws Exception {
+ ClassWriter classWriter, Context context) {
MemberSummaryBuilder builder = new MemberSummaryBuilder(context,
classWriter.getTypeElement());
WriterFactory wf = context.configuration.getWriterFactory();
@@ -129,8 +127,7 @@
* @param configuration the current configuration of the doclet.
*/
public static MemberSummaryBuilder getInstance(
- AnnotationTypeWriter annotationTypeWriter, Context context)
- throws Exception {
+ AnnotationTypeWriter annotationTypeWriter, Context context) {
MemberSummaryBuilder builder = new MemberSummaryBuilder(context,
annotationTypeWriter.getAnnotationTypeElement());
WriterFactory wf = context.configuration.getWriterFactory();
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MethodBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MethodBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -35,6 +35,7 @@
import jdk.javadoc.internal.doclets.formats.html.ConfigurationImpl;
import jdk.javadoc.internal.doclets.toolkit.Configuration;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.MethodWriter;
import jdk.javadoc.internal.doclets.toolkit.util.DocFinder;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
@@ -156,8 +157,9 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildMethodDoc(XMLNode node, Content memberDetailsTree) {
+ public void buildMethodDoc(XMLNode node, Content memberDetailsTree) throws DocletException {
if (writer == null) {
return;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ModuleSummaryBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ModuleSummaryBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,14 +25,12 @@
package jdk.javadoc.internal.doclets.toolkit.builders;
-import java.io.IOException;
-import java.util.Set;
-
import javax.lang.model.element.ModuleElement;
import javax.lang.model.element.PackageElement;
import javax.tools.StandardLocation;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.ModuleSummaryWriter;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
@@ -105,8 +103,11 @@
/**
* Build the module summary.
+ *
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void build() throws IOException {
+ @Override
+ public void build() throws DocletException {
if (moduleWriter == null) {
//Doclet does not support this output.
return;
@@ -117,6 +118,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public String getName() {
return ROOT;
}
@@ -126,17 +128,14 @@
*
* @param node the XML element that specifies which components to document
* @param contentTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildModuleDoc(XMLNode node, Content contentTree) throws Exception {
+ public void buildModuleDoc(XMLNode node, Content contentTree) throws DocletException {
contentTree = moduleWriter.getModuleHeader(mdle.getSimpleName().toString());
buildChildren(node, contentTree);
moduleWriter.addModuleFooter(contentTree);
moduleWriter.printDocument(contentTree);
- // TEMPORARY:
- // The use of SOURCE_PATH on the next line is temporary. As we transition into the
- // modules world, this should migrate into using a location for the appropriate module
- // on the MODULE_SOURCE_PATH, or (in the old doclet) simply deleted.
- utils.copyDocFiles(configuration, StandardLocation.SOURCE_PATH, DocPaths.moduleSummary(mdle));
+ utils.copyDirectory(mdle, DocPaths.moduleSummary(mdle));
}
/**
@@ -145,8 +144,9 @@
* @param node the XML element that specifies which components to document
* @param contentTree the content tree to which the module contents
* will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildContent(XMLNode node, Content contentTree) {
+ public void buildContent(XMLNode node, Content contentTree) throws DocletException {
Content moduleContentTree = moduleWriter.getContentHeader();
buildChildren(node, moduleContentTree);
moduleWriter.addModuleContent(contentTree, moduleContentTree);
@@ -158,8 +158,9 @@
* @param node the XML element that specifies which components to document
* @param moduleContentTree the module content tree to which the summaries will
* be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildSummary(XMLNode node, Content moduleContentTree) {
+ public void buildSummary(XMLNode node, Content moduleContentTree) throws DocletException {
Content summaryContentTree = moduleWriter.getSummaryHeader();
buildChildren(node, summaryContentTree);
moduleContentTree.addContent(moduleWriter.getSummaryTree(summaryContentTree));
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/PackageSummaryBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/PackageSummaryBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,8 +25,6 @@
package jdk.javadoc.internal.doclets.toolkit.builders;
-import java.io.*;
-
import java.util.Arrays;
import java.util.List;
import java.util.Set;
@@ -36,6 +34,7 @@
import javax.lang.model.element.TypeElement;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.PackageSummaryWriter;
@@ -104,8 +103,11 @@
/**
* Build the package summary.
+ *
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void build() throws IOException {
+ @Override
+ public void build() throws DocletException {
if (packageWriter == null) {
//Doclet does not support this output.
return;
@@ -116,6 +118,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public String getName() {
return ROOT;
}
@@ -125,8 +128,9 @@
*
* @param node the XML element that specifies which components to document
* @param contentTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildPackageDoc(XMLNode node, Content contentTree) throws Exception {
+ public void buildPackageDoc(XMLNode node, Content contentTree) throws DocletException {
contentTree = packageWriter.getPackageHeader(utils.getPackageName(packageElement));
buildChildren(node, contentTree);
packageWriter.addPackageFooter(contentTree);
@@ -140,8 +144,9 @@
* @param node the XML element that specifies which components to document
* @param contentTree the content tree to which the package contents
* will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildContent(XMLNode node, Content contentTree) {
+ public void buildContent(XMLNode node, Content contentTree) throws DocletException {
Content packageContentTree = packageWriter.getContentHeader();
buildChildren(node, packageContentTree);
packageWriter.addPackageContent(contentTree, packageContentTree);
@@ -153,8 +158,9 @@
* @param node the XML element that specifies which components to document
* @param packageContentTree the package content tree to which the summaries will
* be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildSummary(XMLNode node, Content packageContentTree) {
+ public void buildSummary(XMLNode node, Content packageContentTree) throws DocletException {
Content summaryContentTree = packageWriter.getSummaryHeader();
buildChildren(node, summaryContentTree);
packageContentTree.addContent(summaryContentTree);
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/PropertyBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/PropertyBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -33,6 +33,7 @@
import jdk.javadoc.internal.doclets.toolkit.Configuration;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.PropertyWriter;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
@@ -103,6 +104,7 @@
* @param context the build context.
* @param typeElement the class whoses members are being documented.
* @param writer the doclet specific writer.
+ * @return the new PropertyBuilder
*/
public static PropertyBuilder getInstance(Context context,
TypeElement typeElement,
@@ -140,7 +142,9 @@
}
/**
- * summaryOrder.size()
+ * Returns whether or not there are members to document.
+ *
+ * @return whether or not there are members to document
*/
@Override
public boolean hasMembersToDocument() {
@@ -152,8 +156,9 @@
*
* @param node the XML element that specifies which components to document
* @param memberDetailsTree the content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildPropertyDoc(XMLNode node, Content memberDetailsTree) {
+ public void buildPropertyDoc(XMLNode node, Content memberDetailsTree) throws DocletException {
if (writer == null) {
return;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/SerializedFormBuilder.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/SerializedFormBuilder.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,6 @@
package jdk.javadoc.internal.doclets.toolkit.builders;
-import java.io.*;
import java.util.*;
import javax.lang.model.element.Element;
@@ -37,9 +36,9 @@
import com.sun.source.doctree.DocTree;
import com.sun.source.doctree.SerialFieldTree;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.SerializedFormWriter;
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
/**
@@ -114,7 +113,9 @@
/**
* Construct a new SerializedFormBuilder.
+ *
* @param context the build context.
+ * @return the new SerializedFormBuilder
*/
public static SerializedFormBuilder getInstance(Context context) {
return new SerializedFormBuilder(context);
@@ -122,22 +123,21 @@
/**
* Build the serialized form.
+ *
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void build() throws IOException {
+ @Override
+ public void build() throws DocletException {
SortedSet<TypeElement> rootclasses = new TreeSet<>(utils.makeGeneralPurposeComparator());
rootclasses.addAll(configuration.docEnv.getIncludedTypeElements());
if (!serialClassFoundToDocument(rootclasses)) {
//Nothing to document.
return;
}
- try {
- writer = configuration.getWriterFactory().getSerializedFormWriter();
- if (writer == null) {
- //Doclet does not support this output.
- return;
- }
- } catch (Exception e) {
- throw new DocletAbortException(e);
+ writer = configuration.getWriterFactory().getSerializedFormWriter();
+ if (writer == null) {
+ //Doclet does not support this output.
+ return;
}
build(layoutParser.parseXML(NAME), contentTree);
}
@@ -145,6 +145,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public String getName() {
return NAME;
}
@@ -154,8 +155,9 @@
*
* @param node the XML element that specifies which components to document
* @param serializedTree content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildSerializedForm(XMLNode node, Content serializedTree) throws Exception {
+ public void buildSerializedForm(XMLNode node, Content serializedTree) throws DocletException {
serializedTree = writer.getHeader(configuration.getText(
"doclet.Serialized_Form"));
buildChildren(node, serializedTree);
@@ -168,8 +170,10 @@
*
* @param node the XML element that specifies which components to document
* @param serializedTree content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildSerializedFormSummaries(XMLNode node, Content serializedTree) {
+ public void buildSerializedFormSummaries(XMLNode node, Content serializedTree)
+ throws DocletException {
Content serializedSummariesTree = writer.getSerializedSummariesHeader();
for (PackageElement pkg : configuration.packages) {
currentPackage = pkg;
@@ -184,8 +188,9 @@
*
* @param node the XML element that specifies which components to document
* @param serializedSummariesTree content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildPackageSerializedForm(XMLNode node, Content serializedSummariesTree) {
+ public void buildPackageSerializedForm(XMLNode node, Content serializedSummariesTree) throws DocletException {
Content packageSerializedTree = writer.getPackageSerializedHeader();
SortedSet<TypeElement> classes = utils.getAllClassesUnfiltered(currentPackage);
if (classes.isEmpty()) {
@@ -217,8 +222,10 @@
*
* @param node the XML element that specifies which components to document
* @param packageSerializedTree content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildClassSerializedForm(XMLNode node, Content packageSerializedTree) {
+ public void buildClassSerializedForm(XMLNode node, Content packageSerializedTree)
+ throws DocletException {
Content classSerializedTree = writer.getClassSerializedHeader();
SortedSet<TypeElement> typeElements = utils.getAllClassesUnfiltered(currentPackage);
for (TypeElement typeElement : typeElements) {
@@ -262,8 +269,9 @@
*
* @param node the XML element that specifies which components to document
* @param classTree content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildClassContent(XMLNode node, Content classTree) {
+ public void buildClassContent(XMLNode node, Content classTree) throws DocletException {
Content classContentTree = writer.getClassContentHeader();
buildChildren(node, classContentTree);
classTree.addContent(classContentTree);
@@ -275,8 +283,9 @@
*
* @param node the XML element that specifies which components to document
* @param classContentTree content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildSerializableMethods(XMLNode node, Content classContentTree) {
+ public void buildSerializableMethods(XMLNode node, Content classContentTree) throws DocletException {
Content serializableMethodTree = methodWriter.getSerializableMethodsHeader();
SortedSet<ExecutableElement> members = utils.serializationMethods(currentTypeElement);
if (!members.isEmpty()) {
@@ -329,8 +338,9 @@
*
* @param node the XML element that specifies which components to document
* @param methodsContentTree content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildMethodInfo(XMLNode node, Content methodsContentTree) {
+ public void buildMethodInfo(XMLNode node, Content methodsContentTree) throws DocletException {
if(configuration.nocomment){
return;
}
@@ -411,8 +421,10 @@
*
* @param node the XML element that specifies which components to document
* @param classContentTree content tree to which the documentation will be added
+ * @throws DocletException if there is a problem while building the documentation
*/
- public void buildSerializableFields(XMLNode node, Content classContentTree) {
+ public void buildSerializableFields(XMLNode node, Content classContentTree)
+ throws DocletException {
SortedSet<VariableElement> members = utils.serializableFields(currentTypeElement);
if (!members.isEmpty()) {
Content serializableFieldsTree = fieldWriter.getSerializableFieldsHeader();
@@ -533,10 +545,12 @@
}
/**
- * Return true if the given Element should be included
+ * Returns true if the given Element should be included
* in the serialized form.
*
- * @param element the Element object to check for serializability.
+ * @param utils the utils object
+ * @param element the Element object to check for serializability
+ * @return true if the element should be included in the serial form
*/
public static boolean serialInclude(Utils utils, Element element) {
if (element == null) {
@@ -548,7 +562,7 @@
}
/**
- * Return true if the given TypeElement should be included
+ * Returns true if the given TypeElement should be included
* in the serialized form.
*
* @param te the TypeElement object to check for serializability.
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties Tue Aug 30 08:45:21 2016 -0700
@@ -14,17 +14,29 @@
doclet.Option_doclint_no_qualifiers=Access qualifiers not permitted for -Xdoclint arguments
doclet.Option_doclint_invalid_arg=Invalid argument for -Xdoclint option
doclet.Option_doclint_package_invalid_arg=Invalid argument for -Xdoclint/package option
-doclet.exception_encountered= {0} encountered \n\
-\twhile attempting to create file: {1}
-doclet.perform_copy_exception_encountered= {0} encountered while \n\
-performing copy.
+doclet.builder.exception.in.component=An exception occurred while building a component: {0}\n\
+\t({1})
+doclet.builder.unknown.component=Unknown component referenced in doclet build file: {0}
+doclet.error.initializing.dest.dir=Error initializing destination directory: {0}
+doclet.exception.read.file=Error reading file: {0}\n\
+\t({1})
+doclet.exception.write.file=Error writing file: {0}\n\
+\t({1})
+doclet.exception.read.resource=Error reading system resource: {0}\n\
+\t({1})
+doclet.internal.exception=An internal exception has occurred. \n\
+\t({0})
+doclet.internal.report.bug=\
+Please file a bug against the javadoc tool via the Java bug reporting page\n\
+(http://bugreport.java.com) after checking the Bug Database (http://bugs.java.com)\n\
+for duplicates. Include error messages and the following diagnostic in your report. Thank you.
doclet.File_not_found=File not found: {0}
doclet.Copy_Overwrite_warning=File {0} not copied to {1} due to existing file with same name...
doclet.Copying_File_0_To_Dir_1=Copying file {0} to directory {1}...
doclet.Copying_File_0_To_File_1=Copying file {0} to file {1}...
doclet.No_Public_Classes_To_Document=No public or protected classes found to document.
-doclet.destination_directory_not_directory_0=Destination directory is not a directory {0}
-doclet.destination_directory_not_writable_0=Destination directory not writable {0}
+doclet.destination_directory_not_directory_0=Destination directory is not a directory: {0}
+doclet.destination_directory_not_writable_0=Destination directory not writable: {0}
doclet.Encoding_not_supported=Encoding not supported: {0}
doclet.Building_Tree=Building tree for all the packages and classes...
doclet.Building_Index=Building index for all the packages and classes...
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletManager.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletManager.java Tue Aug 30 08:45:21 2016 -0700
@@ -39,8 +39,6 @@
import javax.tools.StandardJavaFileManager;
import com.sun.source.doctree.DocTree;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import jdk.javadoc.internal.doclets.toolkit.Configuration;
import jdk.javadoc.internal.doclets.toolkit.Messages;
import jdk.javadoc.internal.doclets.toolkit.Resources;
@@ -377,7 +375,7 @@
return;
}
new SimpleElementVisitor9<Void, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitModule(ModuleElement e, Void p) {
if (!taglet.inModule()) {
printTagMisuseWarn(utils.getCommentHelper(e), taglet, tag, "module");
@@ -385,7 +383,7 @@
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitPackage(PackageElement e, Void p) {
if (!taglet.inPackage()) {
printTagMisuseWarn(utils.getCommentHelper(e), taglet, tag, "package");
@@ -393,7 +391,7 @@
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitType(TypeElement e, Void p) {
if (!taglet.inType()) {
printTagMisuseWarn(utils.getCommentHelper(e), taglet, tag, "class");
@@ -401,7 +399,7 @@
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitExecutable(ExecutableElement e, Void p) {
if (utils.isConstructor(e) && !taglet.inConstructor()) {
printTagMisuseWarn(utils.getCommentHelper(e), taglet, tag, "constructor");
@@ -411,7 +409,7 @@
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitVariable(VariableElement e, Void p) {
if (utils.isField(e) && !taglet.inField()) {
printTagMisuseWarn(utils.getCommentHelper(e), taglet, tag, "field");
@@ -419,7 +417,7 @@
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitUnknown(Element e, Void p) {
if (utils.isOverviewElement(e) && !taglet.inOverview()) {
printTagMisuseWarn(utils.getCommentHelper(e), taglet, tag, "overview");
@@ -427,7 +425,7 @@
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Void defaultAction(Element e, Void p) {
return null;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassUseMapper.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassUseMapper.java Tue Aug 30 08:45:21 2016 -0700
@@ -44,8 +44,6 @@
import javax.lang.model.util.SimpleTypeVisitor9;
import javax.lang.model.util.Types;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import jdk.javadoc.doclet.DocletEnvironment;
import jdk.javadoc.internal.doclets.formats.html.ConfigurationImpl;
@@ -219,17 +217,17 @@
mapTypeParameters(classToFieldTypeParam, fd, fd);
mapAnnotations(annotationToField, fd, fd);
SimpleTypeVisitor9<Void, VariableElement> stv = new SimpleTypeVisitor9<Void, VariableElement>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitArray(ArrayType t, VariableElement p) {
return visit(t.getComponentType(), p);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitDeclared(DeclaredType t, VariableElement p) {
add(classToField, (TypeElement) t.asElement(), p);
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitTypeVariable(TypeVariable t, VariableElement p) {
return visit(typeUtils.erasure(t), p);
}
@@ -249,7 +247,7 @@
mapTypeParameters(classToMethodTypeParam, method, method);
mapAnnotations(classToMethodAnnotations, method, method);
SimpleTypeVisitor9<Void, ExecutableElement> stv = new SimpleTypeVisitor9<Void, ExecutableElement>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitArray(ArrayType t, ExecutableElement p) {
TypeMirror componentType = t.getComponentType();
return visit(utils.isTypeVariable(componentType)
@@ -257,14 +255,14 @@
: componentType, p);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitDeclared(DeclaredType t, ExecutableElement p) {
mapTypeParameters(classToMethodReturnTypeParam, t, p);
add(classToMethodReturn, (TypeElement) t.asElement(), p);
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Void defaultAction(TypeMirror e, ExecutableElement p) {
return null;
}
@@ -349,12 +347,12 @@
// no duplicates please
if (classArgs.add(pType)) {
new SimpleTypeVisitor9<Void, ExecutableElement>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitArray(ArrayType t, ExecutableElement p) {
return visit(t.getComponentType(), p);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitDeclared(DeclaredType t, ExecutableElement p) {
add(isConstructor
? classToConstructorArgs
@@ -362,7 +360,7 @@
(TypeElement) t.asElement(), p);
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitTypeVariable(TypeVariable t, ExecutableElement p) {
visit(typeUtils.erasure(t), p);
return null;
@@ -383,27 +381,27 @@
for (TypeMirror anException : ee.getThrownTypes()) {
SimpleTypeVisitor9<Void, ExecutableElement> stv = new SimpleTypeVisitor9<Void, ExecutableElement>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitArray(ArrayType t, ExecutableElement p) {
super.visit(t.getComponentType(), p);
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitDeclared(DeclaredType t, ExecutableElement p) {
add(isConstructor ? classToConstructorThrows : classToMethodThrows,
(TypeElement) t.asElement(), p);
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitError(ErrorType t, ExecutableElement p) {
add(isConstructor ? classToConstructorThrows : classToMethodThrows,
(TypeElement) t.asElement(), p);
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Void defaultAction(TypeMirror e, ExecutableElement p) {
throw new AssertionError("this should not happen");
}
@@ -488,7 +486,7 @@
}
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitType(TypeElement e, Void p) {
for (TypeParameterElement param : e.getTypeParameters()) {
addParameters(param);
@@ -496,7 +494,7 @@
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitExecutable(ExecutableElement e, Void p) {
for (TypeParameterElement param : e.getTypeParameters()) {
addParameters(param);
@@ -504,13 +502,13 @@
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Void defaultAction(Element e, Void p) {
mapTypeParameters(map, e.asType(), holder);
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitTypeParameter(TypeParameterElement e, Void p) {
addParameters(e);
return null;
@@ -524,7 +522,7 @@
SimpleTypeVisitor9<Void, Void> tv = new SimpleTypeVisitor9<Void, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitWildcard(WildcardType t, Void p) {
TypeMirror bound = t.getExtendsBound();
if (bound != null) {
@@ -538,7 +536,7 @@
}
// ParameterizedType
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitDeclared(DeclaredType t, Void p) {
for (TypeMirror targ : t.getTypeArguments()) {
addTypeParameterToMap(map, targ, holder);
@@ -566,7 +564,7 @@
}
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitPackage(PackageElement e, Void p) {
for (AnnotationMirror a : e.getAnnotationMirrors()) {
refList(map, a.getAnnotationType().asElement()).add(holder);
@@ -574,7 +572,7 @@
return null;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Void defaultAction(Element e, Void p) {
addAnnotations(e);
return null;
@@ -586,12 +584,12 @@
TypeMirror type, final T holder) {
new SimpleTypeVisitor9<Void, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Void defaultAction(TypeMirror e, Void p) {
return super.defaultAction(e, p);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Void visitDeclared(DeclaredType t, Void p) {
add(map, (TypeElement) t.asElement(), holder);
return null;
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/CommentHelper.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/CommentHelper.java Tue Aug 30 08:45:21 2016 -0700
@@ -67,8 +67,6 @@
import com.sun.source.util.DocTrees;
import com.sun.source.util.SimpleDocTreeVisitor;
import com.sun.source.util.TreePath;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import jdk.javadoc.internal.doclets.toolkit.Configuration;
import static com.sun.source.doctree.DocTree.Kind.*;
@@ -204,7 +202,7 @@
private StringBuilder getText0(DocTree dt) {
final StringBuilder sb = new StringBuilder();
new SimpleDocTreeVisitor<Void, Void>() {
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitAttribute(AttributeTree node, Void p) {
sb.append(SPACER).append(node.getName());
if (node.getValueKind() == ValueKind.EMPTY) {
@@ -232,7 +230,7 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitEndElement(EndElementTree node, Void p) {
sb.append("</")
.append(node.getName())
@@ -240,13 +238,13 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitEntity(EntityTree node, Void p) {
sb.append(node.toString());
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitLink(LinkTree node, Void p) {
if (node.getReference() == null) {
return null;
@@ -259,7 +257,7 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitLiteral(LiteralTree node, Void p) {
if (node.getKind() == CODE) {
sb.append("<").append(node.getKind().tagName).append(">");
@@ -271,13 +269,13 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitReference(ReferenceTree node, Void p) {
sb.append(node.getSignature());
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitSee(SeeTree node, Void p) {
node.getReference().stream().forEach((dt) -> {
dt.accept(this, null);
@@ -285,7 +283,7 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitSerial(SerialTree node, Void p) {
node.getDescription().stream().forEach((dt) -> {
dt.accept(this, null);
@@ -293,7 +291,7 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitStartElement(StartElementTree node, Void p) {
sb.append("<");
sb.append(node.getName());
@@ -304,13 +302,13 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitText(TextTree node, Void p) {
sb.append(node.getBody());
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitUnknownBlockTag(UnknownBlockTagTree node, Void p) {
node.getContent().stream().forEach((dt) -> {
dt.accept(this, null);
@@ -318,12 +316,12 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitValue(ValueTree node, Void p) {
return node.getReference().accept(this, null);
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
protected Void defaultAction(DocTree node, Void p) {
sb.append(node.toString());
return null;
@@ -334,7 +332,7 @@
public String getLabel(Configuration c, DocTree dtree) {
return new SimpleDocTreeVisitor<String, Void>() {
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public String visitLink(LinkTree node, Void p) {
StringBuilder sb = new StringBuilder();
node.getLabel().stream().forEach((dt) -> {
@@ -343,7 +341,7 @@
return sb.toString();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public String visitSee(SeeTree node, Void p) {
StringBuilder sb = new StringBuilder();
node.getReference().stream().filter((dt) -> (c.utils.isText(dt))).forEach((dt) -> {
@@ -352,7 +350,7 @@
return sb.toString();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
protected String defaultAction(DocTree node, Void p) {
return "";
}
@@ -429,7 +427,7 @@
private Element getReferencedElement(Configuration c, DocTree dtree) {
return new SimpleDocTreeVisitor<Element, Void>() {
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Element visitSee(SeeTree node, Void p) {
for (DocTree dt : node.getReference()) {
return visit(dt, null);
@@ -437,27 +435,27 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Element visitLink(LinkTree node, Void p) {
return visit(node.getReference(), null);
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Element visitValue(ValueTree node, Void p) {
return visit(node.getReference(), null);
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Element visitReference(ReferenceTree node, Void p) {
return getElement(c, node);
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Element visitSerialField(SerialFieldTree node, Void p) {
return visit(node.getType(), null);
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
protected Element defaultAction(DocTree node, Void p) {
return null;
}
@@ -466,7 +464,7 @@
public String getReferencedSignature(DocTree dtree) {
return new SimpleDocTreeVisitor<String, Void>() {
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public String visitSee(SeeTree node, Void p) {
for (DocTree dt : node.getReference()) {
return visit(dt, null);
@@ -474,27 +472,27 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public String visitLink(LinkTree node, Void p) {
return visit(node.getReference(), null);
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public String visitValue(ValueTree node, Void p) {
return visit(node.getReference(), null);
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public String visitReference(ReferenceTree node, Void p) {
return node.getSignature();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public String visitSerialField(SerialFieldTree node, Void p) {
return visit(node.getType(), null);
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
protected String defaultAction(DocTree node, Void p) {
return null;
}
@@ -530,87 +528,87 @@
return out;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitAuthor(AuthorTree node, Void p) {
return node.getName();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitComment(CommentTree node, Void p) {
return asList(node.getBody());
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitDeprecated(DeprecatedTree node, Void p) {
return node.getBody();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitDocComment(DocCommentTree node, Void p) {
return node.getBody();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitLiteral(LiteralTree node, Void p) {
return asList(node.getBody().getBody());
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitSince(SinceTree node, Void p) {
return node.getBody();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitText(TextTree node, Void p) {
return asList(node.getBody());
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitVersion(VersionTree node, Void p) {
return node.getBody();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitParam(ParamTree node, Void p) {
return node.getDescription();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitReturn(ReturnTree node, Void p) {
return node.getDescription();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitSee(SeeTree node, Void p) {
return node.getReference();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitSerial(SerialTree node, Void p) {
return node.getDescription();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitSerialData(SerialDataTree node, Void p) {
return node.getDescription();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitSerialField(SerialFieldTree node, Void p) {
return node.getDescription();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitThrows(ThrowsTree node, Void p) {
return node.getDescription();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public List<? extends DocTree> visitUnknownBlockTag(UnknownBlockTagTree node, Void p) {
return node.getContent();
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
protected List<? extends DocTree> defaultAction(DocTree node, Void p) {
return Collections.emptyList();
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocFile.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocFile.java Tue Aug 30 08:45:21 2016 -0700
@@ -26,13 +26,10 @@
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;
@@ -68,8 +65,6 @@
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.
@@ -95,63 +90,85 @@
}
/** Create a DocFile without a location or path */
- protected DocFile(Configuration configuration) {
- this.configuration = configuration;
+ protected DocFile() {
this.location = null;
this.path = null;
}
/** Create a DocFile for a given location and relative path. */
- protected DocFile(Configuration configuration, Location location, DocPath path) {
- this.configuration = configuration;
+ protected DocFile(Location location, DocPath path) {
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.
+ *
+ * @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 IOException, UnsupportedEncodingException;
+ 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.
+ *
+ * @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 IOException, UnsupportedEncodingException;
+ public abstract Writer openWriter() throws DocFileIOException, UnsupportedEncodingException;
/**
* Copy the contents of another file directly to this file.
+ *
+ * @param fromFile the file to be copied
+ * @throws DocFileIOException if there is a problem file copying the file
*/
- public void copyFile(DocFile fromFile) throws IOException {
- try (OutputStream output = openOutputStream();
- InputStream input = fromFile.openInputStream()) {
- byte[] bytearr = new byte[1024];
- int len;
- while ((len = input.read(bytearr)) != -1) {
- output.write(bytearr, 0, len);
+ public void copyFile(DocFile fromFile) throws DocFileIOException {
+ try (OutputStream output = openOutputStream()) {
+ try (InputStream input = fromFile.openInputStream()) {
+ 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 (FileNotFoundException | SecurityException exc) {
+ } catch (IOException e) {
+ 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
+ *
+ * @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) {
+ public void copyResource(DocPath resource, boolean overwrite, boolean replaceNewLine)
+ throws DocFileIOException, ResourceIOException {
if (exists() && !overwrite)
return;
@@ -160,30 +177,35 @@
if (in == null)
return;
- try (OutputStream out = openOutputStream()) {
- if (!replaceNewLine) {
- byte[] buf = new byte[2048];
- int n;
- while ((n = in.read(buf)) > 0)
- out.write(buf, 0, n);
+ try {
+ if (replaceNewLine) {
+ try (BufferedReader reader = new BufferedReader(new InputStreamReader(in))) {
+ try (Writer writer = openWriter()) {
+ String line;
+ 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));
- BufferedWriter writer = new BufferedWriter(configuration.docencoding == null
- ? new OutputStreamWriter(out)
- : new OutputStreamWriter(out, configuration.docencoding))) {
- String line;
- while ((line = reader.readLine()) != null) {
- writer.write(line);
- writer.write(DocletConstants.NL);
+ try (OutputStream out = openOutputStream()) {
+ byte[] buf = new byte[2048];
+ int n;
+ while ((n = readResource(resource, in, buf)) > 0) {
+ write(this, out, buf, n);
}
+ } catch (IOException e) {
+ throw new DocFileIOException(this, DocFileIOException.Mode.WRITE, e);
}
}
} finally {
in.close();
}
} catch (IOException e) {
- e.printStackTrace(System.err);
- throw new DocletAbortException(e);
+ throw new ResourceIOException(resource, e);
}
}
@@ -214,8 +236,12 @@
/** 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. */
- public abstract Iterable<DocFile> list() throws IOException;
+ /** If the file is a directory, list its contents.
+ *
+ * @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();
@@ -242,4 +268,92 @@
* {@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);
+ }
+ }
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocFileFactory.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocFileFactory.java Tue Aug 30 08:45:21 2016 -0700
@@ -31,6 +31,7 @@
import javax.tools.StandardLocation;
import jdk.javadoc.internal.doclets.toolkit.Configuration;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
/**
* Factory for DocFile objects.
@@ -45,8 +46,11 @@
/**
* Get the appropriate factory, based on the file manager given in the
* configuration.
+ *
+ * @param configuration the configuration for this doclet
+ * @return the factory associated with this configuration
*/
- static synchronized DocFileFactory getFactory(Configuration configuration) {
+ public static synchronized DocFileFactory getFactory(Configuration configuration) {
DocFileFactory f = configuration.docFileFactory;
if (f == null) {
JavaFileManager fm = configuration.getFileManager();
@@ -66,6 +70,8 @@
this.configuration = configuration;
}
+ public abstract void setDestDir(String dir) throws DocletException;
+
/** Create a DocFile for a directory. */
abstract DocFile createFileForDirectory(String file);
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocFileIOException.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,82 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.javadoc.internal.doclets.toolkit.util;
+
+import java.io.IOException;
+
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
+
+
+/**
+ * Wraps an IOException and the filename to which it applies.
+ *
+ * <p><b>This is NOT part of any supported API.
+ * If you write code that depends on this, you do so at your own risk.
+ * This code and its internal interfaces are subject to change or
+ * deletion without notice.</b>
+ *
+ * @apiNote 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.
+ */
+public class DocFileIOException extends DocletException {
+ /**
+ * A hint for the type of operation being performed when the exception occurred.
+ *
+ * @apiNote This may be used as a hint when reporting a message to the end user.
+ */
+ public enum Mode {
+ /** The file was being opened for reading, or being read when the exception occurred. */
+ READ,
+ /** The file was being opened for writing, or being written when the exception occurred. */
+ WRITE
+ };
+
+ /**
+ * The file that was in use when the exception occurred.
+ */
+ public final DocFile fileName;
+
+ /**
+ * The mode in which the file was being used when the exception occurred.
+ */
+ public final Mode mode;
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Creates an exception to wrap an IO exception, the file which caused it, and the manner
+ * in which the file was being used.
+ *
+ * @param fileName the file in use when the exception occurred
+ * @param mode the manner in which the file was being used
+ * @param cause the underlying exception
+ */
+ public DocFileIOException(DocFile fileName, Mode mode, IOException cause) {
+ super(mode + ":" + fileName.getPath(), cause);
+ this.fileName = fileName;
+ this.mode = mode;
+ }
+}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocletAbortException.java Tue Aug 30 11:07:58 2016 +0530
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,44 +0,0 @@
-/*
- * Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 only, as
- * published by the Free Software Foundation. Oracle designates this
- * particular file as subject to the "Classpath" exception as provided
- * by Oracle in the LICENSE file that accompanied this code.
- *
- * This code is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- * version 2 for more details (a copy is included in the LICENSE file that
- * accompanied this code).
- *
- * You should have received a copy of the GNU General Public License version
- * 2 along with this work; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
- * or visit www.oracle.com if you need additional information or have any
- * questions.
- */
-
-package jdk.javadoc.internal.doclets.toolkit.util;
-
-/**
- * <p><b>This is NOT part of any supported API.
- * If you write code that depends on this, you do so at your own risk.
- * This code and its internal interfaces are subject to change or
- * deletion without notice.</b>
- */
-public class DocletAbortException extends RuntimeException {
- private static final long serialVersionUID = -9131058909576418984L;
-
- public DocletAbortException(String message) {
- super(message);
- }
-
- public DocletAbortException(Throwable cause) {
- super(cause);
- }
-}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Extern.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Extern.java Tue Aug 30 08:45:21 2016 -0700
@@ -117,6 +117,7 @@
/**
* String representation of "this" with packagename and the path.
*/
+ @Override
public String toString() {
return packageName + (relative? " -> " : " => ") + path;
}
@@ -130,6 +131,7 @@
* Determine if a element item is externally documented.
*
* @param element an Element.
+ * @return true if the element is externally documented
*/
public boolean isExternal(Element element) {
if (packageToItemMap == null) {
@@ -176,8 +178,11 @@
* file.
* @param reporter The <code>DocErrorReporter</code> used to report errors.
* @param linkoffline True if -linkoffline is used and false if -link is used.
+ * @return true if successful, false otherwise
+ * @throws DocFileIOException if there is a problem reading a package list file
*/
- public boolean link(String url, String pkglisturl, Reporter reporter, boolean linkoffline) {
+ public boolean link(String url, String pkglisturl, Reporter reporter, boolean linkoffline)
+ throws DocFileIOException {
this.linkoffline = linkoffline;
try {
url = adjustEndFileSeparator(url);
@@ -251,9 +256,11 @@
*
* @param path URL or directory path to the packages.
* @param pkgListPath Path to the local "package-list" file.
+ * @throws Fault if an error occurs that can be treated as a warning
+ * @throws DocFileIOException if there is a problem opening the package list file
*/
private void readPackageListFromFile(String path, DocFile pkgListPath)
- throws Fault {
+ throws Fault, DocFileIOException {
DocFile file = pkgListPath.resolve(DocPaths.PACKAGE_LIST);
if (! (file.isAbsolute() || linkoffline)){
file = file.resolveAgainst(DocumentationTool.Location.DOCUMENTATION_OUTPUT);
@@ -279,35 +286,33 @@
* @param input InputStream from the "package-list" file.
* @param path URL or the directory path to the packages.
* @param relative Is path relative?
+ * @throws IOException if there is a problem reading or closing the stream
*/
private void readPackageList(InputStream input, String path, boolean relative)
throws IOException {
- BufferedReader in = new BufferedReader(new InputStreamReader(input));
- StringBuilder strbuf = new StringBuilder();
- try {
+ try (BufferedReader in = new BufferedReader(new InputStreamReader(input))) {
+ StringBuilder strbuf = new StringBuilder();
int c;
while ((c = in.read()) >= 0) {
- char ch = (char)c;
+ char ch = (char) c;
if (ch == '\n' || ch == '\r') {
if (strbuf.length() > 0) {
String packname = strbuf.toString();
- String packpath = path +
- packname.replace('.', '/') + '/';
- new Item(packname, packpath, relative);
+ String packpath = path
+ + packname.replace('.', '/') + '/';
+ Item ignore = new Item(packname, packpath, relative);
strbuf.setLength(0);
}
} else {
strbuf.append(ch);
}
}
- } finally {
- input.close();
}
}
public boolean isUrl (String urlCandidate) {
try {
- new URL(urlCandidate);
+ URL ignore = new URL(urlCandidate);
//No exception was thrown, so this must really be a URL.
return true;
} catch (MalformedURLException e) {
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/InternalException.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.javadoc.internal.doclets.toolkit.util;
+
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
+
+
+/**
+ * An exception with a user-friendly detail message for an unexpected/internal exception.
+ *
+ * <p><b>This is NOT part of any supported API.
+ * If you write code that depends on this, you do so at your own risk.
+ * This code and its internal interfaces are subject to change or
+ * deletion without notice.</b>
+ */
+public class InternalException extends DocletException {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Creates an exception with a user-friendly detail message, and underlying cause.
+ * A stacktrace for the cause may be presented to the user.
+ *
+ * @param message a localized detail message, suitable for direct presentation to the end user
+ * @param cause the underlying cause for the exception
+ */
+ public InternalException(String message, Throwable cause) {
+ super(message, cause);
+ }
+}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/PackageListWriter.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/PackageListWriter.java Tue Aug 30 08:45:21 2016 -0700
@@ -26,13 +26,11 @@
package jdk.javadoc.internal.doclets.toolkit.util;
import java.io.*;
-import java.util.*;
import javax.lang.model.element.PackageElement;
import jdk.javadoc.doclet.DocletEnvironment;
import jdk.javadoc.internal.doclets.toolkit.Configuration;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
/**
@@ -45,18 +43,19 @@
*
* @author Atul M Dambalkar
*/
-public class PackageListWriter extends PrintWriter {
+public class PackageListWriter {
private final Configuration configuration;
private final Utils utils;
+ private final DocFile file;
/**
* Constructor.
*
* @param configuration the current configuration of the doclet.
*/
- public PackageListWriter(Configuration configuration) throws IOException {
- super(DocFile.createFileForOutput(configuration, DocPaths.PACKAGE_LIST).openWriter());
+ public PackageListWriter(Configuration configuration) {
+ file = DocFile.createFileForOutput(configuration, DocPaths.PACKAGE_LIST);
this.configuration = configuration;
this.utils = configuration.utils;
}
@@ -65,32 +64,25 @@
* Generate the package index.
*
* @param configuration the current configuration of the doclet.
- * @throws DocletAbortException
+ * @throws DocFileIOException if there is a problem writing the output
*/
- public static void generate(Configuration configuration) {
- PackageListWriter packgen;
- try {
- packgen = new PackageListWriter(configuration);
- packgen.generatePackageListFile(configuration.docEnv);
- packgen.close();
- } catch (IOException exc) {
- Messages messages = configuration.getMessages();
- messages.error("doclet.exception_encountered",
- exc.toString(), DocPaths.PACKAGE_LIST);
- throw new DocletAbortException(exc);
+ public static void generate(Configuration configuration) throws DocFileIOException {
+ PackageListWriter packgen = new PackageListWriter(configuration);
+ packgen.generatePackageListFile(configuration.docEnv);
+ }
+
+ protected void generatePackageListFile(DocletEnvironment docEnv) throws DocFileIOException {
+ try (BufferedWriter out = new BufferedWriter(file.openWriter())) {
+ for (PackageElement pkg : configuration.packages) {
+ // if the -nodeprecated option is set and the package is marked as
+ // deprecated, do not include it in the packages list.
+ if (!(configuration.nodeprecated && utils.isDeprecated(pkg))) {
+ out.write(pkg.toString());
+ out.newLine();
+ }
+ }
+ } catch (IOException e) {
+ throw new DocFileIOException(file, DocFileIOException.Mode.WRITE, e);
}
}
-
- protected void generatePackageListFile(DocletEnvironment docEnv) {
- ArrayList<PackageElement> names = new ArrayList<>();
- for (PackageElement pkg : configuration.packages) {
- // if the -nodeprecated option is set and the package is marked as
- // deprecated, do not include it in the packages list.
- if (!(configuration.nodeprecated && utils.isDeprecated(pkg)))
- names.add(pkg);
- }
- names.stream().forEach((name) -> {
- println(name);
- });
- }
}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ResourceIOException.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.javadoc.internal.doclets.toolkit.util;
+
+import java.io.IOException;
+
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
+
+
+/**
+ * Wraps an IOException and the path for the resource to which it applies.
+ *
+ * <p><b>This is NOT part of any supported API.
+ * If you write code that depends on this, you do so at your own risk.
+ * This code and its internal interfaces are subject to change or
+ * deletion without notice.</b>
+ *
+ * @apiNote 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.
+ */
+public class ResourceIOException extends DocletException {
+
+ /**
+ * The resource that was in use when the exception occurred.
+ */
+ public final DocPath resource;
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Creates an exception to wrap an IO exception, the resource which caused it.
+ *
+ * @param resource the resource in use when the exception occurred
+ * @param cause the underlying exception
+ */
+ public ResourceIOException(DocPath resource, IOException cause) {
+ super(resource.getPath(), cause);
+ this.resource = resource;
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/SimpleDocletException.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.javadoc.internal.doclets.toolkit.util;
+
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
+
+
+/**
+ * An exception with a user-friendly detail message.
+ *
+ * <p><b>This is NOT part of any supported API.
+ * If you write code that depends on this, you do so at your own risk.
+ * This code and its internal interfaces are subject to change or
+ * deletion without notice.</b>
+ */
+public class SimpleDocletException extends DocletException {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Creates an exception with a user-friendly detail message.
+ *
+ * @param message a localized detail message, suitable for direct presentation to the end user
+ */
+ public SimpleDocletException(String message) {
+ super(message);
+ }
+
+ /**
+ * Creates an exception with a user-friendly detail message, and underlying cause.
+ * The cause may be used for debugging but in normal use, should not be presented to the user.
+ *
+ * @param message a localized detail message, suitable for direct presentation to the end user
+ * @param cause the underlying cause for the exception
+ */
+ public SimpleDocletException(String message, Throwable cause) {
+ super(message, cause);
+ }
+}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/StandardDocFileFactory.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/StandardDocFileFactory.java Tue Aug 30 08:45:21 2016 -0700
@@ -42,6 +42,7 @@
import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.List;
+import java.util.Objects;
import java.util.Set;
import javax.tools.DocumentationTool;
@@ -72,32 +73,43 @@
fileManager = (StandardJavaFileManager) configuration.getFileManager();
}
+ @Override
+ public void setDestDir(String destDirName) throws SimpleDocletException {
+ if (destDir != null)
+ throw new AssertionError("destDir already initialized: " + destDir);
+
+ if (!destDirName.isEmpty()
+ || !fileManager.hasLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT)) {
+ try {
+ String dirName = destDirName.isEmpty() ? "." : destDirName;
+ Path dir = Paths.get(dirName);
+ fileManager.setLocationFromPaths(DocumentationTool.Location.DOCUMENTATION_OUTPUT, Arrays.asList(dir));
+ } catch (IOException e) {
+ // generic IOException from file manager, setting location, e.g. file not a directory
+ String message = configuration.getResources().getText("doclet.error.initializing.dest.dir", e);
+ throw new SimpleDocletException(message, e);
+ }
+ }
+
+ destDir = fileManager.getLocationAsPaths(DocumentationTool.Location.DOCUMENTATION_OUTPUT).iterator().next();
+ }
+
private Path getDestDir() {
- if (destDir == null) {
- if (!configuration.destDirName.isEmpty()
- || !fileManager.hasLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT)) {
- try {
- String dirName = configuration.destDirName.isEmpty() ? "." : configuration.destDirName;
- Path dir = Paths.get(dirName);
- fileManager.setLocationFromPaths(DocumentationTool.Location.DOCUMENTATION_OUTPUT, Arrays.asList(dir));
- } catch (IOException e) {
- throw new DocletAbortException(e);
- }
- }
-
- destDir = fileManager.getLocationAsPaths(DocumentationTool.Location.DOCUMENTATION_OUTPUT).iterator().next();
- }
+ Objects.requireNonNull(destDir, "destDir not initialized");
return destDir;
}
+ @Override
public DocFile createFileForDirectory(String file) {
return new StandardDocFile(Paths.get(file));
}
+ @Override
public DocFile createFileForInput(String file) {
return new StandardDocFile(Paths.get(file));
}
+ @Override
public DocFile createFileForOutput(DocPath path) {
return new StandardDocFile(DocumentationTool.Location.DOCUMENTATION_OUTPUT, path);
}
@@ -125,38 +137,53 @@
}
class StandardDocFile extends DocFile {
- private Path file;
+ private final Path file;
/** Create a StandardDocFile for a given file. */
private StandardDocFile(Path file) {
- super(configuration);
this.file = file;
}
/** Create a StandardDocFile for a given location and relative path. */
private StandardDocFile(Location location, DocPath path) {
- super(configuration, location, path);
+ super(location, path);
Assert.check(location == DocumentationTool.Location.DOCUMENTATION_OUTPUT);
this.file = newFile(getDestDir(), path.getPath());
}
- /** Open an input stream for the file. */
- public InputStream openInputStream() throws IOException {
- JavaFileObject fo = getJavaFileObjectForInput(file);
- return new BufferedInputStream(fo.openInputStream());
+ /**
+ * Open an input stream for the file.
+ *
+ * @throws DocFileIOException if there is a problem while opening stream
+ */
+ @Override
+ public InputStream openInputStream() throws DocFileIOException {
+ try {
+ JavaFileObject fo = getJavaFileObjectForInput(file);
+ return new BufferedInputStream(fo.openInputStream());
+ } catch (IOException e) {
+ throw new DocFileIOException(this, DocFileIOException.Mode.READ, e);
+ }
}
/**
* 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.
+ *
+ * @throws DocFileIOException if there is a problem while opening stream
*/
- public OutputStream openOutputStream() throws IOException, UnsupportedEncodingException {
+ @Override
+ public OutputStream openOutputStream() throws DocFileIOException {
if (location != DocumentationTool.Location.DOCUMENTATION_OUTPUT)
throw new IllegalStateException();
- OutputStream out = getFileObjectForOutput(path).openOutputStream();
- return new BufferedOutputStream(out);
+ try {
+ OutputStream out = getFileObjectForOutput(path).openOutputStream();
+ return new BufferedOutputStream(out);
+ } catch (IOException e) {
+ throw new DocFileIOException(this, DocFileIOException.Mode.WRITE, e);
+ }
}
/**
@@ -164,60 +191,77 @@
* doclet configuration.
* The file must have been created with a location of
* {@link DocumentationTool.Location#DOCUMENTATION_OUTPUT} and a corresponding relative path.
+ *
+ * @throws DocFileIOException if there is a problem while opening stream
+ * @throws UnsupportedEncodingException if the configured encoding is not supported
*/
- public Writer openWriter() throws IOException, UnsupportedEncodingException {
+ @Override
+ public Writer openWriter() throws DocFileIOException, UnsupportedEncodingException {
if (location != DocumentationTool.Location.DOCUMENTATION_OUTPUT)
throw new IllegalStateException();
- OutputStream out = getFileObjectForOutput(path).openOutputStream();
- if (configuration.docencoding == null) {
- return new BufferedWriter(new OutputStreamWriter(out));
- } else {
- return new BufferedWriter(new OutputStreamWriter(out, configuration.docencoding));
+ try {
+ OutputStream out = getFileObjectForOutput(path).openOutputStream();
+ if (configuration.docencoding == null) {
+ return new BufferedWriter(new OutputStreamWriter(out));
+ } else {
+ return new BufferedWriter(new OutputStreamWriter(out, configuration.docencoding));
+ }
+ } catch (IOException e) {
+ throw new DocFileIOException(this, DocFileIOException.Mode.WRITE, e);
}
}
/** Return true if the file can be read. */
+ @Override
public boolean canRead() {
return Files.isReadable(file);
}
/** Return true if the file can be written. */
+ @Override
public boolean canWrite() {
return Files.isWritable(file);
}
/** Return true if the file exists. */
+ @Override
public boolean exists() {
return Files.exists(file);
}
/** Return the base name (last component) of the file name. */
+ @Override
public String getName() {
return file.getFileName().toString();
}
/** Return the file system path for this file. */
+ @Override
public String getPath() {
return file.toString();
}
/** Return true is file has an absolute path name. */
+ @Override
public boolean isAbsolute() {
return file.isAbsolute();
}
/** Return true is file identifies a directory. */
+ @Override
public boolean isDirectory() {
return Files.isDirectory(file);
}
/** Return true is file identifies a file. */
+ @Override
public boolean isFile() {
return Files.isRegularFile(file);
}
/** Return true if this file is the same as another. */
+ @Override
public boolean isSameFile(DocFile other) {
if (!(other instanceof StandardDocFile))
return false;
@@ -230,17 +274,21 @@
}
/** If the file is a directory, list its contents. */
- public Iterable<DocFile> list() throws IOException {
- List<DocFile> files = new ArrayList<DocFile>();
+ @Override
+ public Iterable<DocFile> list() throws DocFileIOException {
+ List<DocFile> files = new ArrayList<>();
try (DirectoryStream<Path> ds = Files.newDirectoryStream(file)) {
for (Path f: ds) {
files.add(new StandardDocFile(f));
}
+ } catch (IOException e) {
+ throw new DocFileIOException(this, DocFileIOException.Mode.READ, e);
}
return files;
}
/** Create the file as a directory, including any parent directories. */
+ @Override
public boolean mkdirs() {
try {
Files.createDirectories(file);
@@ -256,6 +304,7 @@
* If this file has a path set, the new file will have a corresponding
* new path.
*/
+ @Override
public DocFile resolve(DocPath p) {
return resolve(p.getPath());
}
@@ -266,6 +315,7 @@
* If this file has a path set, the new file will have a corresponding
* new path.
*/
+ @Override
public DocFile resolve(String p) {
if (location == null && path == null) {
return new StandardDocFile(file.resolve(p));
@@ -279,6 +329,7 @@
* @param locn Currently, only
* {@link DocumentationTool.Location.DOCUMENTATION_OUTPUT} is supported.
*/
+ @Override
public DocFile resolveAgainst(Location locn) {
if (locn != DocumentationTool.Location.DOCUMENTATION_OUTPUT)
throw new IllegalArgumentException();
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java Tue Aug 30 08:45:21 2016 -0700
@@ -25,7 +25,7 @@
package jdk.javadoc.internal.doclets.toolkit.util;
-import java.io.*;
+import java.io.IOException;
import java.lang.annotation.Documented;
import java.lang.ref.SoftReference;
import java.text.CollationKey;
@@ -61,6 +61,7 @@
import javax.lang.model.util.TypeKindVisitor9;
import javax.lang.model.util.Types;
import javax.tools.FileObject;
+import javax.tools.JavaFileManager;
import javax.tools.JavaFileManager.Location;
import javax.tools.StandardLocation;
@@ -74,10 +75,11 @@
import com.sun.source.util.DocSourcePositions;
import com.sun.source.util.DocTrees;
import com.sun.source.util.TreePath;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import jdk.javadoc.internal.doclets.toolkit.CommentUtils.DocCommentDuo;
import jdk.javadoc.internal.doclets.toolkit.Configuration;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
+import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.Resources;
import jdk.javadoc.internal.doclets.toolkit.WorkArounds;
import static javax.lang.model.element.ElementKind.*;
@@ -85,9 +87,6 @@
import static javax.lang.model.type.TypeKind.*;
import static com.sun.source.doctree.DocTree.Kind.*;
-
-import jdk.javadoc.internal.doclets.toolkit.Messages;
-
import static jdk.javadoc.internal.doclets.toolkit.builders.ConstantsSummaryBuilder.MAX_CONSTANT_VALUE_INDEX_LENGTH;
@@ -268,57 +267,110 @@
}
/**
+ * Copy doc-files directory and its contents from the source
+ * package directory to the generated documentation directory.
+ * For example, given a package java.lang, this method will copy
+ * the doc-files directory, found in the package directory to the
+ * generated documentation hierarchy.
+ *
+ * @param pe the package containing the doc files to be copied
+ * @throws DocFileIOException if there is a problem while copying
+ * the documentation files
+ */
+ public void copyDocFiles(PackageElement pe) throws DocFileIOException {
+ Location sourceLoc = getLocationForPackage(pe);
+ copyDirectory(sourceLoc, DocPath.forPackage(pe).resolve(DocPaths.DOC_FILES));
+ }
+
+ /**
* Copy the given directory contents from the source package directory
- * to the generated documentation directory. For example for a package
- * java.lang this method find out the source location of the package using
- * {@link SourcePath} and if given directory is found in the source
- * directory structure, copy the entire directory, to the generated
+ * to the generated documentation directory. For example, given a package
+ * java.lang, this method will copy the entire directory, to the generated
* documentation hierarchy.
- * @param pe
+ *
+ * @param pe the package containing the directory to be copied
+ * @param dir the directory to be copied
+ * @throws DocFileIOException if there is a problem while copying
+ * the documentation files
*/
- public void copyDocFiles(PackageElement pe) {
- copyDocFiles(DocPath.forPackage(pe).resolve(DocPaths.DOC_FILES));
+ public void copyDirectory(PackageElement pe, DocPath dir) throws DocFileIOException {
+ copyDirectory(getLocationForPackage(pe), dir);
}
- public void copyDocFiles(DocPath dir) {
- try {
- boolean first = true;
- for (DocFile f : DocFile.list(configuration, StandardLocation.SOURCE_PATH, dir)) {
- if (!f.isDirectory()) {
- continue;
- }
- DocFile srcdir = f;
- DocFile destdir = DocFile.createFileForOutput(configuration, dir);
- if (srcdir.isSameFile(destdir)) {
- continue;
- }
-
- for (DocFile srcfile: srcdir.list()) {
- DocFile destfile = destdir.resolve(srcfile.getName());
- if (srcfile.isFile()) {
- if (destfile.exists() && !first) {
- messages.warning("doclet.Copy_Overwrite_warning",
- srcfile.getPath(), destdir.getPath());
- } else {
- messages.notice("doclet.Copying_File_0_To_Dir_1",
- srcfile.getPath(), destdir.getPath());
- destfile.copyFile(srcfile);
- }
- } else if (srcfile.isDirectory()) {
- if (configuration.copydocfilesubdirs
- && !configuration.shouldExcludeDocFileDir(srcfile.getName())) {
- copyDocFiles(dir.resolve(srcfile.getName()));
- }
+ /**
+ * Copy the given directory and its contents from the source
+ * module directory to the generated documentation directory.
+ * For example, given a package java.lang, this method will
+ * copy the entire directory, to the generated documentation
+ * hierarchy.
+ *
+ * @param mdle the module containing the directory to be copied
+ * @param dir the directory to be copied
+ * @throws DocFileIOException if there is a problem while copying
+ * the documentation files
+ */
+ public void copyDirectory(ModuleElement mdle, DocPath dir) throws DocFileIOException {
+ copyDirectory(getLocationForModule(mdle), dir);
+ }
+
+ /**
+ * Copy files from a doc path location to the output.
+ *
+ * @param locn the location from which to read files
+ * @param dir the directory to be copied
+ * @throws DocFileIOException if there is a problem
+ * copying the files
+ */
+ public void copyDirectory(Location locn, DocPath dir) throws DocFileIOException {
+ boolean first = true;
+ for (DocFile f : DocFile.list(configuration, locn, dir)) {
+ if (!f.isDirectory()) {
+ continue;
+ }
+ DocFile srcdir = f;
+ DocFile destdir = DocFile.createFileForOutput(configuration, dir);
+ if (srcdir.isSameFile(destdir)) {
+ continue;
+ }
+
+ for (DocFile srcfile: srcdir.list()) {
+ DocFile destfile = destdir.resolve(srcfile.getName());
+ if (srcfile.isFile()) {
+ if (destfile.exists() && !first) {
+ messages.warning("doclet.Copy_Overwrite_warning",
+ srcfile.getPath(), destdir.getPath());
+ } else {
+ messages.notice("doclet.Copying_File_0_To_Dir_1",
+ srcfile.getPath(), destdir.getPath());
+ destfile.copyFile(srcfile);
+ }
+ } else if (srcfile.isDirectory()) {
+ if (configuration.copydocfilesubdirs
+ && !configuration.shouldExcludeDocFileDir(srcfile.getName())) {
+ copyDirectory(locn, dir.resolve(srcfile.getName()));
}
}
-
- first = false;
}
- } catch (SecurityException | IOException exc) {
- throw new DocletAbortException(exc);
+
+ first = false;
}
}
+ protected Location getLocationForPackage(PackageElement pd) {
+ return getLocationForModule(configuration.docEnv.getElementUtils().getModuleOf(pd));
+ }
+
+ protected Location getLocationForModule(ModuleElement mdle) {
+ Location loc = configuration.workArounds.getLocationForModule(mdle);
+ if (loc != null)
+ return loc;
+
+ JavaFileManager fm = configuration.docEnv.getJavaFileManager();
+ return fm.hasLocation(StandardLocation.SOURCE_PATH)
+ ? StandardLocation.SOURCE_PATH
+ : StandardLocation.CLASS_PATH;
+ }
+
public boolean isAnnotated(TypeMirror e) {
return !e.getAnnotationMirrors().isEmpty();
}
@@ -329,17 +381,17 @@
public boolean isAnnotationType(Element e) {
return new SimpleElementVisitor9<Boolean, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitExecutable(ExecutableElement e, Void p) {
return visit(e.getEnclosingElement());
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitUnknown(Element e, Void p) {
return false;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Boolean defaultAction(Element e, Void p) {
return e.getKind() == ANNOTATION_TYPE;
}
@@ -499,34 +551,34 @@
}
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitTypeAsInterface(TypeElement e, SortedSet<Modifier> p) {
addVisibilityModifier(p);
addStatic(p);
return finalString("interface");
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitTypeAsEnum(TypeElement e, SortedSet<Modifier> p) {
addVisibilityModifier(p);
addStatic(p);
return finalString("enum");
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitTypeAsAnnotationType(TypeElement e, SortedSet<Modifier> p) {
addVisibilityModifier(p);
addStatic(p);
return finalString("@interface");
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitTypeAsClass(TypeElement e, SortedSet<Modifier> p) {
addModifers(p);
return finalString("class");
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected String defaultAction(Element e, SortedSet<Modifier> p) {
addModifers(p);
return sb.toString().trim();
@@ -572,19 +624,19 @@
public boolean isPrimitive(TypeMirror t) {
return new SimpleTypeVisitor9<Boolean, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitNoType(NoType t, Void p) {
return t.getKind() == VOID;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitPrimitive(PrimitiveType t, Void p) {
return true;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitArray(ArrayType t, Void p) {
return visit(t.getComponentType());
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Boolean defaultAction(TypeMirror e, Void p) {
return false;
}
@@ -672,7 +724,7 @@
return new SimpleTypeVisitor9<StringBuilder, Void>() {
final StringBuilder sb = new StringBuilder();
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public StringBuilder visitArray(ArrayType t, Void p) {
TypeMirror componentType = t.getComponentType();
visit(componentType);
@@ -680,7 +732,7 @@
return sb;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public StringBuilder visitDeclared(DeclaredType t, Void p) {
Element e = t.asElement();
sb.append(qualifiedName ? getFullyQualifiedName(e) : getSimpleName(e));
@@ -701,14 +753,14 @@
return sb;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public StringBuilder visitTypeVariable(javax.lang.model.type.TypeVariable t, Void p) {
Element e = t.asElement();
sb.append(qualifiedName ? getFullyQualifiedName(e, false) : getSimpleName(e));
return sb;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public StringBuilder visitWildcard(javax.lang.model.type.WildcardType t, Void p) {
sb.append("?");
TypeMirror upperBound = t.getExtendsBound();
@@ -724,7 +776,7 @@
return sb;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected StringBuilder defaultAction(TypeMirror e, Void p) {
return sb.append(e);
}
@@ -1122,17 +1174,17 @@
public TypeElement asTypeElement(TypeMirror t) {
return new SimpleTypeVisitor9<TypeElement, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public TypeElement visitDeclared(DeclaredType t, Void p) {
return (TypeElement) t.asElement();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public TypeElement visitArray(ArrayType t, Void p) {
return visit(t.getComponentType());
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public TypeElement visitTypeVariable(javax.lang.model.type.TypeVariable t, Void p) {
/*
* TODO: Check with JJG.
@@ -1145,17 +1197,17 @@
return visit(typeUtils.erasure(t));
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public TypeElement visitWildcard(javax.lang.model.type.WildcardType t, Void p) {
return visit(typeUtils.erasure(t));
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public TypeElement visitError(ErrorType t, Void p) {
return (TypeElement)t.asElement();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected TypeElement defaultAction(TypeMirror e, Void p) {
return super.defaultAction(e, p);
}
@@ -1179,13 +1231,13 @@
public String getDimension(TypeMirror t) {
return new SimpleTypeVisitor9<String, Void>() {
StringBuilder dimension = new StringBuilder("");
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitArray(ArrayType t, Void p) {
dimension.append("[]");
return visit(t.getComponentType());
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected String defaultAction(TypeMirror e, Void p) {
return dimension.toString();
}
@@ -1290,12 +1342,12 @@
public String getTypeName(TypeMirror t, boolean fullyQualified) {
return new SimpleTypeVisitor9<String, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitArray(ArrayType t, Void p) {
return visit(t.getComponentType());
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitDeclared(DeclaredType t, Void p) {
TypeElement te = asTypeElement(t);
return fullyQualified
@@ -1303,27 +1355,27 @@
: getSimpleName(te);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitExecutable(ExecutableType t, Void p) {
return t.toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitPrimitive(PrimitiveType t, Void p) {
return t.toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitTypeVariable(javax.lang.model.type.TypeVariable t, Void p) {
return getSimpleName(t.asElement());
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitWildcard(javax.lang.model.type.WildcardType t, Void p) {
return t.toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected String defaultAction(TypeMirror e, Void p) {
return e.toString();
}
@@ -1567,45 +1619,6 @@
return secondaryCollator.compare(s1, s2);
}
- public void copyDocFiles(Configuration configuration, Location locn, DocPath dir) {
- try {
- boolean first = true;
- for (DocFile f : DocFile.list(configuration, locn, dir)) {
- if (!f.isDirectory()) {
- continue;
- }
- DocFile srcdir = f;
- DocFile destdir = DocFile.createFileForOutput(configuration, dir);
- if (srcdir.isSameFile(destdir)) {
- continue;
- }
-
- for (DocFile srcfile: srcdir.list()) {
- DocFile destfile = destdir.resolve(srcfile.getName());
- if (srcfile.isFile()) {
- if (destfile.exists() && !first) {
- messages.warning("doclet.Copy_Overwrite_warning",
- srcfile.getPath(), destdir.getPath());
- } else {
- messages.notice("doclet.Copying_File_0_To_Dir_1",
- srcfile.getPath(), destdir.getPath());
- destfile.copyFile(srcfile);
- }
- } else if (srcfile.isDirectory()) {
- if (configuration.copydocfilesubdirs
- && !configuration.shouldExcludeDocFileDir(srcfile.getName())) {
- copyDocFiles(configuration, locn, dir.resolve(srcfile.getName()));
- }
- }
- }
-
- first = false;
- }
- } catch (SecurityException | IOException exc) {
- throw new DocletAbortException(exc);
- }
- }
-
private static class DocCollator {
private final Map<String, CollationKey> keys;
private final Collator instance;
@@ -1825,22 +1838,22 @@
*/
public String getQualifiedTypeName(TypeMirror t) {
return new SimpleTypeVisitor9<String, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitDeclared(DeclaredType t, Void p) {
return getFullyQualifiedName(t.asElement());
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitArray(ArrayType t, Void p) {
return visit(t.getComponentType());
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitPrimitive(PrimitiveType t, Void p) {
return t.toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitTypeVariable(javax.lang.model.type.TypeVariable t, Void p) {
// The knee jerk reaction is to do this but don't!, as we would like
// it to be compatible with the old world, now if we decide to do so
@@ -1849,7 +1862,7 @@
return t.toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected String defaultAction(TypeMirror e, Void p) {
throw new UnsupportedOperationException("should not happen");
}
@@ -1870,19 +1883,16 @@
public String getFullyQualifiedName(Element e, final boolean outer) {
return new SimpleElementVisitor9<String, Void>() {
@Override
- @DefinedBy(Api.LANGUAGE_MODEL)
public String visitPackage(PackageElement e, Void p) {
return e.getQualifiedName().toString();
}
@Override
- @DefinedBy(Api.LANGUAGE_MODEL)
public String visitType(TypeElement e, Void p) {
return e.getQualifiedName().toString();
}
@Override
- @DefinedBy(Api.LANGUAGE_MODEL)
protected String defaultAction(Element e, Void p) {
return outer ? visit(e.getEnclosingElement()) : e.getSimpleName().toString();
}
@@ -1987,15 +1997,15 @@
private String getTypeCode(TypeMirror t) {
return new SimpleTypeVisitor9<String, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitPrimitive(PrimitiveType t, Void p) {
return "P";
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitArray(ArrayType t, Void p) {
return visit(t.getComponentType());
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected String defaultAction(TypeMirror e, Void p) {
return "R";
}
@@ -2034,12 +2044,12 @@
}
boolean hasParameters(Element e) {
return new SimpleElementVisitor9<Boolean, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitExecutable(ExecutableElement e, Void p) {
return true;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Boolean defaultAction(Element e, Void p) {
return false;
}
@@ -2057,29 +2067,29 @@
*/
private String getFullyQualifiedName(Element e) {
return new SimpleElementVisitor9<String, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitModule(ModuleElement e, Void p) {
return e.getQualifiedName().toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitPackage(PackageElement e, Void p) {
return e.getQualifiedName().toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitExecutable(ExecutableElement e, Void p) {
// For backward compatibility
return getFullyQualifiedName(e.getEnclosingElement())
+ "." + e.getSimpleName().toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitType(TypeElement e, Void p) {
return e.getQualifiedName().toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected String defaultAction(Element e, Void p) {
return getEnclosingTypeElement(e).getQualifiedName().toString()
+ "." + e.getSimpleName().toString();
@@ -2319,13 +2329,13 @@
return elements;
return new SimpleElementVisitor9<List<Element>, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public List<Element> visitPackage(PackageElement e, Void p) {
recursiveGetItems(elements, e, filter, select);
return elements;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected List<Element> defaultAction(Element e0, Void p) {
return getItems0(e0, filter, select);
}
@@ -2387,12 +2397,12 @@
private String getSimpleName0(Element e) {
if (snvisitor == null) {
snvisitor = new SimpleElementVisitor9<String, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitModule(ModuleElement e, Void p) {
return e.getSimpleName().toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitType(TypeElement e, Void p) {
StringBuilder sb = new StringBuilder(e.getSimpleName());
Element enclosed = e.getEnclosingElement();
@@ -2404,7 +2414,7 @@
return sb.toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitExecutable(ExecutableElement e, Void p) {
if (e.getKind() == CONSTRUCTOR || e.getKind() == STATIC_INIT) {
return e.getEnclosingElement().getSimpleName().toString();
@@ -2412,7 +2422,7 @@
return e.getSimpleName().toString();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected String defaultAction(Element e, Void p) {
return e.getSimpleName().toString();
}
@@ -2457,27 +2467,27 @@
* and we should fix this by using getConstantValue and the visitor to
* address this in the future.
*/
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitPrimitiveAsBoolean(PrimitiveType t, Object val) {
return (int)val == 0 ? "false" : "true";
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitPrimitiveAsDouble(PrimitiveType t, Object val) {
return sourceForm(((Double)val), 'd');
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitPrimitiveAsFloat(PrimitiveType t, Object val) {
return sourceForm(((Float)val).doubleValue(), 'f');
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public String visitPrimitiveAsLong(PrimitiveType t, Object val) {
return val + "L";
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected String defaultAction(TypeMirror e, Object val) {
if (val == null)
return null;
@@ -2570,22 +2580,22 @@
public boolean isSpecified(Element e) {
if (specifiedVisitor == null) {
specifiedVisitor = new SimpleElementVisitor9<Boolean, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitModule(ModuleElement e, Void p) {
return configuration.getSpecifiedModules().contains(e);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitPackage(PackageElement e, Void p) {
return configuration.getSpecifiedPackages().contains(e);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitType(TypeElement e, Void p) {
return configuration.getSpecifiedClasses().contains(e);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Boolean defaultAction(Element e, Void p) {
return false;
}
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/links/LinkFactory.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/links/LinkFactory.java Tue Aug 30 08:45:21 2016 -0700
@@ -42,8 +42,6 @@
import jdk.javadoc.internal.doclets.formats.html.LinkInfoImpl;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
/**
* A factory that constructs links from given link information.
@@ -80,14 +78,14 @@
Content link = newContent();
// handles primitives, no types and error types
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
protected Content defaultAction(TypeMirror type, LinkInfo linkInfo) {
link.addContent(utils.getTypeName(type, false));
return link;
}
int currentDepth = 0;
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Content visitArray(ArrayType type, LinkInfo linkInfo) {
// keep track of the dimension depth and replace the last dimension
// specifier with vararags, when the stack is fully unwound.
@@ -109,7 +107,7 @@
return link;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Content visitWildcard(WildcardType type, LinkInfo linkInfo) {
linkInfo.isTypeBound = true;
link.addContent("?");
@@ -128,7 +126,7 @@
return link;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Content visitTypeVariable(TypeVariable type, LinkInfo linkInfo) {
link.addContent(getTypeAnnotationLinks(linkInfo));
linkInfo.isTypeBound = true;
@@ -169,7 +167,7 @@
return link;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Content visitDeclared(DeclaredType type, LinkInfo linkInfo) {
if (linkInfo.isTypeBound && linkInfo.excludeTypeBoundsLinks) {
// Since we are excluding type parameter links, we should not
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/ElementsTable.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/ElementsTable.java Tue Aug 30 08:45:21 2016 -0700
@@ -68,8 +68,6 @@
import com.sun.tools.javac.tree.JCTree.JCClassDecl;
import com.sun.tools.javac.tree.JCTree.JCCompilationUnit;
import com.sun.tools.javac.util.Context;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import com.sun.tools.javac.util.ListBuffer;
import com.sun.tools.javac.util.Name;
import com.sun.tools.javac.util.Names;
@@ -874,22 +872,22 @@
if (shouldDocumentVisitor == null) {
shouldDocumentVisitor = new SimpleElementVisitor9<Boolean, Void>() {
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitType(TypeElement e, Void p) {
return shouldDocument((ClassSymbol) e);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitVariable(VariableElement e, Void p) {
return shouldDocument((VarSymbol) e);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitExecutable(ExecutableElement e, Void p) {
return shouldDocument((MethodSymbol) e);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitPackage(PackageElement e, Void p) {
return accessFilter.checkModifier(e);
}
@@ -947,19 +945,19 @@
includedCache = new LinkedHashSet<>();
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitModule(ModuleElement e, Void p) {
// deduced by specified and/or requires expansion
return includedModuleElements.contains(e);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitPackage(PackageElement e, Void p) {
// deduced by specified or downward expansions
return includedPackageElements.contains(e);
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitType(TypeElement e, Void p) {
if (includedTypeElements.contains(e)) {
return true;
@@ -988,7 +986,7 @@
}
// members
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean defaultAction(Element e, Void p) {
if (includedCache.contains(e))
return true;
@@ -1006,7 +1004,7 @@
return false;
}
- @Override @DefinedBy(Api.LANGUAGE_MODEL)
+ @Override
public Boolean visitUnknown(Element e, Void p) {
throw new AssertionError("unknown element: " + e);
}
--- a/langtools/src/jdk.jdeps/share/classes/com/sun/tools/javap/JavapTask.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/javap/JavapTask.java Tue Aug 30 08:45:21 2016 -0700
@@ -68,8 +68,6 @@
import javax.tools.StandardLocation;
import com.sun.tools.classfile.*;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
/**
* "Main" class for javap, normally accessed from the command line
@@ -411,7 +409,6 @@
private DiagnosticListener<JavaFileObject> getDiagnosticListenerForWriter(Writer w) {
final PrintWriter pw = getPrintWriterForWriter(w);
return new DiagnosticListener<JavaFileObject> () {
- @DefinedBy(Api.COMPILER)
public void report(Diagnostic<? extends JavaFileObject> diagnostic) {
switch (diagnostic.getKind()) {
case ERROR:
@@ -727,67 +724,54 @@
final URLConnection conn = url.openConnection();
conn.setUseCaches(false);
return new JavaFileObject() {
- @DefinedBy(Api.COMPILER)
public Kind getKind() {
return JavaFileObject.Kind.CLASS;
}
- @DefinedBy(Api.COMPILER)
public boolean isNameCompatible(String simpleName, Kind kind) {
throw new UnsupportedOperationException();
}
- @DefinedBy(Api.COMPILER)
public NestingKind getNestingKind() {
throw new UnsupportedOperationException();
}
- @DefinedBy(Api.COMPILER)
public Modifier getAccessLevel() {
throw new UnsupportedOperationException();
}
- @DefinedBy(Api.COMPILER)
public URI toUri() {
return uri;
}
- @DefinedBy(Api.COMPILER)
public String getName() {
return uri.toString();
}
- @DefinedBy(Api.COMPILER)
public InputStream openInputStream() throws IOException {
return conn.getInputStream();
}
- @DefinedBy(Api.COMPILER)
public OutputStream openOutputStream() throws IOException {
throw new UnsupportedOperationException();
}
- @DefinedBy(Api.COMPILER)
public Reader openReader(boolean ignoreEncodingErrors) throws IOException {
throw new UnsupportedOperationException();
}
- @DefinedBy(Api.COMPILER)
public CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException {
throw new UnsupportedOperationException();
}
- @DefinedBy(Api.COMPILER)
public Writer openWriter() throws IOException {
throw new UnsupportedOperationException();
}
- @DefinedBy(Api.COMPILER)
public long getLastModified() {
return conn.getLastModified();
}
- @DefinedBy(Api.COMPILER)
public boolean delete() {
throw new UnsupportedOperationException();
}
@@ -1015,47 +999,38 @@
private Diagnostic<JavaFileObject> createDiagnostic(
final Diagnostic.Kind kind, final String key, final Object... args) {
return new Diagnostic<JavaFileObject>() {
- @DefinedBy(Api.COMPILER)
public Kind getKind() {
return kind;
}
- @DefinedBy(Api.COMPILER)
public JavaFileObject getSource() {
return null;
}
- @DefinedBy(Api.COMPILER)
public long getPosition() {
return Diagnostic.NOPOS;
}
- @DefinedBy(Api.COMPILER)
public long getStartPosition() {
return Diagnostic.NOPOS;
}
- @DefinedBy(Api.COMPILER)
public long getEndPosition() {
return Diagnostic.NOPOS;
}
- @DefinedBy(Api.COMPILER)
public long getLineNumber() {
return Diagnostic.NOPOS;
}
- @DefinedBy(Api.COMPILER)
public long getColumnNumber() {
return Diagnostic.NOPOS;
}
- @DefinedBy(Api.COMPILER)
public String getCode() {
return key;
}
- @DefinedBy(Api.COMPILER)
public String getMessage(Locale locale) {
return JavapTask.this.getMessage(locale, key, args);
}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/CSV.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,147 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan;
+
+import java.io.PrintStream;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+
+/**
+ * Utility class for manipulating comma-separated-value (CSV) data.
+ */
+public class CSV {
+ static String quote(String input) {
+ String result;
+ boolean needQuote = input.contains(",");
+
+ if (input.contains("\"")) {
+ needQuote = true;
+ result = input.replace("\"", "\"\"");
+ } else {
+ result = input;
+ }
+
+ if (needQuote) {
+ return "\"" + result + "\"";
+ } else {
+ return result;
+ }
+ }
+
+ /**
+ * Writes the objects' string representations to the output as a line of CSV.
+ * The objects are converted to String, quoted if necessary, joined with commas,
+ * and are written to the output followed by the line separator string.
+ *
+ * @param out the output destination
+ * @param objs the objects to write
+ */
+ public static void write(PrintStream out, Object... objs) {
+ out.println(Arrays.stream(objs)
+ .map(Object::toString)
+ .map(CSV::quote)
+ .collect(Collectors.joining(",")));
+ }
+
+ /**
+ * The CSV parser state.
+ */
+ enum State {
+ START_FIELD, // the start of a field
+ IN_FIELD, // within an unquoted field
+ IN_QFIELD, // within a quoted field
+ END_QFIELD // after the end of a quoted field
+ }
+
+ /**
+ * Splits an input line into a list of strings, handling quoting.
+ *
+ * @param input the input line
+ * @return the resulting list of strings
+ */
+ public static List<String> split(String input) {
+ List<String> result = new ArrayList<>();
+ StringBuilder cur = new StringBuilder();
+ State state = State.START_FIELD;
+
+ for (int i = 0; i < input.length(); i++) {
+ char ch = input.charAt(i);
+ switch (ch) {
+ case ',':
+ switch (state) {
+ case IN_QFIELD:
+ cur.append(',');
+ break;
+ default:
+ result.add(cur.toString());
+ cur.setLength(0);
+ state = State.START_FIELD;
+ break;
+ }
+ break;
+ case '"':
+ switch (state) {
+ case START_FIELD:
+ state = State.IN_QFIELD;
+ break;
+ case IN_QFIELD:
+ state = State.END_QFIELD;
+ break;
+ case IN_FIELD:
+ throw new CSVParseException("unexpected quote", input, i);
+ case END_QFIELD:
+ cur.append('"');
+ state = State.IN_QFIELD;
+ break;
+ }
+ break;
+ default:
+ switch (state) {
+ case START_FIELD:
+ state = State.IN_FIELD;
+ break;
+ case IN_FIELD:
+ case IN_QFIELD:
+ break;
+ case END_QFIELD:
+ throw new CSVParseException("extra character after quoted string",
+ input, i);
+ }
+ cur.append(ch);
+ break;
+ }
+ }
+
+ if (state == State.IN_QFIELD) {
+ throw new CSVParseException("unclosed quote", input, input.length());
+ }
+
+ result.add(cur.toString());
+ return result;
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/CSVParseException.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan;
+
+/**
+ * Exception representing an error encountered during CSV parsing.
+ */
+public class CSVParseException extends IllegalArgumentException {
+ private static final long serialVersionUID = 6822670269555409371L;
+ final String input;
+ final int index;
+
+ public CSVParseException(String msg, String input, int index) {
+ super(msg);
+ this.input = input;
+ this.index = index;
+ }
+
+ public String getInput() { return input; }
+
+ public int getIndex() { return index; }
+
+ /**
+ * Returns a string describing the parse error.
+ *
+ * @return a string describing the parse error
+ */
+ @Override
+ public String getMessage() {
+ return super.getMessage() + " at index " + index + ": " + input;
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/DeprDB.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,178 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Formatter;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Set;
+
+import javax.lang.model.element.ElementKind;
+
+/**
+ * A database of deprecations (APIs declared to be deprecated),
+ * loaded from a JDK or from a class library.
+ */
+public class DeprDB {
+ /**
+ * Deprecated types.
+ * A map from deprecated type names to DeprData values.
+ * Types include classes, interfaces, enums, and annotation types.
+ */
+ final Map<String, DeprData> types = new HashMap<>();
+
+ /**
+ * Deprecated methods. Key is type name, value is map from method
+ * signatures in the form "methodname(parms)ret" to DeprData value.
+ */
+ final Map<String, Map<String, DeprData>> methods = new HashMap<>();
+
+ /**
+ * Deprecated fields. Key is type name, value is map from field name
+ * to forRemoval value.
+ */
+ final Map<String, Map<String, DeprData>> fields = new HashMap<>();
+
+ /**
+ * Set of valid ElementKind strings.
+ */
+ static final Set<String> validElementKinds =
+ Set.of(Arrays.stream(ElementKind.values())
+ .map(ElementKind::toString)
+ .toArray(String[]::new));
+
+
+ private DeprDB() { }
+
+ public static List<DeprData> loadFromFile(String filename) throws IOException {
+ List<DeprData> list = new ArrayList<>();
+
+ exit:
+ try (final BufferedReader br = Files.newBufferedReader(Paths.get(filename))) {
+ String line = br.readLine();
+ if (line == null || !line.equals("#jdepr1")) {
+ System.out.printf("ERROR: invalid first line %s%n", line);
+ break exit;
+ }
+ while ((line = br.readLine()) != null) {
+ if (line.startsWith("#")) {
+ continue;
+ }
+ List<String> tokens = CSV.split(line);
+ if (tokens.size() != 5) {
+ System.out.printf("ERROR: %s%n", line);
+ continue;
+ }
+ // kind,typeName,descOrName,since,forRemoval
+ String kindStr = tokens.get(0);
+ String type = tokens.get(1);
+ String detail = tokens.get(2);
+ String since = tokens.get(3);
+ boolean forRemoval = Boolean.parseBoolean(tokens.get(4));
+ ElementKind kind;
+
+ if (validElementKinds.contains(kindStr)) {
+ kind = ElementKind.valueOf(kindStr);
+ } else {
+ System.out.printf("ERROR: invalid element kind %s%n", kindStr);
+ continue;
+ }
+
+ DeprData data = new DeprData(kind, /*TypeElement*/null, type, detail, since, forRemoval);
+ list.add(data);
+ }
+ }
+ return list;
+ }
+
+ public static DeprDB loadFromList(List<DeprData> deprList) {
+ DeprDB db = new DeprDB();
+
+ for (DeprData dd : deprList) {
+ switch (dd.kind) {
+ case CLASS:
+ case INTERFACE:
+ case ENUM:
+ case ANNOTATION_TYPE:
+ db.types.put(dd.typeName, dd);
+ break;
+ case METHOD:
+ case CONSTRUCTOR:
+ db.methods.computeIfAbsent(dd.typeName, k -> new HashMap<>())
+ .put(dd.nameSig, dd);
+ break;
+ case ENUM_CONSTANT:
+ case FIELD:
+ db.fields.computeIfAbsent(dd.typeName, k -> new HashMap<>())
+ .put(dd.nameSig, dd);
+ break;
+ }
+ }
+
+ return db;
+ }
+
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ Formatter f = new Formatter(sb, Locale.US);
+ f.format("=== Types ===%n");
+ f.format("%s%n", types.toString());
+ f.format("=== Methods ===%n");
+ f.format("%s%n", methods.toString());
+ f.format("=== Fields ===%n");
+ f.format("%s%n", fields.toString());
+ return sb.toString();
+ }
+
+ public DeprData getTypeDeprecated(String typeName) {
+ return types.get(typeName);
+ }
+
+ public DeprData getMethodDeprecated(String typeName, String methodName, String type) {
+ Map<String, DeprData> m = methods.get(typeName);
+ if (m == null) {
+ return null;
+ }
+ return m.get(methodName + type);
+ }
+
+ public DeprData getFieldDeprecated(String typeName, String fieldName) {
+ Map<String, DeprData> f = fields.get(typeName);
+ if (f == null) {
+ return null;
+ }
+ return f.get(fieldName);
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/DeprData.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan;
+
+import javax.lang.model.element.ElementKind;
+import javax.lang.model.element.TypeElement;
+
+/**
+ * A simple data class that contains language model data (TypeElement, etc.)
+ * about a deprecated API.
+ */
+public class DeprData {
+ final ElementKind kind;
+ final TypeElement type; // null if data loaded from file
+ final String typeName;
+ final String nameSig;
+ final String since;
+ final boolean forRemoval;
+
+ public DeprData(ElementKind kind, TypeElement type, String typeName, String nameSig,
+ String since, boolean forRemoval) {
+ this.kind = kind;
+ this.type = type;
+ this.typeName = typeName;
+ this.nameSig = nameSig;
+ this.since = since;
+ this.forRemoval = forRemoval;
+ }
+
+ public boolean isForRemoval() {
+ return forRemoval;
+ }
+
+ @Override
+ public String toString() {
+ return String.format("DeprData(%s,%s,%s,%s,%s,%s)",
+ kind, type, typeName, nameSig, since, forRemoval);
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/LoadProc.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,206 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan;
+
+import java.lang.annotation.IncompleteAnnotationException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import javax.annotation.processing.AbstractProcessor;
+import javax.annotation.processing.Messager;
+import javax.annotation.processing.ProcessingEnvironment;
+import javax.annotation.processing.RoundEnvironment;
+import javax.annotation.processing.SupportedAnnotationTypes;
+import javax.annotation.processing.SupportedSourceVersion;
+
+import javax.lang.model.element.Element;
+import javax.lang.model.element.ElementKind;
+import javax.lang.model.element.ExecutableElement;
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.type.ArrayType;
+import javax.lang.model.type.DeclaredType;
+import javax.lang.model.type.ExecutableType;
+import javax.lang.model.type.TypeMirror;
+import javax.lang.model.util.Elements;
+
+import javax.tools.Diagnostic;
+
+import static javax.lang.model.SourceVersion.RELEASE_9;
+
+/**
+ * Annotation processor for the Deprecation Scanner tool.
+ * Examines APIs for deprecated elements and records information
+ *
+ */
+@SupportedAnnotationTypes("java.lang.Deprecated")
+@SupportedSourceVersion(RELEASE_9)
+public class LoadProc extends AbstractProcessor {
+ Elements elements;
+ Messager messager;
+ final List<DeprData> deprList = new ArrayList<>();
+
+ public LoadProc() {
+ }
+
+ @Override
+ public void init(ProcessingEnvironment pe) {
+ super.init(pe);
+ elements = pe.getElementUtils();
+ messager = pe.getMessager();
+ }
+
+ @Override
+ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
+ if (roundEnv.processingOver()) {
+ return false;
+ }
+
+ // Assume annotations contains only @Deprecated.
+ // Note: no way to get deprecated packages, since
+ // @Deprecated is ignored in package-info.java files.
+
+ Set<? extends Element> set = roundEnv.getElementsAnnotatedWith(Deprecated.class);
+ for (Element e : set) {
+ ElementKind kind = e.getKind();
+ Deprecated depr = e.getAnnotation(Deprecated.class);
+ switch (kind) {
+ case CLASS:
+ case INTERFACE:
+ case ENUM:
+ case ANNOTATION_TYPE:
+ addType(kind, (TypeElement)e, depr);
+ break;
+ case CONSTRUCTOR:
+ case ENUM_CONSTANT:
+ case FIELD:
+ case METHOD:
+ Element encl = e.getEnclosingElement();
+ ElementKind enclKind = encl.getKind();
+ switch (enclKind) {
+ case CLASS:
+ case INTERFACE:
+ case ENUM:
+ case ANNOTATION_TYPE:
+ String detail = getDetail(e);
+ addMember(kind, (TypeElement)encl, detail, depr);
+ break;
+ default:
+ messager.printMessage(Diagnostic.Kind.WARNING,
+ "element " + e +
+ " within unknown enclosing element " + encl +
+ " of kind " + enclKind, e);
+ break;
+ }
+ break;
+ default:
+ messager.printMessage(Diagnostic.Kind.WARNING,
+ "unknown element " + e +
+ " of kind " + kind +
+ " within " + e.getEnclosingElement(), e);
+ break;
+ }
+ }
+ return true;
+ }
+
+ public List<DeprData> getDeprecations() {
+ return deprList;
+ }
+
+ String getDetail(Element e) {
+ if (e.getKind().isField()) {
+ return e.getSimpleName().toString();
+ } else {
+ // method or constructor
+ ExecutableElement ee = (ExecutableElement) e;
+ String ret;
+ ret = desc(ee.getReturnType());
+ List<? extends TypeMirror> parameterTypes = ((ExecutableType)ee.asType()).getParameterTypes();
+ String parms = parameterTypes.stream()
+ .map(this::desc)
+ .collect(Collectors.joining());
+ return ee.getSimpleName().toString() + "(" + parms + ")" + ret;
+ }
+ }
+
+ String desc(TypeMirror tm) {
+ switch (tm.getKind()) {
+ case BOOLEAN:
+ return "Z";
+ case BYTE:
+ return "B";
+ case SHORT:
+ return "S";
+ case CHAR:
+ return "C";
+ case INT:
+ return "I";
+ case LONG:
+ return "J";
+ case FLOAT:
+ return "F";
+ case DOUBLE:
+ return "D";
+ case VOID:
+ return "V";
+ case DECLARED:
+ String s =
+ ((TypeElement)((DeclaredType)tm).asElement()).getQualifiedName().toString();
+ s = s.replace('.', '/');
+ return "L" + s + ";";
+ case ARRAY:
+ return "[" + desc(((ArrayType)tm).getComponentType());
+ default:
+ return tm.getKind().toString();
+ }
+ }
+
+ void addType(ElementKind kind, TypeElement type, Deprecated dep) {
+ addData(kind, type, "", dep);
+ }
+
+ void addMember(ElementKind kind, TypeElement type, String nameSig, Deprecated dep) {
+ addData(kind, type, nameSig, dep);
+ }
+
+ void addData(ElementKind kind, TypeElement type, String nameSig, Deprecated dep) {
+ String typeName = elements.getBinaryName(type).toString().replace('.', '/');
+
+ String since = "";
+ try {
+ since = dep.since();
+ } catch (IncompleteAnnotationException ignore) { }
+
+ boolean forRemoval = false;
+ try {
+ forRemoval = dep.forRemoval();
+ } catch (IncompleteAnnotationException ignore) { }
+
+ deprList.add(new DeprData(kind, type, typeName, nameSig, since, forRemoval));
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/Main.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,717 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.PrintStream;
+import java.net.URI;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.FileSystems;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.ArrayDeque;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.NoSuchElementException;
+import java.util.Set;
+import java.util.Queue;
+import java.util.stream.Stream;
+import java.util.jar.JarEntry;
+import java.util.jar.JarFile;
+
+import javax.tools.Diagnostic;
+import javax.tools.DiagnosticListener;
+import javax.tools.JavaCompiler;
+import javax.tools.JavaFileObject;
+import javax.tools.StandardJavaFileManager;
+import javax.tools.StandardLocation;
+import javax.tools.ToolProvider;
+
+import com.sun.tools.javac.file.JavacFileManager;
+
+import com.sun.tools.jdeprscan.scan.Scan;
+
+import static java.util.stream.Collectors.*;
+
+import javax.lang.model.element.PackageElement;
+import javax.lang.model.element.TypeElement;
+
+/**
+ * Deprecation Scanner tool. Loads API deprecation information from the
+ * JDK image, or optionally, from a jar file or class hierarchy. Then scans
+ * a class library for usages of those APIs.
+ *
+ * TODO:
+ * - audit error handling throughout, but mainly in scan package
+ * - handling of covariant overrides
+ * - handling of override of method found in multiple superinterfaces
+ * - convert type/method/field output to Java source like syntax, e.g.
+ * instead of java/lang/Runtime.runFinalizersOnExit(Z)V
+ * print void java.lang.Runtime.runFinalizersOnExit(boolean)
+ * - more example output in man page
+ * - more rigorous GNU style option parsing; use joptsimple?
+ *
+ * FUTURES:
+ * - add module support: -addmods, -modulepath, module arg
+ * - load deprecation declarations from a designated class library instead
+ * of the JDK
+ * - load deprecation declarations from a module
+ * - scan a module (but a modular jar can be treated just a like an ordinary jar)
+ * - multi-version jar
+ */
+public class Main implements DiagnosticListener<JavaFileObject> {
+ public static Main instance;
+
+ final PrintStream out;
+ final PrintStream err;
+ final List<File> bootClassPath = new ArrayList<>();
+ final List<File> classPath = new ArrayList<>();
+ final List<File> systemModules = new ArrayList<>();
+ final List<String> options = new ArrayList<>();
+ final List<String> comments = new ArrayList<>();
+
+ // Valid releases need to match what the compiler supports.
+ // Keep these updated manually until there's a compiler API
+ // that allows querying of supported releases.
+ final Set<String> releasesWithoutForRemoval = Set.of("6", "7", "8");
+ final Set<String> releasesWithForRemoval = Set.of("9");
+
+ final Set<String> validReleases;
+ {
+ Set<String> temp = new HashSet<>(releasesWithoutForRemoval);
+ temp.addAll(releasesWithForRemoval);
+ validReleases = Set.of(temp.toArray(new String[0]));
+ }
+
+ boolean verbose = false;
+ boolean forRemoval = false;
+
+ final JavaCompiler compiler;
+ final StandardJavaFileManager fm;
+
+ List<DeprData> deprList; // non-null after successful load phase
+
+ /**
+ * Processes a collection of class names. Names should fully qualified
+ * names in the form "pkg.pkg.pkg.classname".
+ *
+ * @param classNames collection of fully qualified classnames to process
+ * @return true for success, false for failure
+ * @throws IOException if an I/O error occurs
+ */
+ boolean doClassNames(Collection<String> classNames) throws IOException {
+ if (verbose) {
+ out.println("List of classes to process:");
+ classNames.forEach(out::println);
+ out.println("End of class list.");
+ }
+
+ // TODO: not sure this is necessary...
+ if (fm instanceof JavacFileManager) {
+ ((JavacFileManager)fm).setSymbolFileEnabled(false);
+ }
+
+ fm.setLocation(StandardLocation.CLASS_PATH, classPath);
+ if (!bootClassPath.isEmpty()) {
+ fm.setLocation(StandardLocation.PLATFORM_CLASS_PATH, bootClassPath);
+ }
+
+ if (!systemModules.isEmpty()) {
+ fm.setLocation(StandardLocation.SYSTEM_MODULES, systemModules);
+ }
+
+ LoadProc proc = new LoadProc();
+ JavaCompiler.CompilationTask task =
+ compiler.getTask(null, fm, this, options, classNames, null);
+ task.setProcessors(List.of(proc));
+ boolean r = task.call();
+ if (r) {
+ if (forRemoval) {
+ deprList = proc.getDeprecations().stream()
+ .filter(DeprData::isForRemoval)
+ .collect(toList());
+ } else {
+ deprList = proc.getDeprecations();
+ }
+ }
+ return r;
+ }
+
+ /**
+ * Processes a stream of filenames (strings). The strings are in the
+ * form pkg/pkg/pkg/classname.class relative to the root of a package
+ * hierarchy.
+ *
+ * @param filenames a Stream of filenames to process
+ * @return true for success, false for failure
+ * @throws IOException if an I/O error occurs
+ */
+ boolean doFileNames(Stream<String> filenames) throws IOException {
+ return doClassNames(
+ filenames.filter(name -> name.endsWith(".class"))
+ .filter(name -> !name.endsWith("package-info.class"))
+ .filter(name -> !name.endsWith("module-info.class"))
+ .map(s -> s.replaceAll("\\.class$", ""))
+ .map(s -> s.replace('/', '.'))
+ .collect(toList()));
+ }
+
+ /**
+ * Replaces all but the first occurrence of '/' with '.'. Assumes
+ * that the name is in the format module/pkg/pkg/classname.class.
+ * That is, the name should contain at least one '/' character
+ * separating the module name from the package-class name.
+ *
+ * @param filename the input filename
+ * @return the modular classname
+ */
+ String convertModularFileName(String filename) {
+ int slash = filename.indexOf('/');
+ return filename.substring(0, slash)
+ + "/"
+ + filename.substring(slash+1).replace('/', '.');
+ }
+
+ /**
+ * Processes a stream of filenames (strings) including a module prefix.
+ * The strings are in the form module/pkg/pkg/pkg/classname.class relative
+ * to the root of a directory containing modules. The strings are processed
+ * into module-qualified class names of the form
+ * "module/pkg.pkg.pkg.classname".
+ *
+ * @param filenames a Stream of filenames to process
+ * @return true for success, false for failure
+ * @throws IOException if an I/O error occurs
+ */
+ boolean doModularFileNames(Stream<String> filenames) throws IOException {
+ return doClassNames(
+ filenames.filter(name -> name.endsWith(".class"))
+ .filter(name -> !name.endsWith("package-info.class"))
+ .filter(name -> !name.endsWith("module-info.class"))
+ .map(s -> s.replaceAll("\\.class$", ""))
+ .map(this::convertModularFileName)
+ .collect(toList()));
+ }
+
+ /**
+ * Processes named class files in the given directory. The directory
+ * should be the root of a package hierarchy. If classNames is
+ * empty, walks the directory hierarchy to find all classes.
+ *
+ * @param dirname the name of the directory to process
+ * @param classNames the names of classes to process
+ * @return true for success, false for failure
+ * @throws IOException if an I/O error occurs
+ */
+ boolean processDirectory(String dirname, Collection<String> classNames) throws IOException {
+ if (!Files.isDirectory(Paths.get(dirname))) {
+ err.printf("%s: not a directory%n", dirname);
+ return false;
+ }
+
+ classPath.add(0, new File(dirname));
+
+ if (classNames.isEmpty()) {
+ Path base = Paths.get(dirname);
+ int baseCount = base.getNameCount();
+ try (Stream<Path> paths = Files.walk(base)) {
+ Stream<String> files =
+ paths.filter(p -> p.getNameCount() > baseCount)
+ .map(p -> p.subpath(baseCount, p.getNameCount()))
+ .map(Path::toString);
+ return doFileNames(files);
+ }
+ } else {
+ return doClassNames(classNames);
+ }
+ }
+
+ /**
+ * Processes all class files in the given jar file.
+ *
+ * @param jarname the name of the jar file to process
+ * @return true for success, false for failure
+ * @throws IOException if an I/O error occurs
+ */
+ boolean doJarFile(String jarname) throws IOException {
+ try (JarFile jf = new JarFile(jarname)) {
+ Stream<String> files =
+ jf.stream()
+ .map(JarEntry::getName);
+ return doFileNames(files);
+ }
+ }
+
+ /**
+ * Processes named class files from the given jar file,
+ * or all classes if classNames is empty.
+ *
+ * @param jarname the name of the jar file to process
+ * @param classNames the names of classes to process
+ * @return true for success, false for failure
+ * @throws IOException if an I/O error occurs
+ */
+ boolean processJarFile(String jarname, Collection<String> classNames) throws IOException {
+ classPath.add(0, new File(jarname));
+
+ if (classNames.isEmpty()) {
+ return doJarFile(jarname);
+ } else {
+ return doClassNames(classNames);
+ }
+ }
+
+ /**
+ * Processes named class files from rt.jar of a JDK version 7 or 8.
+ * If classNames is empty, processes all classes.
+ *
+ * @param jdkHome the path to the "home" of the JDK to process
+ * @param classNames the names of classes to process
+ * @return true for success, false for failure
+ * @throws IOException if an I/O error occurs
+ */
+ boolean processOldJdk(String jdkHome, Collection<String> classNames) throws IOException {
+ String RTJAR = jdkHome + "/jre/lib/rt.jar";
+ String CSJAR = jdkHome + "/jre/lib/charsets.jar";
+
+ bootClassPath.add(0, new File(RTJAR));
+ bootClassPath.add(1, new File(CSJAR));
+ options.add("-source");
+ options.add("8");
+
+ if (classNames.isEmpty()) {
+ return doJarFile(RTJAR);
+ } else {
+ return doClassNames(classNames);
+ }
+ }
+
+ /**
+ * Processes listed classes given a JDK 9 home.
+ */
+ boolean processJdk9(String jdkHome, Collection<String> classes) throws IOException {
+ systemModules.add(new File(jdkHome));
+ return doClassNames(classes);
+ }
+
+ /**
+ * Processes the class files from the currently running JDK,
+ * using the jrt: filesystem.
+ *
+ * @return true for success, false for failure
+ * @throws IOException if an I/O error occurs
+ */
+ boolean processSelf(Collection<String> classes) throws IOException {
+ options.add("-addmods");
+ options.add("java.se.ee,jdk.xml.bind"); // TODO why jdk.xml.bind?
+
+ if (classes.isEmpty()) {
+ Path modules = FileSystems.getFileSystem(URI.create("jrt:/"))
+ .getPath("/modules");
+
+ // names are /modules/<modulename>/pkg/.../Classname.class
+ try (Stream<Path> paths = Files.walk(modules)) {
+ Stream<String> files =
+ paths.filter(p -> p.getNameCount() > 2)
+ .map(p -> p.subpath(1, p.getNameCount()))
+ .map(Path::toString);
+ return doModularFileNames(files);
+ }
+ } else {
+ return doClassNames(classes);
+ }
+ }
+
+ /**
+ * Process classes from a particular JDK release, using only information
+ * in this JDK.
+ *
+ * @param release "6", "7", "8", or "9"
+ * @param classes collection of classes to process, may be empty
+ * @return success value
+ */
+ boolean processRelease(String release, Collection<String> classes) throws IOException {
+ options.addAll(List.of("-release", release));
+
+ if (release.equals("9")) {
+ List<String> rootMods = List.of("java.se", "java.se.ee");
+ TraverseProc proc = new TraverseProc(rootMods);
+ JavaCompiler.CompilationTask task =
+ compiler.getTask(null, fm, this,
+ // options
+ List.of("-addmods", String.join(",", rootMods)),
+ // classes
+ List.of("java.lang.Object"),
+ null);
+ task.setProcessors(List.of(proc));
+ if (!task.call()) {
+ return false;
+ }
+ Map<PackageElement, List<TypeElement>> types = proc.getPublicTypes();
+ options.add("-addmods");
+ options.add(String.join(",", rootMods));
+ return doClassNames(
+ types.values().stream()
+ .flatMap(List::stream)
+ .map(TypeElement::toString)
+ .collect(toList()));
+ } else {
+ // TODO: kind of a hack...
+ // Create a throwaway compilation task with options "-release N"
+ // which has the side effect of setting the file manager's
+ // PLATFORM_CLASS_PATH to the right value.
+ JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
+ StandardJavaFileManager fm =
+ compiler.getStandardFileManager(this, null, StandardCharsets.UTF_8);
+ JavaCompiler.CompilationTask task =
+ compiler.getTask(null, fm, this, List.of("-release", release), null, null);
+ List<Path> paths = new ArrayList<>();
+ for (Path p : fm.getLocationAsPaths(StandardLocation.PLATFORM_CLASS_PATH)) {
+ try (Stream<Path> str = Files.walk(p)) {
+ str.forEachOrdered(paths::add);
+ }
+ }
+
+ options.add("-Xlint:-options");
+
+ return doClassNames(
+ paths.stream()
+ .filter(path -> path.toString().endsWith(".sig"))
+ .map(path -> path.subpath(1, path.getNameCount()))
+ .map(Path::toString)
+ .map(s -> s.replaceAll("\\.sig$", ""))
+ .map(s -> s.replace('/', '.'))
+ .collect(toList()));
+ }
+ }
+
+ /**
+ * Prints a usage message to the err stream.
+ */
+ void usage() {
+
+ }
+
+ /**
+ * An enum denoting the mode in which the tool is running.
+ * Different modes correspond to the different process* methods.
+ * The exception is UNKNOWN, which indicates that a mode wasn't
+ * specified on the command line, which is an error.
+ */
+ static enum LoadMode {
+ CLASSES, DIR, JAR, OLD_JDK, JDK9, SELF, RELEASE, LOAD_CSV
+ }
+
+ static enum ScanMode {
+ ARGS, LIST, PRINT_CSV
+ }
+
+ /**
+ * A checked exception that's thrown if a command-line syntax error
+ * is detected.
+ */
+ static class UsageException extends Exception {
+ private static final long serialVersionUID = 3611828659572908743L;
+ }
+
+ /**
+ * Convenience method to throw UsageException if a condition is false.
+ *
+ * @param cond the condition that's required to be true
+ * @throws UsageException
+ */
+ void require(boolean cond) throws UsageException {
+ if (!cond) {
+ throw new UsageException();
+ }
+ }
+
+ /**
+ * Constructs an instance of the finder tool.
+ *
+ * @param out the stream to which the tool's output is sent
+ * @param err the stream to which error messages are sent
+ */
+ Main(PrintStream out, PrintStream err) {
+ this.out = out;
+ this.err = err;
+ compiler = ToolProvider.getSystemJavaCompiler();
+ fm = compiler.getStandardFileManager(this, null, StandardCharsets.UTF_8);
+ }
+
+ /**
+ * Prints the diagnostic to the err stream.
+ *
+ * Specified by the DiagnosticListener interface.
+ *
+ * @param diagnostic the tool diagnostic to print
+ */
+ @Override
+ public void report(Diagnostic<? extends JavaFileObject> diagnostic) {
+ err.println(diagnostic);
+ }
+
+ /**
+ * Parses arguments and performs the requested processing.
+ *
+ * @param argArray command-line arguments
+ * @return true on success, false on error
+ */
+ boolean run(String... argArray) {
+ Queue<String> args = new ArrayDeque<>(Arrays.asList(argArray));
+ LoadMode loadMode = LoadMode.RELEASE;
+ ScanMode scanMode = ScanMode.ARGS;
+ String dir = null;
+ String jar = null;
+ String jdkHome = null;
+ String release = "9";
+ List<String> loadClasses = new ArrayList<>();
+ String csvFile = null;
+
+ try {
+ while (!args.isEmpty()) {
+ String a = args.element();
+ if (a.startsWith("-")) {
+ args.remove();
+ switch (a) {
+ case "--class-path":
+ case "-cp":
+ classPath.clear();
+ Arrays.stream(args.remove().split(File.pathSeparator))
+ .map(File::new)
+ .forEachOrdered(classPath::add);
+ break;
+ case "--for-removal":
+ forRemoval = true;
+ break;
+ case "--full-version":
+ out.println(System.getProperty("java.vm.version"));
+ return false;
+ case "--help":
+ case "-h":
+ out.println(Messages.get("main.usage"));
+ out.println();
+ out.println(Messages.get("main.help"));
+ return false;
+ case "-l":
+ case "--list":
+ require(scanMode == ScanMode.ARGS);
+ scanMode = ScanMode.LIST;
+ break;
+ case "--release":
+ loadMode = LoadMode.RELEASE;
+ release = args.remove();
+ if (!validReleases.contains(release)) {
+ throw new UsageException();
+ }
+ break;
+ case "-v":
+ case "--verbose":
+ verbose = true;
+ break;
+ case "--version":
+ out.println(System.getProperty("java.version"));
+ return false;
+ case "--Xcompiler-arg":
+ options.add(args.remove());
+ break;
+ case "--Xcsv-comment":
+ comments.add(args.remove());
+ break;
+ case "--Xhelp":
+ out.println(Messages.get("main.xhelp"));
+ return false;
+ case "--Xload-class":
+ loadMode = LoadMode.CLASSES;
+ loadClasses.add(args.remove());
+ break;
+ case "--Xload-csv":
+ loadMode = LoadMode.LOAD_CSV;
+ csvFile = args.remove();
+ break;
+ case "--Xload-dir":
+ loadMode = LoadMode.DIR;
+ dir = args.remove();
+ break;
+ case "--Xload-jar":
+ loadMode = LoadMode.JAR;
+ jar = args.remove();
+ break;
+ case "--Xload-jdk9":
+ loadMode = LoadMode.JDK9;
+ jdkHome = args.remove();
+ break;
+ case "--Xload-old-jdk":
+ loadMode = LoadMode.OLD_JDK;
+ jdkHome = args.remove();
+ break;
+ case "--Xload-self":
+ loadMode = LoadMode.SELF;
+ break;
+ case "--Xprint-csv":
+ require(scanMode == ScanMode.ARGS);
+ scanMode = ScanMode.PRINT_CSV;
+ break;
+ default:
+ throw new UsageException();
+ }
+ } else {
+ break;
+ }
+ }
+
+ if ((scanMode == ScanMode.ARGS) == args.isEmpty()) {
+ throw new UsageException();
+ }
+
+ if ( forRemoval && loadMode == LoadMode.RELEASE &&
+ releasesWithoutForRemoval.contains(release)) {
+ throw new UsageException();
+ }
+
+ boolean success = false;
+
+ switch (loadMode) {
+ case CLASSES:
+ success = doClassNames(loadClasses);
+ break;
+ case DIR:
+ success = processDirectory(dir, loadClasses);
+ break;
+ case JAR:
+ success = processJarFile(jar, loadClasses);
+ break;
+ case JDK9:
+ require(!args.isEmpty());
+ success = processJdk9(jdkHome, loadClasses);
+ break;
+ case LOAD_CSV:
+ deprList = DeprDB.loadFromFile(csvFile);
+ success = true;
+ break;
+ case OLD_JDK:
+ success = processOldJdk(jdkHome, loadClasses);
+ break;
+ case RELEASE:
+ success = processRelease(release, loadClasses);
+ break;
+ case SELF:
+ success = processSelf(loadClasses);
+ break;
+ default:
+ throw new UsageException();
+ }
+
+ if (!success) {
+ return false;
+ }
+ } catch (NoSuchElementException | UsageException ex) {
+ err.println(Messages.get("main.usage"));
+ return false;
+ } catch (IOException ioe) {
+ if (verbose) {
+ ioe.printStackTrace(err);
+ } else {
+ err.println(ioe);
+ }
+ return false;
+ }
+
+ // now the scanning phase
+
+ switch (scanMode) {
+ case LIST:
+ for (DeprData dd : deprList) {
+ if (!forRemoval || dd.isForRemoval()) {
+ out.println(Pretty.print(dd));
+ }
+ }
+ break;
+ case PRINT_CSV:
+ out.println("#jdepr1");
+ comments.forEach(s -> out.println("# " + s));
+ for (DeprData dd : deprList) {
+ CSV.write(out, dd.kind, dd.typeName, dd.nameSig, dd.since, dd.forRemoval);
+ }
+ break;
+ case ARGS:
+ DeprDB db = DeprDB.loadFromList(deprList);
+ List<String> cp = classPath.stream()
+ .map(File::toString)
+ .collect(toList());
+ Scan scan = new Scan(out, err, cp, db, verbose);
+
+ for (String a : args) {
+ boolean success;
+
+ if (a.endsWith(".jar")) {
+ success = scan.scanJar(a);
+ } else if (Files.isDirectory(Paths.get(a))) {
+ success = scan.scanDir(a);
+ } else {
+ success = scan.processClassName(a.replace('.', '/'));
+ }
+
+ if (!success) {
+ return false;
+ }
+ }
+ break;
+ }
+
+ return true;
+ }
+
+ /**
+ * Programmatic main entry point: initializes the tool instance to
+ * use stdout and stderr; runs the tool, passing command-line args;
+ * returns an exit status.
+ *
+ * @return true on success, false otherwise
+ */
+ public static boolean call(PrintStream out, PrintStream err, String... args) {
+ try {
+ instance = new Main(out, err);
+ return instance.run(args);
+ } finally {
+ instance = null;
+ }
+ }
+
+ /**
+ * Calls the main entry point and exits the JVM with an exit
+ * status determined by the return status.
+ */
+ public static void main(String[] args) {
+ System.exit(call(System.out, System.err, args) ? 0 : 1);
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/Messages.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan;
+
+import java.text.MessageFormat;
+import java.util.Locale;
+import java.util.MissingResourceException;
+import java.util.ResourceBundle;
+
+/**
+ * Message handling class for localization.
+ */
+public class Messages {
+ static final ResourceBundle bundle;
+
+ static {
+ Locale locale = Locale.getDefault();
+ try {
+ bundle = ResourceBundle.getBundle("com.sun.tools.jdeprscan.resources.jdeprscan", locale);
+ } catch (MissingResourceException e) {
+ throw new InternalError("Cannot find jdeps resource bundle for locale " + locale, e);
+ }
+ }
+
+ public static String get(String key, Object... args) {
+ try {
+ return MessageFormat.format(bundle.getString(key), args);
+ } catch (MissingResourceException e) {
+ throw new InternalError("Missing message: " + key, e);
+ }
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/Pretty.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,274 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * Utility class for pretty-printing various bits of API syntax.
+ */
+public class Pretty {
+ /**
+ * Converts deprecation information into an {@code @Deprecated} annotation.
+ * The output is minimized: an empty since string is omitted, a forRemoval
+ * value of false is omitted; and if both are omitted, the trailing parentheses
+ * are also omitted.
+ *
+ * @param since the since value
+ * @param forRemoval the forRemoval value
+ * @return string containing an annotation
+ */
+ static String depr(String since, boolean forRemoval) {
+ String d = "@Deprecated";
+
+ if (since.isEmpty() && !forRemoval) {
+ return d;
+ }
+
+ StringBuilder sb = new StringBuilder(d).append('(');
+
+ if (!since.isEmpty()) {
+ sb.append("since=\"")
+ .append(since.replace("\"", "\\\""))
+ .append('"');
+ }
+
+ if (forRemoval) {
+ if (!since.isEmpty()) {
+ sb.append(", ");
+ }
+ sb.append("forRemoval=true");
+ }
+
+ sb.append(')');
+
+ return sb.toString();
+ }
+
+ /**
+ * Converts a slash-$ style name into a dot-separated name.
+ *
+ * @param n the input name
+ * @return the result name
+ */
+ static String unslashify(String n) {
+ return n.replace("/", ".")
+ .replace("$", ".");
+ }
+
+ /**
+ * Converts a type descriptor to a readable string.
+ *
+ * @param desc the input descriptor
+ * @return the result string
+ */
+ static String desc(String desc) {
+ return desc(desc, new int[] { 0 });
+ }
+
+ /**
+ * Converts one type descriptor to a readable string, starting
+ * from position {@code pos_inout[0]}, and updating it to the
+ * location following the descriptor just parsed. A type descriptor
+ * mostly corresponds to a FieldType in JVMS 4.3.2. It can be one of a
+ * BaseType (a single character denoting a primitive, plus void),
+ * an object type ("Lname;"), or an array type (one more more '[' followed
+ * by a base or object type).
+ *
+ * @param desc a string possibly containing several descriptors
+ * @param pos_inout on input, the start position; on return, the position
+ * following the just-parsed descriptor
+ * @return the result string
+ */
+ static String desc(String desc, int[] pos_inout) {
+ int dims = 0;
+ int pos = pos_inout[0];
+ final int len = desc.length();
+
+ while (pos < len && desc.charAt(pos) == '[') {
+ pos++;
+ dims++;
+ }
+
+ String name;
+
+ if (pos >= len) {
+ return null;
+ }
+
+ char c = desc.charAt(pos++);
+ switch (c) {
+ case 'Z':
+ name = "boolean";
+ break;
+ case 'B':
+ name = "byte";
+ break;
+ case 'S':
+ name = "short";
+ break;
+ case 'C':
+ name = "char";
+ break;
+ case 'I':
+ name = "int";
+ break;
+ case 'J':
+ name = "long";
+ break;
+ case 'F':
+ name = "float";
+ break;
+ case 'D':
+ name = "double";
+ break;
+ case 'V':
+ name = "void";
+ break;
+ case 'L':
+ int semi = desc.indexOf(';', pos);
+ if (semi == -1) {
+ return null;
+ }
+ name = unslashify(desc.substring(pos, semi));
+ pos = semi + 1;
+ break;
+ default:
+ return null;
+ }
+
+ StringBuilder sb = new StringBuilder(name);
+ for (int i = 0; i < dims; i++) {
+ sb.append("[]");
+ }
+ pos_inout[0] = pos;
+ return sb.toString();
+ }
+
+ /**
+ * Converts a series of type descriptors into a comma-separated,
+ * readable string. This is used for the parameter types of a
+ * method descriptor.
+ *
+ * @param types the parameter types
+ * @return the readable string
+ */
+ static String parms(String types) {
+ int[] pos = new int[] { 0 };
+ StringBuilder sb = new StringBuilder();
+
+ boolean first = true;
+
+ String t;
+
+ while ((t = desc(types, pos)) != null) {
+ if (first) {
+ first = false;
+ } else {
+ sb.append(',');
+ }
+ sb.append(t);
+ }
+
+ return sb.toString();
+ }
+
+ /**
+ * Pattern for matching a method descriptor. Match results can
+ * be retrieved from named capture groups as follows: "name(params)return".
+ */
+ static final Pattern DESC_PAT = Pattern.compile("(?<name>.*)\\((?<args>.*)\\)(?<return>.*)");
+
+ /**
+ * Pretty-prints the data contained in the given DeprData object.
+ *
+ * @param dd the deprecation data object
+ * @return the formatted string
+ */
+ public static String print(DeprData dd) {
+ StringBuilder sb = new StringBuilder();
+ sb.append(depr(dd.since, dd.forRemoval))
+ .append(' ');
+
+ switch (dd.kind) {
+ case ANNOTATION_TYPE:
+ sb.append("@interface ");
+ sb.append(unslashify(dd.typeName));
+ break;
+ case CLASS:
+ sb.append("class ");
+ sb.append(unslashify(dd.typeName));
+ break;
+ case ENUM:
+ sb.append("enum ");
+ sb.append(unslashify(dd.typeName));
+ break;
+ case INTERFACE:
+ sb.append("interface ");
+ sb.append(unslashify(dd.typeName));
+ break;
+
+ case ENUM_CONSTANT:
+ case FIELD:
+ sb.append(unslashify(dd.typeName))
+ .append('.')
+ .append(dd.nameSig);
+ break;
+ case CONSTRUCTOR:
+ Matcher cons = DESC_PAT.matcher(dd.nameSig);
+ sb.append(unslashify(dd.typeName));
+ if (cons.matches()) {
+ sb.append('(')
+ .append(parms(cons.group("args")))
+ .append(')');
+ } else {
+ sb.append('.')
+ .append(dd.nameSig);
+ }
+ break;
+ case METHOD:
+ Matcher meth = DESC_PAT.matcher(dd.nameSig);
+ if (meth.matches()) {
+ sb.append(desc(meth.group("return")))
+ .append(' ')
+ .append(unslashify(dd.typeName))
+ .append('.')
+ .append(meth.group("name"))
+ .append('(')
+ .append(parms(meth.group("args")))
+ .append(')');
+ } else {
+ sb.append(unslashify(dd.typeName))
+ .append('.')
+ .append(dd.nameSig);
+ }
+ break;
+ }
+
+ return sb.toString();
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/TraverseProc.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,172 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Comparator;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import javax.annotation.processing.AbstractProcessor;
+import javax.annotation.processing.Messager;
+import javax.annotation.processing.ProcessingEnvironment;
+import javax.annotation.processing.RoundEnvironment;
+import javax.annotation.processing.SupportedAnnotationTypes;
+import javax.annotation.processing.SupportedSourceVersion;
+
+import javax.lang.model.element.ModuleElement;
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.util.Elements;
+
+import static javax.lang.model.SourceVersion.RELEASE_9;
+import javax.lang.model.element.Element;
+import javax.lang.model.element.ElementKind;
+import javax.lang.model.element.Modifier;
+import javax.lang.model.element.PackageElement;
+import javax.tools.Diagnostic;
+
+@SupportedSourceVersion(RELEASE_9)
+@SupportedAnnotationTypes("*")
+public class TraverseProc extends AbstractProcessor {
+ Elements elements;
+ Messager messager;
+ final List<String> moduleRoots;
+ Map<PackageElement, List<TypeElement>> publicTypes;
+
+ TraverseProc(List<String> roots) {
+ moduleRoots = roots;
+ }
+
+ @Override
+ public void init(ProcessingEnvironment pe) {
+ super.init(pe);
+ elements = pe.getElementUtils();
+ messager = pe.getMessager();
+ }
+
+ @Override
+ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
+ if (roundEnv.processingOver()) {
+ return false;
+ }
+
+ Set<ModuleElement> modules = new HashSet<>();
+ for (String mname : moduleRoots) {
+ ModuleElement me = elements.getModuleElement(mname);
+ if (me == null) {
+ messager.printMessage(Diagnostic.Kind.ERROR,
+ String.format("module %s not found%n", mname));
+ } else {
+ modules.addAll(findModules(me));
+ }
+ }
+
+ Set<PackageElement> packages = findPackages(modules);
+
+ publicTypes = findPublicTypes(packages);
+
+ return true;
+ }
+
+ void printPublicTypes() {
+ printPublicTypes(publicTypes);
+ }
+
+ public Map<PackageElement, List<TypeElement>> getPublicTypes() {
+ return publicTypes;
+ }
+
+ void printPublicTypes(Map<PackageElement, List<TypeElement>> types) {
+ System.out.println("All public types:");
+ types.entrySet().stream()
+ .sorted(Comparator.comparing(e -> e.getKey().toString()))
+ .forEach(e -> {
+ System.out.println(" " + e.getKey());
+ e.getValue().stream()
+ .sorted(Comparator.comparing(TypeElement::toString))
+ .forEach(t -> System.out.println(" " + t));
+ });
+ System.out.println();
+ System.out.flush();
+ }
+
+ Set<ModuleElement> findModules(ModuleElement root) {
+ return findModules0(root, new HashSet<>(), 0);
+ }
+
+ Set<ModuleElement> findModules0(ModuleElement m, Set<ModuleElement> set, int nesting) {
+ set.add(m);
+ for (ModuleElement.Directive dir : m.getDirectives()) {
+ if (dir.getKind() == ModuleElement.DirectiveKind.REQUIRES) {
+ ModuleElement.RequiresDirective req = (ModuleElement.RequiresDirective)dir;
+ findModules0(req.getDependency(), set, nesting + 1);
+ }
+ }
+ return set;
+ }
+
+ Set<PackageElement> findPackages(Collection<ModuleElement> mods) {
+ Set<PackageElement> set = new HashSet<>();
+ for (ModuleElement m : mods) {
+ for (ModuleElement.Directive dir : m.getDirectives()) {
+ if (dir.getKind() == ModuleElement.DirectiveKind.EXPORTS) {
+ ModuleElement.ExportsDirective exp = (ModuleElement.ExportsDirective)dir;
+ if (exp.getTargetModules() == null) {
+ set.add(exp.getPackage());
+ }
+ }
+ }
+ }
+ return set;
+ }
+
+ Map<PackageElement, List<TypeElement>> findPublicTypes(Collection<PackageElement> pkgs) {
+ Map<PackageElement, List<TypeElement>> map = new HashMap<>();
+ for (PackageElement pkg : pkgs) {
+ List<TypeElement> enclosed = new ArrayList<>();
+ for (Element e : pkg.getEnclosedElements()) {
+ addPublicTypes(enclosed, e);
+ }
+ map.put(pkg, enclosed);
+ }
+ return map;
+ }
+
+ void addPublicTypes(List<TypeElement> list, Element e) {
+ ElementKind kind = e.getKind();
+ if ((kind.isClass() || kind.isInterface())
+ && e.getModifiers().contains(Modifier.PUBLIC)) {
+ list.add((TypeElement)e);
+ for (Element enc : e.getEnclosedElements()) {
+ addPublicTypes(list, enc);
+ }
+ }
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/internals.md Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,215 @@
+<!--
+
+Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+
+This code is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License version 2 only, as
+published by the Free Software Foundation. Oracle designates this
+particular file as subject to the "Classpath" exception as provided
+by Oracle in the LICENSE file that accompanied this code.
+
+This code is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+version 2 for more details (a copy is included in the LICENSE file that
+accompanied this code).
+
+You should have received a copy of the GNU General Public License version
+2 along with this work; if not, write to the Free Software Foundation,
+Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+or visit www.oracle.com if you need additional information or have any
+questions.
+
+-->
+
+
+JDeprScan Internals
+-----
+
+**EXPERIMENTAL OPTIONS**
+
+ --Xload-class CLASSNAME
+
+ Loads deprecation data from the class named CLASSNAME instead of from
+ the JDK image.
+
+ --Xload-csv CVSFILE
+
+ Loads deprecation data from file CSVFILE.
+
+ --Xload-dir DIR
+
+ Loads deprecation data from the class hierarchy rooted
+ at the directory named DIR.
+
+ --Xload-jar JARFILE
+
+ Loads deprecation data from the classes contained in the
+ jar file named JARFILE.
+
+ --Xload-jdk9 JAVA_HOME
+
+ Loads deprecation data from a modular JDK whose home
+ directory is at JAVA_HOME. This essentially adds the given
+ path to the system-modules location.
+
+ --Xload-old-jdk JAVA_HOME
+
+ Loads deprecation data from an old (non-modular) JDK whose
+ home directory is at JAVA_HOME. This essentially scans the
+ rt.jar file from that JDK.
+
+ --Xload-self
+
+ Loads deprecation data from the running JDK image by
+ traversing the entire jrt: filesystem. This differs from
+ -release 9, which traverses modules, packages, and classes by
+ starting from a set of root modules and using javax.lang.model
+ mechanisms (as opposed to filesystem mechanisms) for
+ traversing contained elements recursively.
+
+ --Xcompiler-arg ARG
+
+ Adds ARG to the list of arguments passed to the compiler.
+
+ --Xcsv-comment COMMENT
+
+ Adds a comment line containing COMMENT to the top of the CSV
+ that is emitted. Valid only when --Xprint-csv is
+ specified. More than one --Xcsv-comment option is permitted,
+ which will cause a corresponding number of comment lines to be
+ emitted to the CSV file.
+
+ --Xprint-csv
+
+ Prints out the loaded deprecation information in CSV format
+ to standard output. In this mode, no scanning is done, so
+ there must not be any additional directory, jar, or classname
+ arguments.
+
+**CSV FILE SYNTAX**
+
+The `-Xprint-csv` option causes **jdeprscan** to emit the loaded
+deprecation data in CSV (comma-separated value) format. The general
+syntax of CSV is documented in [RFC 4180][RFC] with supplemental
+information in a [Wikipedia article][wiki].
+
+The file is encoded in UTF-8.
+
+The file consists of a series of lines. Any of the standard line
+separators CR (U+000D), LF (U+000A), or a CR immediately followed by
+LF, are supported. Newlines are only supported between records and
+are not supported within field values.
+
+Comment lines start with a `#` (U+0023) character in the first
+column. The entire line is ignored up until the next line separator
+sequence.
+
+Each line is divided into fields separated by the comma `,` (U+002C)
+character. Horizontal whitespace is not treated specially; that is,
+it is considered part of a field's value. An empty line is considered
+to have one field which is the empty string.
+
+A field value that contains a comma or a quote quotation mark `"`
+(U+0022) must be surrounded by quotation marks. The surrounding
+quotation marks are not considered part of the field value. Any
+quotation marks that are part of a field value must be repeated in
+addition to being surrounded by quotation marks.
+
+It is a syntax error if a quotation mark appears within an unquoted field;
+if a quoted field isn't immediately followed by a comma or line
+separator; or if a quoted field is left unclosed at the end of the line.
+
+For example, a record with the following four fields:
+
+1. abcd
+2. ef,gh
+3. ij"kl
+4. mnop
+
+would be encoded as follows:
+
+ abcd,"ef,gh","ij""kl",mnop
+
+**CSV FILE DATA**
+
+The first line of output must be the following:
+
+ #jdepr1
+
+This is strictly a comment line, but it serves as a file
+identifier. The "1" indicates version 1 of this file.
+
+Zero or more comment lines follow, containing text that is specified
+by the `-Xcsv-comment` options.
+
+Subsequent non-comment lines must have the following five fields:
+
+ kind,typeName,descOrName,since,forRemoval
+
+Fields are defined as follows:
+
+ * _kind_ - one of CONSTRUCTOR, FIELD, METHOD, ENUM\_CONSTANT,
+ CLASS, INTERFACE, ENUM, or ANNOTATION\_TYPE. These correspond to
+ enumeration constants from the `javax.lang.model.element.ElementKind`
+ enum.
+
+ * _typeName_ - the fully qualified name of the type (if *kind* is
+ CLASS, INTERFACE, ENUM, or ANNOTATION\_TYPE) or of the enclosing
+ type (if _kind_ is CONSTRUCTOR, FIELD, METHOD, or
+ ENUM\_CONSTANT). This value is a _binary name_ [JLS 13.1][jls131]
+ using a slash character `/` (U+002F) to separate package and
+ top-level name components, and a dollar sign `$` (U+0024) to
+ separate nested name components. For example, the `Thread.State`
+ enum that appears in Java SE would have the following typeName:
+
+ java/lang/Thread$State
+
+ * _descOrName_ - if _kind_ is METHOD or CONSTRUCTOR, this is the method's
+ or constructor's descriptor [JVMS 4.3.3][jvms433]; if _kind_ is FIELD or
+ ENUM\_CONSTANT, this is its name; otherwise this field is empty.
+ A method's descriptor includes its name, parameter types, and return
+ type. For example, the method
+
+ public void String.getBytes(int srcBegin,
+ int srcEnd,
+ byte[] dst,
+ int dstBegin)
+
+ has the descriptor
+
+ getBytes(II[BI)V
+
+ * _since_ - the value of the `since` element of the `@Deprecated`
+ annotation, or empty if this element is not present.
+
+ * _forRemoval_ - the value of the `forRemoval` element of the
+ `@Deprecated` annotation, a boolean, either "true" or "false".
+
+Note that the _since_ field can have arbitrary text (excluding
+line separators) and is thus subject to quoting.
+
+**EXAMPLE OUTPUT**
+
+Given the following method declaration and annotation from the
+`java.lang.Runtime` class,
+
+ @Deprecated(since="1.2",
+ forRemoval=true)
+ public static void runFinalizersOnExit(boolean value)
+
+the following line will be emitted from **jdeprscan -Xprint-csv**:
+
+ METHOD,java/lang/Runtime,runFinalizersOnExit(Z)V,1.2,true
+
+
+[RFC]: https://www.ietf.org/rfc/rfc4180.txt
+
+[wiki]: https://en.wikipedia.org/wiki/Comma-separated_values
+
+[jls131]: http://docs.oracle.com/javase/specs/jls/se8/html/jls-13.html#jls-13.1
+
+[jvms433]: http://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.3.3
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/readme.md Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,180 @@
+<!--
+
+Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+
+This code is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License version 2 only, as
+published by the Free Software Foundation. Oracle designates this
+particular file as subject to the "Classpath" exception as provided
+by Oracle in the LICENSE file that accompanied this code.
+
+This code is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+version 2 for more details (a copy is included in the LICENSE file that
+accompanied this code).
+
+You should have received a copy of the GNU General Public License version
+2 along with this work; if not, write to the Free Software Foundation,
+Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+or visit www.oracle.com if you need additional information or have any
+questions.
+
+-->
+
+
+JDeprScan Tool Command Reference
+-----
+
+**NAME**
+
+ jdeprscan - Java deprecation scanner
+
+**SYNOPSIS**
+
+ jdeprscan [options] {dir | jar | class} ...
+
+**OPTIONS**
+
+ -cp PATH
+ --class-path PATH
+
+ Sets the classpath to PATH.
+
+ --for-removal
+
+ Limit reporting to deprecations whose forRemoval element
+ is true.
+
+ --full-version
+
+ Prints the full version string of the tool and exits.
+
+ -h
+ --help
+
+ Prints a help message and exits.
+
+ -l
+ --list
+
+ Prints out the set of deprecated APIs.
+
+ --release 6|7|8|9
+
+ Specifies the Java SE release that is the source of
+ the list of deprecated APIs. If no --release option is
+ provided, the latest release is used.
+
+ -v
+ --verbose
+
+ Enables additional output.
+
+ --version
+
+ Prints the version string of the tool and exits.
+
+**DESCRIPTION**
+
+**jdeprscan** scans a class library for uses of deprecated APIs.
+**jdeprscan** processes one or more arguments, which can be any
+combination of a directory, a jar file, or a class name.
+
+A directory argument must specify a path to a directory hierarchy that
+reflects the Java package hierarchy of the classes it contains.
+**jdeprscan** will scan each class found in the directory hierarchy
+and report information about how those classes use deprecated APIs.
+
+Given a jar file, **jdeprscan** will scan the classes found within
+that jar file and report information about how those classes use
+deprecated APIs.
+
+Given a class name, **jdeprscan** will search for that class on the
+classpath, scan that class, and report information about how that
+class uses deprecated APIs. The class name must use the fully
+qualified binary name of the class, as described in the
+[Java Language Specification, section 13.1][jls131]. This form uses
+the '$' character instead of '.' as the separator for nested class names.
+For example, the `Thread.State` enum would be specified using the string
+
+ java.lang.Thread$State
+
+The `--class-path` and `-cp` options specify the classpath used for
+class searching. The classpath is used for classes named on the
+command line, as well as for dependencies of the classes in jar file
+or directory hierarchy to be scanned.
+
+The `--for-removal` option limits output to uses of deprecated APIs
+whose `@Deprecated` annotation includes the `forRemoval` element with
+the value `true`. Note: the `forRemoval` attribute of the
+`@Deprecated` annotation did not exist prior to Java SE 9, so this
+option cannot be used with a release value of 6, 7, or 8.
+
+The `--release` option specifies the Java SE specification version
+that determines the set of deprecated APIs for which scanning is
+done. This is useful if a deprecation report is desired that lists
+uses of deprecated APIs as of a particular release in the past. If no
+`--release` option is given, the latest release is used.
+
+The `--list` and `-l` options will list the known set of deprecated
+APIs instead of doing any scanning. Since no scanning is done,
+no directory, jar, or class arguments should be provided. The set
+of deprecated APIs listed is affected by the `--release` and the
+`--for-removal` options.
+
+
+**EXAMPLE OUTPUT**
+
+The output is a report that lists program elements that use deprecated
+APIs. Output is subject to change.
+
+Consider the following declarations from Java SE 9:
+
+ // java.lang.Boolean
+
+ @Deprecated(since="9")
+ public Boolean(boolean value)
+
+ // java.lang.Runtime
+
+ @Deprecated(since="1.2", forRemoval=true)
+ public static void runFinalizersOnExit(boolean value)
+
+Running **jdeprscan** over a class that calls these methods will result
+in output something like the following:
+
+ class Example uses method java/lang/Boolean.<init>(Z)V deprecated
+ class Example uses method java/lang/Runtime.runFinalizersOnExit(Z)V deprecated for removal
+
+Running **jdeprscan** with the `--list` option will result in output
+including something like the following:
+
+ ...
+ @Deprecated(since="9") java.lang.Boolean(boolean)
+ @Deprecated(since="1.2", forRemoval=true) void java.lang.Runtime.runFinalizersOnExit(boolean)
+ ...
+
+**NOTES**
+
+The **jdeprscan** tool operates by opening Java class files and
+reading their structures directly, particularly the constant
+pool. Because of this, **jdeprscan** can tell _that_ a deprecated API
+is used, but it often cannot tell _where_ in the class that API is
+used.
+
+The **jdeprscan** tool doesn't follow the same set of rules for
+emitting warnings as specified for Java compilers in [JLS section
+9.6.4.6][jls9646]. In particular, **jdeprscan** does not respond to
+the `@SuppressWarnings` annotation, as that is significant only in
+source code, not in class files. In addition, **jdeprscan** emits
+warnings even if the usage is within the API element that is
+deprecated and when the use and declaration are within the same
+outermost class.
+
+[jls9646]: http://docs.oracle.com/javase/specs/jls/se8/html/jls-9.html#jls-9.6.4.6
+
+[jls131]: http://docs.oracle.com/javase/specs/jls/se8/html/jls-13.html#jls-13.1
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/resources/jdeprscan.properties Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,96 @@
+main.usage=\
+Usage: jdeprscan [options] '{dir|jar|class}' ...\n\
+\n\
+options:\n\
+\ -cp --class-path PATH\n\
+\ --for-removal\n\
+\ --full-version\n\
+\ -h --help\n\
+\ -l --list\n\
+\ --release 6|7|8|9\n\
+\ -v --verbose\n\
+\ --version
+
+main.help=\
+Scans each argument for usages of deprecated APIs. An argument\n\
+may be a directory specifying the root of a package hierarchy,\n\
+a JAR file, or a class name. The class name must be specified\n\
+using a fully qualified class name using the $ separator character\n\
+for nested classes, for example,\n\
+\n\
+\ java.lang.Thread$State\n\
+\n\
+The --class-path (-cp) option provides a search path for resolution\n\
+of dependent classes.\n\
+\n\
+The --for-removal option limits scanning or listing to APIs that are\n\
+deprecated for removal. Cannot be used with a release value of 6, 7, or 8.\n\
+\n\
+The --full-version option prints out the full version string of the tool.\n\
+\n\
+The --help option prints out a full help message.\n\
+\n\
+The --list (-l) option prints out the set of deprecated APIs. No scanning is done,\n\
+so no directory, jar, or class arguments should be provided.\n\
+\n\
+The --release option specifies the Java SE release that provides the set\n\
+of deprecated APIs for scanning.\n\
+\n\
+The --verbose (-v) option enables additional message output during processing.\n\
+\n\
+The --version option prints out the abbreviated version string of the tool.
+
+main.xhelp=\
+Unsupported options:\n\
+\n\
+\ --Xload-class CLASS\n\
+\ Loads deprecation information from the named class.\n\
+\ --Xload-csv CSVFILE\n\
+\ Loads deprecation information from the named CSV file.\n\
+\ --Xload-dir DIR\n\
+\ Loads deprecation information from the class hierarchy\n\
+\ at the named directory.\n\
+\ --Xload-jar JARFILE\n\
+\ Loads deprecation information from the named JAR file.\n\
+\ --Xload-jdk9 JAVA_HOME\n\
+\ Loads deprecation information from the JDK located at\n\
+\ JAVA_HOME, which must be a modular JDK.\n\
+\ --Xload-old-jdk JAVA_HOME\n\
+\ Loads deprecation information from the JDK located at\n\
+\ JAVA_HOME, which must not be a modular JDK. Instead, the\n\
+\ named JDK must be a "classic" JDK with an rt.jar file.\n\
+\ --Xload-self\n\
+\ Loads deprecation information by traversing the jrt:\n\
+\ filesystem of the running JDK image.\n\
+\ --Xcompiler-arg ARG\n\
+\ Adds ARG to the list of compiler arguments.\n\
+\ --Xcsv-comment COMMENT\n\
+\ Adds COMMENT as a comment line to the output CSV file.\n\
+\ Only effective if -Xprint-csv is also supplied.\n\
+\ --Xhelp\n\
+\ Prints this message.\n\
+\ --Xprint-csv\n\
+\ Prints a CSV file containing the loaded deprecation information\n\
+\ instead of scanning any classes or JAR files.
+
+error.prefix=Error:
+
+scan.process.class=Processing class {0}...
+
+scan.dep.normal=deprecated
+scan.dep.removal=deprecated FOR REMOVAL
+
+scan.out.extends={0} {1} extends class {2} {3}
+scan.out.implements={0} {1} implements interface {2} {3}
+scan.out.usestype={0} {1} uses type {2} {3}
+scan.out.usesmethodintype={0} {1} uses method in type {2} {3}
+scan.out.usesmethod={0} {1} uses method {2} {3} {4} {5}
+scan.out.usesintfmethodintype={0} {1} uses interface method in type {2} {3}
+scan.out.usesintfmethod={0} {1} uses interface method {2} {3} {4} {5}
+scan.out.usesfieldintype={0} {1} uses field in type {2} {3}
+scan.out.usesfield={0} {1} uses field {2} {3} {4}
+scan.out.usesfieldoftype={0} {1} uses field of type {2} {3} {4} {5}
+scan.out.hasfield={0} {1} has field {2} of type {3} {4}
+scan.out.methodparmtype={0} {1} method {2} has parameter type {3} {4}
+scan.out.methodrettype={0} {1} method {2} has return type {3} {4}
+scan.out.methodoverride={0} {1} overrides method {2} {3} {4} {5}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/scan/CPEntries.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,76 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan.scan;
+
+import java.util.ArrayList;
+import java.util.Formatter;
+import java.util.List;
+import java.util.Locale;
+
+import com.sun.tools.classfile.ClassFile;
+import com.sun.tools.classfile.ConstantPool;
+
+import static com.sun.tools.classfile.ConstantPool.CPInfo;
+
+/**
+ * A container for selected constant pool entries. There are currently
+ * lists that contain the following types of CP entries:
+ *
+ * - CONSTANT_Class_info
+ * - CONSTANT_Fieldref_info
+ * - CONSTANT_Methodref_info
+ * - CONSTANT_InterfaceMethodref_info
+ */
+class CPEntries {
+ final List<ConstantPool.CONSTANT_Class_info> classes = new ArrayList<>();
+ final List<ConstantPool.CONSTANT_Fieldref_info> fieldRefs = new ArrayList<>();
+ final List<ConstantPool.CONSTANT_Methodref_info> methodRefs = new ArrayList<>();
+ final List<ConstantPool.CONSTANT_InterfaceMethodref_info> intfMethodRefs = new ArrayList<>();
+
+ public static CPEntries loadFrom(ClassFile cf) {
+ CPEntries entries = new CPEntries();
+ for (CPInfo cpi : cf.constant_pool.entries()) {
+ cpi.accept(new CPSelector(), entries);
+ }
+ return entries;
+ }
+
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ Formatter f = new Formatter(sb, Locale.getDefault());
+ f.format("Classes:%n");
+ f.format("%s%n", classes);
+ f.format("FieldRefs:%n");
+ f.format("%s%n", fieldRefs);
+ f.format("MethodRefs:%n");
+ f.format("%s%n", methodRefs);
+ f.format("InterfaceMethodRefs:%n");
+ f.format("%s%n", intfMethodRefs);
+ f.flush();
+ return sb.toString();
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/scan/CPSelector.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,108 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan.scan;
+
+import com.sun.tools.classfile.ConstantPool;
+
+/**
+ * A visitor that selects constant pool entries by type and adds
+ * them to the given CPEntries object.
+ */
+class CPSelector implements ConstantPool.Visitor<Void,CPEntries> {
+ @Override
+ public Void visitClass(ConstantPool.CONSTANT_Class_info info, CPEntries p) {
+ p.classes.add(info);
+ return null;
+ }
+
+ @Override
+ public Void visitDouble(ConstantPool.CONSTANT_Double_info info, CPEntries p) {
+ return null;
+ }
+
+ @Override
+ public Void visitFieldref(ConstantPool.CONSTANT_Fieldref_info info, CPEntries p) {
+ p.fieldRefs.add(info);
+ return null;
+ }
+
+ @Override
+ public Void visitFloat(ConstantPool.CONSTANT_Float_info info, CPEntries p) {
+ return null;
+ }
+
+ @Override
+ public Void visitInteger(ConstantPool.CONSTANT_Integer_info info, CPEntries p) {
+ return null;
+ }
+
+ @Override
+ public Void visitInterfaceMethodref(ConstantPool.CONSTANT_InterfaceMethodref_info info, CPEntries p) {
+ p.intfMethodRefs.add(info);
+ return null;
+ }
+
+ @Override
+ public Void visitInvokeDynamic(ConstantPool.CONSTANT_InvokeDynamic_info info, CPEntries p) {
+ return null;
+ }
+
+ @Override
+ public Void visitLong(ConstantPool.CONSTANT_Long_info info, CPEntries p) {
+ return null;
+ }
+
+ @Override
+ public Void visitNameAndType(ConstantPool.CONSTANT_NameAndType_info info, CPEntries p) {
+ return null;
+ }
+
+ @Override
+ public Void visitMethodref(ConstantPool.CONSTANT_Methodref_info info, CPEntries p) {
+ p.methodRefs.add(info);
+ return null;
+ }
+
+ @Override
+ public Void visitMethodHandle(ConstantPool.CONSTANT_MethodHandle_info info, CPEntries p) {
+ return null;
+ }
+
+ @Override
+ public Void visitMethodType(ConstantPool.CONSTANT_MethodType_info info, CPEntries p) {
+ return null;
+ }
+
+ @Override
+ public Void visitString(ConstantPool.CONSTANT_String_info info, CPEntries p) {
+ return null;
+ }
+
+ @Override
+ public Void visitUtf8(ConstantPool.CONSTANT_Utf8_info info, CPEntries p) {
+ return null;
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/scan/ClassFinder.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,211 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan.scan;
+
+import com.sun.tools.classfile.ClassFile;
+import com.sun.tools.classfile.ConstantPoolException;
+
+import java.io.IOException;
+import java.net.URI;
+import java.nio.file.FileSystem;
+import java.nio.file.FileSystems;
+import java.nio.file.Files;
+import java.nio.file.NoSuchFileException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.jar.JarEntry;
+import java.util.jar.JarFile;
+import java.util.stream.Stream;
+
+/**
+ * A simple search path for classes.
+ */
+public class ClassFinder {
+ final List<PathEntry> list = new ArrayList<>();
+ final boolean verbose;
+
+ public ClassFinder(boolean verbose) {
+ this.verbose = verbose;
+ }
+
+ /**
+ * Adds a directory to this finder's search path, ignoring errors.
+ *
+ * @param dirName the directory to add
+ */
+ public void addDir(String dirName) {
+ Path dir = Paths.get(dirName);
+
+ if (Files.isDirectory(dir)) {
+ list.add(new DirPathEntry(dir));
+ }
+ }
+
+ /**
+ * Adds a jar file to this finder's search path, ignoring errors.
+ *
+ * @param jarName the jar file name to add
+ */
+ public void addJar(String jarName) {
+ try {
+ list.add(new JarPathEntry(new JarFile(jarName)));
+ } catch (IOException ignore) { }
+ }
+
+ /**
+ * Adds the JRT filesystem to this finder's search path.
+ */
+ public void addJrt() {
+ list.add(new JrtPathEntry());
+ }
+
+ /**
+ * Searches the class path for a class with the given name,
+ * returning a ClassFile for it. Returns null if not found.
+ *
+ * @param className the class to search for
+ * @return a ClassFile instance, or null if not found
+ */
+ public ClassFile find(String className) {
+ for (PathEntry pe : list) {
+ ClassFile cf = pe.find(className);
+ if (cf != null) {
+ return cf;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * An entry in this finder's class path.
+ */
+ interface PathEntry {
+ /**
+ * Returns a ClassFile instance corresponding to this name,
+ * or null if it's not present in this entry.
+ *
+ * @param className the class to search for
+ * @return a ClassFile instance, or null if not found
+ */
+ ClassFile find(String className);
+ }
+
+ /**
+ * An entry that represents a jar file.
+ */
+ class JarPathEntry implements PathEntry {
+ final JarFile jarFile;
+
+ JarPathEntry(JarFile jf) {
+ jarFile = jf;
+ }
+
+ @Override
+ public ClassFile find(String className) {
+ JarEntry entry = jarFile.getJarEntry(className + ".class");
+ if (entry == null) {
+ return null;
+ }
+ try {
+ return ClassFile.read(jarFile.getInputStream(entry));
+ } catch (IOException | ConstantPoolException ex) {
+ if (verbose) {
+ ex.printStackTrace();
+ }
+ }
+ return null;
+ }
+ }
+
+ /**
+ * An entry that represents a directory containing a class hierarchy.
+ */
+ class DirPathEntry implements PathEntry {
+ final Path dir;
+
+ DirPathEntry(Path dir) {
+ this.dir = dir;
+ }
+
+ @Override
+ public ClassFile find(String className) {
+ Path classFileName = dir.resolve(className + ".class");
+ try {
+ return ClassFile.read(classFileName);
+ } catch (NoSuchFileException nsfe) {
+ // not found, return silently
+ } catch (IOException | ConstantPoolException ex) {
+ if (verbose) {
+ ex.printStackTrace();
+ }
+ }
+ return null;
+ }
+ }
+
+ /**
+ * An entry that represents the JRT filesystem in the running image.
+ *
+ * JRT filesystem structure is:
+ * /packages/<dotted-pkgname>/<modlink>
+ * where modlink is a symbolic link to /modules/<modname> which is
+ * the top of the usual package-class hierarchy
+ */
+ class JrtPathEntry implements PathEntry {
+ final FileSystem fs = FileSystems.getFileSystem(URI.create("jrt:/"));
+
+ @Override
+ public ClassFile find(String className) {
+ int end = className.lastIndexOf('/');
+ if (end < 0) {
+ return null;
+ }
+ String pkg = "/packages/" + className.substring(0, end)
+ .replace('/', '.');
+ try (Stream<Path> mods = Files.list(fs.getPath(pkg))) {
+ Optional<Path> opath =
+ mods.map(path -> path.resolve(className + ".class"))
+ .filter(Files::exists)
+ .findFirst();
+ if (opath.isPresent()) {
+ return ClassFile.read(opath.get());
+ } else {
+ return null;
+ }
+ } catch (NoSuchFileException nsfe) {
+ // not found, return silently
+ } catch (IOException | ConstantPoolException ex) {
+ if (verbose) {
+ ex.printStackTrace();
+ }
+ }
+ return null;
+ }
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/scan/MethodSig.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,167 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan.scan;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * Represents a method's signature, that is, its parameter types
+ * and its return type.
+ */
+public class MethodSig {
+ final List<String> parameters;
+ final String returnType;
+
+ /**
+ * Parses the method descriptor and returns a MethodSig instance.
+ *
+ * @param desc the descriptor to parse
+ * @return the new MethodSig instance
+ */
+ public static MethodSig fromDesc(String desc) {
+ return parse(desc, 0, desc.length());
+ }
+
+ /**
+ * Returns this method's return type.
+ *
+ * @return the return type
+ */
+ public String getReturnType() {
+ return returnType;
+ }
+
+ /**
+ * Returns a list of parameters of this method.
+ *
+ * @return the parameter list
+ */
+ public List<String> getParameters() {
+ return parameters;
+ }
+
+ /**
+ * Returns a string describing this method.
+ *
+ * @return the string description
+ */
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ sb.append("parameters");
+ if (parameters.isEmpty()) {
+ sb.append(" none");
+ } else {
+ int i = 0;
+ for (String p : parameters) {
+ sb.append(String.format(" %d=%s", i++, p));
+ }
+ }
+ sb.append(String.format(" return %s", returnType));
+ return sb.toString();
+ }
+
+ private MethodSig(List<String> parameters, String returnType) {
+ this.parameters = Collections.unmodifiableList(parameters);
+ this.returnType = returnType;
+ }
+
+ private static IllegalArgumentException ex(String desc, int pos) {
+ return new IllegalArgumentException(String.format(
+ "illegal descriptor \"%s\" at position %d", desc, pos));
+ }
+
+ private static MethodSig parse(String desc, int start, int end)
+ throws IllegalArgumentException {
+ int p = start;
+ int dims = 0;
+ boolean inReturnType = false;
+ String returnType = null;
+ List<String> parameters = new ArrayList<>();
+
+ while (p < end) {
+ String type;
+ char ch;
+ switch (ch = desc.charAt(p)) {
+ case '(':
+ p++;
+ continue;
+
+ case ')':
+ p++;
+ inReturnType = true;
+ continue;
+
+ case '[':
+ p++;
+ dims++;
+ continue;
+
+ case 'B': // byte
+ case 'C': // char
+ case 'D': // double
+ case 'F': // float
+ case 'I': // int
+ case 'J': // long
+ case 'S': // short
+ case 'Z': // boolean
+ case 'V': // void
+ type = Character.toString(ch);
+ p++;
+ break;
+
+ case 'L':
+ int sep = desc.indexOf(';', p);
+ if (sep == -1 || sep >= end)
+ throw ex(desc, p);
+ type = desc.substring(p, ++sep);
+ p = sep;
+ break;
+
+ default:
+ throw ex(desc, p);
+ }
+
+ StringBuilder sb = new StringBuilder();
+ for ( ; dims > 0; dims-- )
+ sb.append("[");
+ sb.append(type);
+ if (inReturnType) {
+ returnType = sb.toString();
+ } else {
+ parameters.add(sb.toString());
+ }
+ }
+
+ if (returnType == null) {
+ throw ex(desc, end);
+ }
+
+ return new MethodSig(parameters, returnType);
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/scan/Scan.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,614 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.tools.jdeprscan.scan;
+
+import java.io.IOException;
+import java.io.PrintStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.ArrayDeque;
+import java.util.Deque;
+import java.util.Enumeration;
+import java.util.List;
+import java.util.jar.JarEntry;
+import java.util.jar.JarFile;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import com.sun.tools.classfile.*;
+import com.sun.tools.jdeprscan.DeprData;
+import com.sun.tools.jdeprscan.DeprDB;
+import com.sun.tools.jdeprscan.Messages;
+
+import static com.sun.tools.classfile.AccessFlags.*;
+import static com.sun.tools.classfile.ConstantPool.*;
+
+/**
+ * An object that represents the scanning phase of deprecation usage checking.
+ * Given a deprecation database, scans the targeted directory hierarchy, jar
+ * file, or individual class for uses of deprecated APIs.
+ */
+public class Scan {
+ final PrintStream out;
+ final PrintStream err;
+ final List<String> classPath;
+ final DeprDB db;
+ final boolean verbose;
+
+ final ClassFinder finder;
+ boolean error = false;
+
+ public Scan(PrintStream out,
+ PrintStream err,
+ List<String> classPath,
+ DeprDB db,
+ boolean verbose) {
+ this.out = out;
+ this.err = err;
+ this.classPath = classPath;
+ this.db = db;
+ this.verbose = verbose;
+
+ ClassFinder f = new ClassFinder(verbose);
+
+ // TODO: this isn't quite right. If we've specified a release other than the current
+ // one, we should instead add a reference to the symbol file for that release instead
+ // of the current image. The problems are a) it's unclear how to get from a release
+ // to paths that reference the symbol files, as this might be internal to the file
+ // manager; and b) the symbol file includes .sig files, not class files, which ClassFile
+ // might not be able to handle.
+ f.addJrt();
+
+ for (String name : classPath) {
+ if (name.endsWith(".jar")) {
+ f.addJar(name);
+ } else {
+ f.addDir(name);
+ }
+ }
+
+ finder = f;
+ }
+
+ Pattern typePattern = Pattern.compile("\\[*L(.*);");
+
+ // "flattens" an array type name to its component type
+ // and a reference type "Lpkg/pkg/pkg/name;" to its base name
+ // "pkg/pkg/pkg/name".
+ // TODO: deal with primitive types
+ String flatten(String typeName) {
+ Matcher matcher = typePattern.matcher(typeName);
+ if (matcher.matches()) {
+ return matcher.group(1);
+ } else {
+ return typeName;
+ }
+ }
+
+ String typeKind(ClassFile cf) {
+ AccessFlags flags = cf.access_flags;
+ if (flags.is(ACC_ENUM)) {
+ return "enum";
+ } else if (flags.is(ACC_ANNOTATION)) {
+ return "@interface";
+ } else if (flags.is(ACC_INTERFACE)) {
+ return "interface";
+ } else {
+ return "class";
+ }
+ }
+
+ void printType(String key, ClassFile cf, String cname, boolean forRemoval)
+ throws ConstantPoolException {
+ String dep = Messages.get(forRemoval ? "scan.dep.removal" : "scan.dep.normal");
+ out.println(Messages.get(key, typeKind(cf), cf.getName(), cname, dep));
+ }
+
+ void printMethod(String key, ClassFile cf, String cname, String mname, String rtype,
+ boolean forRemoval) throws ConstantPoolException {
+ String dep = Messages.get(forRemoval ? "scan.dep.removal" : "scan.dep.normal");
+ out.println(Messages.get(key, typeKind(cf), cf.getName(), cname, mname, rtype, dep));
+ }
+
+ void printField(String key, ClassFile cf, String cname, String fname,
+ boolean forRemoval) throws ConstantPoolException {
+ String dep = Messages.get(forRemoval ? "scan.dep.removal" : "scan.dep.normal");
+ out.println(Messages.get(key, typeKind(cf), cf.getName(), cname, fname, dep));
+ }
+
+ void printFieldType(String key, ClassFile cf, String cname, String fname, String type,
+ boolean forRemoval) throws ConstantPoolException {
+ String dep = Messages.get(forRemoval ? "scan.dep.removal" : "scan.dep.normal");
+ out.println(Messages.get(key, typeKind(cf), cf.getName(), cname, fname, type, dep));
+ }
+
+ void printHasField(ClassFile cf, String fname, String type, boolean forRemoval)
+ throws ConstantPoolException {
+ String dep = Messages.get(forRemoval ? "scan.dep.removal" : "scan.dep.normal");
+ out.println(Messages.get("scan.out.hasfield", typeKind(cf), cf.getName(), fname, type, dep));
+ }
+
+ void printHasMethodParmType(ClassFile cf, String mname, String parmType, boolean forRemoval)
+ throws ConstantPoolException {
+ String dep = Messages.get(forRemoval ? "scan.dep.removal" : "scan.dep.normal");
+ out.println(Messages.get("scan.out.methodparmtype", typeKind(cf), cf.getName(), mname, parmType, dep));
+ }
+
+ void printHasMethodRetType(ClassFile cf, String mname, String retType, boolean forRemoval)
+ throws ConstantPoolException {
+ String dep = Messages.get(forRemoval ? "scan.dep.removal" : "scan.dep.normal");
+ out.println(Messages.get("scan.out.methodrettype", typeKind(cf), cf.getName(), mname, retType, dep));
+ }
+
+ void printHasOverriddenMethod(ClassFile cf, String overridden, String mname, String desc, boolean forRemoval)
+ throws ConstantPoolException {
+ String dep = Messages.get(forRemoval ? "scan.dep.removal" : "scan.dep.normal");
+ out.println(Messages.get("scan.out.methodoverride", typeKind(cf), cf.getName(), overridden,
+ mname, desc, dep));
+ }
+
+ // format should not have a newline
+ void err(String format, Object... args) {
+ error = true;
+ err.print("error: ");
+ err.printf(format, args);
+ err.println();
+ }
+
+ void printException(Exception ex) {
+ err.print(Messages.get("error.prefix"));
+ err.print(" ");
+ if (verbose) {
+ ex.printStackTrace(err);
+ } else {
+ err.print(ex);
+ }
+ }
+
+ /**
+ * Checks whether a member (method or field) is present in a class.
+ * The checkMethod parameter determines whether this checks for a method
+ * or for a field.
+ *
+ * @param targetClass the ClassFile of the class to search
+ * @param targetName the method or field's name
+ * @param targetDesc the methods descriptor (ignored if checkMethod is false)
+ * @param checkMethod true if checking for method, false if checking for field
+ * @return boolean indicating whether the member is present
+ * @throws ConstantPoolException if a constant pool entry cannot be found
+ */
+ boolean isMemberPresent(ClassFile targetClass,
+ String targetName,
+ String targetDesc,
+ boolean checkMethod)
+ throws ConstantPoolException {
+ if (checkMethod) {
+ for (Method m : targetClass.methods) {
+ String mname = m.getName(targetClass.constant_pool);
+ String mdesc = targetClass.constant_pool.getUTF8Value(m.descriptor.index);
+ if (targetName.equals(mname) && targetDesc.equals(mdesc)) {
+ return true;
+ }
+ }
+ } else {
+ for (Field f : targetClass.fields) {
+ String fname = f.getName(targetClass.constant_pool);
+ if (targetName.equals(fname)) {
+ return true;
+ }
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Adds all interfaces from this class to the deque of interfaces.
+ *
+ * @param intfs the deque of interfaces
+ * @param cf the ClassFile of this class
+ * @throws ConstantPoolException if a constant pool entry cannot be found
+ */
+ void addInterfaces(Deque<String> intfs, ClassFile cf)
+ throws ConstantPoolException {
+ int count = cf.interfaces.length;
+ for (int i = 0; i < count; i++) {
+ intfs.addLast(cf.getInterfaceName(i));
+ }
+ }
+
+ /**
+ * Resolves a member by searching this class and all its superclasses and
+ * implemented interfaces.
+ *
+ * TODO: handles a few too many cases; needs cleanup.
+ *
+ * TODO: refine error handling
+ *
+ * @param cf the ClassFile of this class
+ * @param startClassName the name of the class at which to start searching
+ * @param findName the member name to search for
+ * @param findDesc the method descriptor to search for (ignored for fields)
+ * @param resolveMethod true if resolving a method, false if resolving a field
+ * @param checkStartClass true if the start class should be searched, false if
+ * it should be skipped
+ * @return the name of the class where the member resolved, or null
+ * @throws ConstantPoolException if a constant pool entry cannot be found
+ */
+ String resolveMember(
+ ClassFile cf, String startClassName, String findName, String findDesc,
+ boolean resolveMethod, boolean checkStartClass)
+ throws ConstantPoolException {
+ ClassFile startClass;
+
+ if (cf.getName().equals(startClassName)) {
+ startClass = cf;
+ } else {
+ startClass = finder.find(startClassName);
+ if (startClass == null) {
+ err("can't find class %s", startClassName);
+ return startClassName;
+ }
+ }
+
+ // follow super_class until it's 0, meaning we've reached Object
+ // accumulate interfaces of superclasses as we go along
+
+ ClassFile curClass = startClass;
+ Deque<String> intfs = new ArrayDeque<>();
+ while (true) {
+ if ((checkStartClass || curClass != startClass) &&
+ isMemberPresent(curClass, findName, findDesc, resolveMethod)) {
+ break;
+ }
+
+ if (curClass.super_class == 0) { // reached Object
+ curClass = null;
+ break;
+ }
+
+ String superName = curClass.getSuperclassName();
+ curClass = finder.find(superName);
+ if (curClass == null) {
+ err("can't find class %s", superName);
+ break;
+ }
+ addInterfaces(intfs, curClass);
+ }
+
+ // search interfaces: add all interfaces and superinterfaces to queue
+ // search until it's empty
+
+ if (curClass == null) {
+ addInterfaces(intfs, startClass);
+ while (intfs.size() > 0) {
+ String intf = intfs.removeFirst();
+ curClass = finder.find(intf);
+ if (curClass == null) {
+ err("can't find interface %s", intf);
+ break;
+ }
+
+ if (isMemberPresent(curClass, findName, findDesc, resolveMethod)) {
+ break;
+ }
+
+ addInterfaces(intfs, curClass);
+ }
+ }
+
+ if (curClass == null) {
+ if (checkStartClass) {
+ err("can't resolve methodref %s %s %s",
+ startClassName, findName, findDesc);
+ return startClassName;
+ } else {
+ // TODO: refactor this
+ // checkStartClass == false means we're checking for overrides
+ // so not being able to resolve a method simply means there's
+ // no overriding, which isn't an error
+ return null;
+ }
+ } else {
+ String foundClassName = curClass.getName();
+ return foundClassName;
+ }
+ }
+
+ /**
+ * Checks the superclass of this class.
+ *
+ * @param cf the ClassFile of this class
+ * @throws ConstantPoolException if a constant pool entry cannot be found
+ */
+ void checkSuper(ClassFile cf) throws ConstantPoolException {
+ String sname = cf.getSuperclassName();
+ DeprData dd = db.getTypeDeprecated(sname);
+ if (dd != null) {
+ printType("scan.out.extends", cf, sname, dd.isForRemoval());
+ }
+ }
+
+ /**
+ * Checks the interfaces of this class.
+ *
+ * @param cf the ClassFile of this class
+ * @throws ConstantPoolException if a constant pool entry cannot be found
+ */
+ void checkInterfaces(ClassFile cf) throws ConstantPoolException {
+ int ni = cf.interfaces.length;
+ for (int i = 0; i < ni; i++) {
+ String iname = cf.getInterfaceName(i);
+ DeprData dd = db.getTypeDeprecated(iname);
+ if (dd != null) {
+ printType("scan.out.implements", cf, iname, dd.isForRemoval());
+ }
+ }
+ }
+
+ /**
+ * Checks types referred to from the constant pool.
+ *
+ * @param cf the ClassFile of this class
+ * @param entries constant pool entries collected from this class
+ * @throws ConstantPoolException if a constant pool entry cannot be found
+ */
+ void checkTypes(ClassFile cf, CPEntries entries) throws ConstantPoolException {
+ for (ConstantPool.CONSTANT_Class_info ci : entries.classes) {
+ String typeName = ci.getName();
+ DeprData dd = db.getTypeDeprecated(flatten(typeName));
+ if (dd != null) {
+ printType("scan.out.usestype", cf, typeName, dd.isForRemoval());
+ }
+ }
+ }
+
+ /**
+ * Checks methods referred to from the constant pool.
+ *
+ * @param cf the ClassFile of this class
+ * @param nti the NameAndType_info from a MethodRef or InterfaceMethodRef entry
+ * @param clname the class name
+ * @param typeKey key for the type message
+ * @param methKey key for the method message
+ * @throws ConstantPoolException if a constant pool entry cannot be found
+ */
+ void checkMethodRef(ClassFile cf,
+ CONSTANT_NameAndType_info nti,
+ String clname,
+ String typeKey,
+ String methKey) throws ConstantPoolException {
+ DeprData dd = db.getTypeDeprecated(flatten(clname));
+ if (dd != null) {
+ printType(typeKey, cf, clname, dd.isForRemoval());
+ }
+
+ String name = nti.getName();
+ String type = nti.getType();
+ clname = resolveMember(cf, flatten(clname), name, type, true, true);
+ dd = db.getMethodDeprecated(clname, name, type);
+ if (dd != null) {
+ printMethod(methKey, cf, clname, name, type, dd.isForRemoval());
+ }
+ }
+
+ /**
+ * Checks fields referred to from the constant pool.
+ *
+ * @param cf the ClassFile of this class
+ * @throws ConstantPoolException if a constant pool entry cannot be found
+ */
+ void checkFieldRef(ClassFile cf,
+ ConstantPool.CONSTANT_Fieldref_info fri) throws ConstantPoolException {
+ CONSTANT_NameAndType_info nti = fri.getNameAndTypeInfo();
+ String clname = fri.getClassName();
+ String name = nti.getName();
+ String type = nti.getType();
+ DeprData dd = db.getTypeDeprecated(clname);
+
+ if (dd != null) {
+ printType("scan.out.usesfieldintype", cf, clname, dd.isForRemoval());
+ }
+
+ clname = resolveMember(cf, flatten(clname), name, type, false, true);
+ dd = db.getFieldDeprecated(clname, name);
+ if (dd != null) {
+ printField("scan.out.usesfield", cf, clname, name, dd.isForRemoval());
+ }
+
+ dd = db.getTypeDeprecated(flatten(type));
+ if (dd != null) {
+ printFieldType("scan.out.usesfieldoftype", cf, clname, name, type, dd.isForRemoval());
+ }
+ }
+
+ /**
+ * Checks the fields declared in this class.
+ *
+ * @param cf the ClassFile of this class
+ * @throws ConstantPoolException if a constant pool entry cannot be found
+ */
+ void checkFields(ClassFile cf) throws ConstantPoolException {
+ for (Field f : cf.fields) {
+ String type = cf.constant_pool.getUTF8Value(f.descriptor.index);
+ DeprData dd = db.getTypeDeprecated(flatten(type));
+ if (dd != null) {
+ printHasField(cf, f.getName(cf.constant_pool), type, dd.isForRemoval());
+ }
+ }
+ }
+
+ /**
+ * Checks the methods declared in this class.
+ *
+ * @param cf the ClassFile object of this class
+ * @throws ConstantPoolException if a constant pool entry cannot be found
+ */
+ void checkMethods(ClassFile cf) throws ConstantPoolException {
+ for (Method m : cf.methods) {
+ String mname = m.getName(cf.constant_pool);
+ String desc = cf.constant_pool.getUTF8Value(m.descriptor.index);
+ MethodSig sig = MethodSig.fromDesc(desc);
+ DeprData dd;
+
+ for (String parm : sig.getParameters()) {
+ dd = db.getTypeDeprecated(flatten(parm));
+ if (dd != null) {
+ printHasMethodParmType(cf, mname, parm, dd.isForRemoval());
+ }
+ }
+
+ String ret = sig.getReturnType();
+ dd = db.getTypeDeprecated(flatten(ret));
+ if (dd != null) {
+ printHasMethodRetType(cf, mname, ret, dd.isForRemoval());
+ }
+
+ // check overrides
+ String overridden = resolveMember(cf, cf.getName(), mname, desc, true, false);
+ if (overridden != null) {
+ dd = db.getMethodDeprecated(overridden, mname, desc);
+ if (dd != null) {
+ printHasOverriddenMethod(cf, overridden, mname, desc, dd.isForRemoval());
+ }
+ }
+ }
+ }
+
+ /**
+ * Processes a single class file.
+ *
+ * @param cf the ClassFile of the class
+ * @throws ConstantPoolException if a constant pool entry cannot be found
+ */
+ void processClass(ClassFile cf) throws ConstantPoolException {
+ if (verbose) {
+ out.println(Messages.get("scan.process.class", cf.getName()));
+ }
+
+ CPEntries entries = CPEntries.loadFrom(cf);
+
+ checkSuper(cf);
+ checkInterfaces(cf);
+ checkTypes(cf, entries);
+
+ for (ConstantPool.CONSTANT_Methodref_info mri : entries.methodRefs) {
+ CONSTANT_NameAndType_info nti = mri.getNameAndTypeInfo();
+ String clname = mri.getClassName();
+ checkMethodRef(cf, nti, clname, "scan.out.usesmethodintype", "scan.out.usesmethod");
+ }
+
+ for (ConstantPool.CONSTANT_InterfaceMethodref_info imri : entries.intfMethodRefs) {
+ CONSTANT_NameAndType_info nti = imri.getNameAndTypeInfo();
+ String clname = imri.getClassName();
+ checkMethodRef(cf, nti, clname, "scan.out.usesintfmethodintype", "scan.out.usesintfmethod");
+ }
+
+ for (ConstantPool.CONSTANT_Fieldref_info fri : entries.fieldRefs) {
+ checkFieldRef(cf, fri);
+ }
+
+ checkFields(cf);
+ checkMethods(cf);
+ }
+
+ /**
+ * Scans a jar file for uses of deprecated APIs.
+ *
+ * @param jarname the jar file to process
+ * @return true on success, false on failure
+ */
+ public boolean scanJar(String jarname) {
+ try (JarFile jf = new JarFile(jarname)) {
+ finder.addJar(jarname);
+ Enumeration<JarEntry> entries = jf.entries();
+ while (entries.hasMoreElements()) {
+ JarEntry entry = entries.nextElement();
+ String name = entry.getName();
+ if (name.endsWith(".class")
+ && !name.endsWith("package-info.class")
+ && !name.endsWith("module-info.class")) {
+ processClass(ClassFile.read(jf.getInputStream(entry)));
+ }
+ }
+ return true;
+ } catch (IOException | ConstantPoolException ex) {
+ printException(ex);
+ return false;
+ }
+ }
+
+ /**
+ * Scans class files in the named directory hierarchy for uses of deprecated APIs.
+ *
+ * @param dirname the directory hierarchy to process
+ * @return true on success, false on failure
+ */
+ public boolean scanDir(String dirname) {
+ Path base = Paths.get(dirname);
+ int baseCount = base.getNameCount();
+ finder.addDir(dirname);
+ try (Stream<Path> paths = Files.walk(Paths.get(dirname))) {
+ List<Path> classes =
+ paths.filter(p -> p.getNameCount() > baseCount)
+ .filter(path -> path.toString().endsWith(".class"))
+ .filter(path -> !path.toString().endsWith("package-info.class"))
+ .filter(path -> !path.toString().endsWith("module-info.class"))
+ .collect(Collectors.toList());
+ for (Path p : classes) {
+ processClass(ClassFile.read(p));
+ }
+ return true;
+ } catch (IOException | ConstantPoolException ex) {
+ printException(ex);
+ return false;
+ }
+ }
+
+ /**
+ * Scans the named class for uses of deprecated APIs.
+ *
+ * @param className the class to scan
+ * @return true on success, false on failure
+ */
+ public boolean processClassName(String className) {
+ try {
+ ClassFile cf = finder.find(className);
+ if (cf == null) {
+ err("can't find class %s", className);
+ return false;
+ } else {
+ processClass(cf);
+ return true;
+ }
+ } catch (ConstantPoolException ex) {
+ printException(ex);
+ return false;
+ }
+ }
+}
--- a/langtools/src/jdk.jshell/share/classes/jdk/internal/jshell/tool/ExternalEditor.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.jshell/share/classes/jdk/internal/jshell/tool/ExternalEditor.java Tue Aug 30 08:45:21 2016 -0700
@@ -34,6 +34,7 @@
import java.nio.file.WatchKey;
import java.nio.file.WatchService;
import java.util.Arrays;
+import java.util.Scanner;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import static java.nio.file.StandardWatchEventKinds.ENTRY_CREATE;
@@ -46,17 +47,22 @@
public class ExternalEditor {
private final Consumer<String> errorHandler;
private final Consumer<String> saveHandler;
+ private final Consumer<String> printHandler;
private final IOContext input;
+ private final boolean wait;
private WatchService watcher;
private Thread watchedThread;
private Path dir;
private Path tmpfile;
- ExternalEditor(Consumer<String> errorHandler, Consumer<String> saveHandler, IOContext input) {
+ ExternalEditor(Consumer<String> errorHandler, Consumer<String> saveHandler,
+ IOContext input, boolean wait, Consumer<String> printHandler) {
this.errorHandler = errorHandler;
this.saveHandler = saveHandler;
+ this.printHandler = printHandler;
this.input = input;
+ this.wait = wait;
}
private void edit(String[] cmd, String initialText) {
@@ -121,7 +127,16 @@
try {
input.suspend();
Process process = pb.start();
- process.waitFor();
+ // wait to exit edit mode in one of these ways...
+ if (wait) {
+ // -wait option -- ignore process exit, wait for carriage-return
+ Scanner scanner = new Scanner(System.in);
+ printHandler.accept("jshell.msg.press.return.to.leave.edit.mode");
+ scanner.nextLine();
+ } else {
+ // wait for process to exit
+ process.waitFor();
+ }
} catch (IOException ex) {
errorHandler.accept("process IO failure: " + ex.getMessage());
} catch (InterruptedException ex) {
@@ -148,8 +163,8 @@
}
static void edit(String[] cmd, Consumer<String> errorHandler, String initialText,
- Consumer<String> saveHandler, IOContext input) {
- ExternalEditor ed = new ExternalEditor(errorHandler, saveHandler, input);
+ Consumer<String> saveHandler, IOContext input, boolean wait, Consumer<String> printHandler) {
+ ExternalEditor ed = new ExternalEditor(errorHandler, saveHandler, input, wait, printHandler);
ed.edit(cmd, initialText);
}
}
--- a/langtools/src/jdk.jshell/share/classes/jdk/internal/jshell/tool/Feedback.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.jshell/share/classes/jdk/internal/jshell/tool/Feedback.java Tue Aug 30 08:45:21 2016 -0700
@@ -147,17 +147,17 @@
}
{
- for (FormatCase e : EnumSet.allOf(FormatCase.class))
+ for (FormatCase e : FormatCase.all)
selectorMap.put(e.name().toLowerCase(Locale.US), e);
- for (FormatAction e : EnumSet.allOf(FormatAction.class))
+ for (FormatAction e : FormatAction.all)
selectorMap.put(e.name().toLowerCase(Locale.US), e);
- for (FormatResolve e : EnumSet.allOf(FormatResolve.class))
+ for (FormatResolve e : FormatResolve.all)
selectorMap.put(e.name().toLowerCase(Locale.US), e);
- for (FormatUnresolved e : EnumSet.allOf(FormatUnresolved.class))
+ for (FormatUnresolved e : FormatUnresolved.all)
selectorMap.put(e.name().toLowerCase(Locale.US), e);
- for (FormatErrors e : EnumSet.allOf(FormatErrors.class))
+ for (FormatErrors e : FormatErrors.all)
selectorMap.put(e.name().toLowerCase(Locale.US), e);
- for (FormatWhen e : EnumSet.allOf(FormatWhen.class))
+ for (FormatWhen e : FormatWhen.all)
selectorMap.put(e.name().toLowerCase(Locale.US), e);
}
--- a/langtools/src/jdk.jshell/share/classes/jdk/internal/jshell/tool/JShellTool.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.jshell/share/classes/jdk/internal/jshell/tool/JShellTool.java Tue Aug 30 08:45:21 2016 -0700
@@ -94,12 +94,16 @@
import java.util.Spliterators;
import java.util.function.Function;
import java.util.function.Supplier;
+import jdk.internal.joptsimple.*;
import jdk.internal.jshell.tool.Feedback.FormatAction;
import jdk.internal.jshell.tool.Feedback.FormatCase;
import jdk.internal.jshell.tool.Feedback.FormatErrors;
import jdk.internal.jshell.tool.Feedback.FormatResolve;
import jdk.internal.jshell.tool.Feedback.FormatUnresolved;
import jdk.internal.jshell.tool.Feedback.FormatWhen;
+import static java.util.Arrays.asList;
+import static java.util.Arrays.stream;
+import static java.util.stream.Collectors.joining;
import static java.util.stream.Collectors.toList;
import static jdk.jshell.Snippet.SubKind.VAR_VALUE_SUBKIND;
import static java.util.stream.Collectors.toMap;
@@ -181,6 +185,7 @@
private String cmdlineClasspath = null;
private String startup = null;
private String[] editor = null;
+ private boolean editorWait = false;
// Commands and snippets which should be replayed
private List<String> replayableHistory;
@@ -477,6 +482,11 @@
if (editorString == null || editorString.isEmpty()) {
editor = null;
} else {
+ char waitMarker = editorString.charAt(0);
+ if (waitMarker == '-' || waitMarker == '*') {
+ editorWait = waitMarker == '-';
+ editorString = editorString.substring(1);
+ }
editor = editorString.split(RECORD_SEPARATOR);
}
@@ -515,82 +525,91 @@
* @return the list of files to be loaded
*/
private List<String> processCommandArgs(String[] args) {
- List<String> loadList = new ArrayList<>();
- Iterator<String> ai = Arrays.asList(args).iterator();
- while (ai.hasNext()) {
- String arg = ai.next();
- if (arg.startsWith("-")) {
- switch (arg) {
- case "-classpath":
- case "-cp":
- if (cmdlineClasspath != null) {
- startmsg("jshell.err.opt.classpath.conflict");
- return null;
- }
- if (ai.hasNext()) {
- cmdlineClasspath = ai.next();
- } else {
- startmsg("jshell.err.opt.classpath.arg");
- return null;
- }
- break;
- case "-help":
- printUsage();
- return null;
- case "-version":
- cmdout.printf("jshell %s\n", version());
- return null;
- case "-fullversion":
- cmdout.printf("jshell %s\n", fullVersion());
- return null;
- case "-feedback":
- if (ai.hasNext()) {
- commandLineFeedbackMode = ai.next();
- } else {
- startmsg("jshell.err.opt.feedback.arg");
- return null;
- }
- break;
- case "-q":
- commandLineFeedbackMode = "concise";
- break;
- case "-qq":
- commandLineFeedbackMode = "silent";
- break;
- case "-v":
- commandLineFeedbackMode = "verbose";
- break;
- case "-startup":
- if (startup != null) {
- startmsg("jshell.err.opt.startup.one");
- return null;
- }
- startup = readFile(ai.hasNext()? ai.next() : null, "-startup");
- if (startup == null) {
- return null;
- }
- break;
- case "-nostartup":
- if (startup != null) {
- startmsg("jshell.err.opt.startup.one");
- return null;
- }
- startup = "";
- break;
- default:
- if (arg.startsWith("-R")) {
- remoteVMOptions.add(arg.substring(2));
- break;
- }
- startmsg("jshell.err.opt.unknown", arg);
- printUsage();
- return null;
- }
+ OptionParser parser = new OptionParser();
+ OptionSpec<String> cp = parser.accepts("class-path").withRequiredArg();
+ OptionSpec<String> st = parser.accepts("startup").withRequiredArg();
+ parser.acceptsAll(asList("n", "no-startup"));
+ OptionSpec<String> fb = parser.accepts("feedback").withRequiredArg();
+ parser.accepts("q");
+ parser.accepts("s");
+ parser.accepts("v");
+ OptionSpec<String> r = parser.accepts("R").withRequiredArg();
+ parser.acceptsAll(asList("h", "help"));
+ parser.accepts("version");
+ parser.accepts("full-version");
+ NonOptionArgumentSpec<String> loadFileSpec = parser.nonOptions();
+
+ OptionSet options;
+ try {
+ options = parser.parse(args);
+ } catch (OptionException ex) {
+ if (ex.options().isEmpty()) {
+ startmsg("jshell.err.opt.invalid", stream(args).collect(joining(", ")));
} else {
- loadList.add(arg);
+ boolean isKnown = parser.recognizedOptions().containsKey(ex.options().iterator().next());
+ startmsg(isKnown
+ ? "jshell.err.opt.arg"
+ : "jshell.err.opt.unknown",
+ ex.options()
+ .stream()
+ .collect(joining(", ")));
+ }
+ return null;
+ }
+
+ if (options.has("help")) {
+ printUsage();
+ return null;
+ }
+ if (options.has("version")) {
+ cmdout.printf("jshell %s\n", version());
+ return null;
+ }
+ if (options.has("full-version")) {
+ cmdout.printf("jshell %s\n", fullVersion());
+ return null;
+ }
+ if (options.has(cp)) {
+ List<String> cps = options.valuesOf(cp);
+ if (cps.size() > 1) {
+ startmsg("jshell.err.opt.one", "--class-path");
+ return null;
}
+ cmdlineClasspath = cps.get(0);
}
- return loadList;
+ if (options.has(st)) {
+ List<String> sts = options.valuesOf(st);
+ if (sts.size() != 1 || options.has("no-startup")) {
+ startmsg("jshell.err.opt.startup.one");
+ return null;
+ }
+ startup = readFile(sts.get(0), "--startup");
+ if (startup == null) {
+ return null;
+ }
+ } else if (options.has("no-startup")) {
+ startup = "";
+ }
+ if ((options.valuesOf(fb).size() +
+ (options.has("q") ? 1 : 0) +
+ (options.has("s") ? 1 : 0) +
+ (options.has("v") ? 1 : 0)) > 1) {
+ startmsg("jshell.err.opt.feedback.one");
+ return null;
+ } else if (options.has(fb)) {
+ commandLineFeedbackMode = options.valueOf(fb);
+ } else if (options.has("q")) {
+ commandLineFeedbackMode = "concise";
+ } else if (options.has("s")) {
+ commandLineFeedbackMode = "silent";
+ } else if (options.has("v")) {
+ commandLineFeedbackMode = "verbose";
+ }
+ if (options.has(r)) {
+ remoteVMOptions = options.valuesOf(r);
+ }
+
+ return options.valuesOf(loadFileSpec);
}
private void printUsage() {
@@ -686,7 +705,7 @@
}
if (commandLineFeedbackMode != null) {
// The feedback mode to use was specified on the command line, use it
- if (!feedback.setFeedback(initmh, new ArgTokenizer("-feedback", commandLineFeedbackMode))) {
+ if (!feedback.setFeedback(initmh, new ArgTokenizer("--feedback", commandLineFeedbackMode))) {
regenerateOnDeath = false;
}
commandLineFeedbackMode = null;
@@ -1247,7 +1266,7 @@
// retain editor setting
prefs.put(EDITOR_KEY, (editor == null)
? ""
- : String.join(RECORD_SEPARATOR, editor));
+ : (editorWait? "-" : "*") + String.join(RECORD_SEPARATOR, editor));
return true;
case "start": {
if (!setStart(cmd, at, false)) {
@@ -1302,7 +1321,7 @@
// The sub-command: /set editor <editor-command-line>>
boolean setEditor(ArgTokenizer at, boolean argsRequired) {
- at.allowedOptions("-default");
+ at.allowedOptions("-default", "-wait");
String prog = at.next();
List<String> ed = new ArrayList<>();
while (at.val() != null) {
@@ -1313,14 +1332,20 @@
return false;
}
boolean defaultOption = at.hasOption("-default");
+ boolean waitOption = at.hasOption("-wait");
if (prog != null) {
if (defaultOption) {
errormsg("jshell.err.default.option.or.program", at.whole());
return false;
}
editor = ed.toArray(new String[ed.size()]);
+ editorWait = waitOption;
fluffmsg("jshell.msg.set.editor.set", prog);
} else if (defaultOption) {
+ if (waitOption) {
+ errormsg("jshell.err.wait.applies.to.external.editor", at.whole());
+ return false;
+ }
editor = null;
} else if (argsRequired) {
errormsg("jshell.err.set.editor.arg");
@@ -1707,7 +1732,8 @@
return false;
}
} else {
- ExternalEditor.edit(editor, errorHandler, src, saveHandler, input);
+ ExternalEditor.edit(editor, errorHandler, src, saveHandler, input,
+ editorWait, this::hardrb);
}
return true;
}
--- a/langtools/src/jdk.jshell/share/classes/jdk/internal/jshell/tool/resources/l10n.properties Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.jshell/share/classes/jdk/internal/jshell/tool/resources/l10n.properties Tue Aug 30 08:45:21 2016 -0700
@@ -26,10 +26,11 @@
jshell.msg.welcome =\
Welcome to JShell -- Version {0}\n\
For an introduction type: /help intro\n
-jshell.err.opt.classpath.conflict = Conflicting -classpath option.
-jshell.err.opt.classpath.arg = Argument to -classpath missing.
-jshell.err.opt.feedback.arg = Argument to -feedback missing. Mode required.
-jshell.err.opt.startup.one = Only one -startup or -nostartup option may be used.
+jshell.err.opt.arg = Argument to {0} missing.
+jshell.err.opt.invalid = Invalid options: {0}.
+jshell.err.opt.one = Only one {0} option may be used.
+jshell.err.opt.startup.one = Only one --startup or --no-startup option may be used.
+jshell.err.opt.feedback.one = Only one feedback option (--feedback, -q, -s, or -v) may be used.
jshell.err.opt.unknown = Unknown option: {0}
jshell.msg.terminated =\
@@ -55,6 +56,8 @@
jshell.msg.set.editor.set = Editor set to: {0}
jshell.err.cant.launch.editor = Cannot launch editor -- unexpected exception: {0}
jshell.msg.try.set.editor = Try /set editor to use external editor.
+jshell.msg.press.return.to.leave.edit.mode = Press return to leave edit mode.
+jshell.err.wait.applies.to.external.editor = -wait applies to external editors, cannot be used with -default
jshell.msg.try.command.without.args = Try ''{0}'' without arguments.
jshell.msg.no.active = There are no active definitions.
@@ -148,22 +151,21 @@
help.usage = \
Usage: jshell <options> <load files>\n\
where possible options include:\n\
-\ -classpath <path> Specify where to find user class files\n\
-\ -cp <path> Specify where to find user class files\n\
-\ -startup <file> One run replacement for the start-up definitions\n\
-\ -nostartup Do not run the start-up definitions\n\
-\ -feedback <mode> Specify the initial feedback mode. The mode may be\n\
-\ predefined (silent, concise, normal, or verbose) or\n\
-\ previously user-defined\n\
-\ -q Quiet feedback. Same as: -feedback concise\n\
-\ -qq Really quiet feedback. Same as: -feedback silent\n\
-\ -v Verbose feedback. Same as: -feedback verbose\n\
-\ -J<flag> Pass <flag> directly to the runtime system.\n\
-\ Use one -J for each runtime flag or flag argument\n\
-\ -R<flag> Pass <flag> to the remote runtime system.\n\
-\ Use one -R for each remote flag or flag argument\n\
-\ -help Print this synopsis of standard options\n\
-\ -version Version information\n
+\ --class-path <path> Specify where to find user class files\n\
+\ --startup <file> One run replacement for the start-up definitions\n\
+\ --no-startup Do not run the start-up definitions\n\
+\ --feedback <mode> Specify the initial feedback mode. The mode may be\n\
+\ predefined (silent, concise, normal, or verbose) or\n\
+\ previously user-defined\n\
+\ -q Quiet feedback. Same as: --feedback concise\n\
+\ -s Really quiet feedback. Same as: --feedback silent\n\
+\ -v Verbose feedback. Same as: --feedback verbose\n\
+\ -J<flag> Pass <flag> directly to the runtime system.\n\
+\ Use one -J for each runtime flag or flag argument\n\
+\ -R<flag> Pass <flag> to the remote runtime system.\n\
+\ Use one -R for each remote flag or flag argument\n\
+\ --help Print this synopsis of standard options\n\
+\ --version Version information\n
help.list.summary = list the source you have typed
help.list.args = [<name or id>|-all|-start]
@@ -358,7 +360,7 @@
the external editor to use, the start-up definitions to use, a new feedback mode,\n\
the command prompt, the feedback mode to use, or the format of output.\n\
\n\
-/set editor <command> <optional-arg>...\n\t\
+/set editor [-wait] <command> <optional-arg>...\n\t\
Specify the command to launch for the /edit command.\n\t\
The <command> is an operating system dependent string.\n\n\
/set start <file>\n\t\
@@ -602,12 +604,19 @@
help.set.editor =\
Specify the command to launch for the /edit command.\n\
\n\t\
-/set editor <command>|-default\n\
+/set editor [-wait] <command>|-default\n\
\n\
The <command> is an operating system dependent string.\n\
-The <command> may include space-separated arguments (such as flags)\n\
-When /edit is used, the temporary file to edit will be appended as the last argument.\n\
-If instead the -default option is specified, the built-in default editor will be used.
+The <command> may include space-separated arguments (such as flags)\n\n\
+If the -default option is specified, the built-in default editor will be used.\n\n\
+Otherwise an external editor should be specified in <command>. When <command>\n\
+is used, the temporary file to edit will be appended as the last argument.\n\
+Normally, edit mode will last until the external editor exits. Some external editors\n\
+will exit immediately (for example, if the edit window exists) either external editor\n\
+flags should be used to prevent immediate exit, or the -wait option should be used to\n\
+prompt the user to indicate when edit mode should end.\n\n\
+Note: while in edit mode no command inputs are seen. After leaving edit mode changes\n\
+to the edited snippets are not seen.
help.set.start =\
Set the start-up configuration -- a sequence of snippets and commands read at start-up.\n\
--- a/langtools/src/jdk.jshell/share/classes/jdk/jshell/MemoryFileManager.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.jshell/share/classes/jdk/jshell/MemoryFileManager.java Tue Aug 30 08:45:21 2016 -0700
@@ -52,8 +52,6 @@
import javax.tools.StandardJavaFileManager;
import javax.tools.StandardLocation;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import static jdk.internal.jshell.debug.InternalDebugControl.DBG_FMGR;
@@ -71,8 +69,6 @@
private ClassFileCreationListener classListener = null;
- private final ClassLoader loader = new REPLClassLoader();
-
private final JShell proc;
// Upcoming Jigsaw
@@ -105,7 +101,7 @@
return origin;
}
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public CharSequence getCharContent(boolean ignoreEncodingErrors) {
return src;
}
@@ -148,7 +144,7 @@
}
}
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public String getName() {
return className;
}
@@ -157,32 +153,17 @@
* Will provide the compiler with an output stream that leads to our
* byte array.
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public OutputStream openOutputStream() throws IOException {
return bos;
}
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public InputStream openInputStream() throws IOException {
return new ByteArrayInputStream(getBytes());
}
}
- // For restoring process-local execution support
- class REPLClassLoader extends ClassLoader {
-
- @Override
- protected Class<?> findClass(String name) throws ClassNotFoundException {
- OutputMemoryJavaFileObject fo = classObjects.get(name);
- proc.debug(DBG_FMGR, "findClass %s = %s\n", name, fo);
- if (fo == null) {
- throw new ClassNotFoundException("Not ours");
- }
- byte[] b = fo.getBytes();
- return super.defineClass(name, b, 0, b.length, null);
- }
- }
-
public MemoryFileManager(StandardJavaFileManager standardManager, JShell proc) {
this.stdFileManager = standardManager;
this.proc = proc;
@@ -199,39 +180,11 @@
}
}
- // For restoring process-local execution support
- public Class<?> findGeneratedClass(String genClassFullName) throws ClassNotFoundException {
- for (OutputMemoryJavaFileObject co : generatedClasses()) {
- if (co.className.equals(genClassFullName)) {
- Class<?> klass = loadClass(co.className);
- proc.debug(DBG_FMGR, "Loaded %s\n", klass);
- return klass;
- }
- }
- return null;
- }
-
- // For restoring process-local execution support
- public byte[] findGeneratedBytes(String genClassFullName) throws ClassNotFoundException {
- for (OutputMemoryJavaFileObject co : generatedClasses()) {
- if (co.className.equals(genClassFullName)) {
- return co.getBytes();
- }
- }
- return null;
- }
-
- // For restoring process-local execution support
- public Class<?> loadClass(String name) throws ClassNotFoundException {
- return getClassLoader(null).loadClass(name);
- }
-
public JavaFileObject createSourceFileObject(Object origin, String name, String code) {
return new SourceMemoryJavaFileObject(origin, name, code);
}
// Make compatible with Jigsaw
- @DefinedBy(Api.COMPILER)
public String inferModuleName(Location location) {
try {
if (inferModuleNameMethod == null) {
@@ -250,7 +203,6 @@
}
// Make compatible with Jigsaw
- @DefinedBy(Api.COMPILER)
public Iterable<Set<Location>> listModuleLocations(Location location) throws IOException {
try {
if (listModuleLocationsMethod == null) {
@@ -285,10 +237,10 @@
* @throws IllegalStateException if {@link #close} has been called
* and this file manager cannot be reopened
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public ClassLoader getClassLoader(JavaFileManager.Location location) {
proc.debug(DBG_FMGR, "getClassLoader: location\n", location);
- return loader;
+ return stdFileManager.getClassLoader(location);
}
/**
@@ -311,7 +263,7 @@
* @throws IllegalStateException if {@link #close} has been called
* and this file manager cannot be reopened
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public Iterable<JavaFileObject> list(JavaFileManager.Location location,
String packageName,
Set<JavaFileObject.Kind> kinds,
@@ -368,7 +320,7 @@
* @throws IllegalStateException if {@link #close} has been called
* and this file manager cannot be reopened
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public String inferBinaryName(JavaFileManager.Location location, JavaFileObject file) {
if (file instanceof OutputMemoryJavaFileObject) {
OutputMemoryJavaFileObject ofo = (OutputMemoryJavaFileObject) file;
@@ -392,7 +344,7 @@
* were created with another file manager and this file manager
* does not support foreign file objects
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public boolean isSameFile(FileObject a, FileObject b) {
return stdFileManager.isSameFile(b, b);
}
@@ -405,7 +357,7 @@
* @return the number of arguments the given option takes or -1 if
* the option is not supported
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public int isSupportedOption(String option) {
proc.debug(DBG_FMGR, "isSupportedOption: %s\n", option);
return stdFileManager.isSupportedOption(option);
@@ -425,7 +377,7 @@
* @throws IllegalStateException if {@link #close} has been called
* and this file manager cannot be reopened
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public boolean handleOption(String current, Iterator<String> remaining) {
proc.debug(DBG_FMGR, "handleOption: current: %s\n", current +
", remaining: " + remaining);
@@ -438,7 +390,7 @@
* @param location a location
* @return true if the location is known
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public boolean hasLocation(JavaFileManager.Location location) {
proc.debug(DBG_FMGR, "hasLocation: location: %s\n", location);
return stdFileManager.hasLocation(location);
@@ -474,7 +426,7 @@
* @throws IllegalStateException if {@link #close} has been called
* and this file manager cannot be reopened
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public JavaFileObject getJavaFileForInput(JavaFileManager.Location location,
String className,
JavaFileObject.Kind kind)
@@ -514,7 +466,7 @@
* @throws IllegalStateException {@link #close} has been called
* and this file manager cannot be reopened
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public JavaFileObject getJavaFileForOutput(JavaFileManager.Location location,
String className, Kind kind, FileObject sibling) throws IOException {
@@ -567,7 +519,7 @@
* @throws IllegalStateException if {@link #close} has been called
* and this file manager cannot be reopened
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public FileObject getFileForInput(JavaFileManager.Location location,
String packageName,
String relativeName)
@@ -616,7 +568,7 @@
* @throws IllegalStateException if {@link #close} has been called
* and this file manager cannot be reopened
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public FileObject getFileForOutput(JavaFileManager.Location location,
String packageName,
String relativeName,
@@ -636,7 +588,7 @@
* @throws IOException if an I/O error occurred
* @see #close
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public void flush() throws IOException {
// Nothing to flush
}
@@ -652,7 +604,7 @@
* @throws IOException if an I/O error occurred
* @see #flush
*/
- @Override @DefinedBy(Api.COMPILER)
+ @Override
public void close() throws IOException {
// Nothing to close
}
--- a/langtools/src/jdk.jshell/share/classes/jdk/jshell/SourceCodeAnalysisImpl.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.jshell/share/classes/jdk/jshell/SourceCodeAnalysisImpl.java Tue Aug 30 08:45:21 2016 -0700
@@ -55,8 +55,6 @@
import com.sun.tools.javac.code.Symtab;
import com.sun.tools.javac.code.Type;
import com.sun.tools.javac.code.Type.ClassType;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import com.sun.tools.javac.util.Name;
import com.sun.tools.javac.util.Names;
import com.sun.tools.javac.util.Pair;
@@ -534,7 +532,7 @@
TreePath[] deepest = new TreePath[1];
new TreePathScanner<Void, Void>() {
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void scan(Tree tree, Void p) {
if (tree == null)
return null;
@@ -552,7 +550,7 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitErroneous(ErroneousTree node, Void p) {
return scan(node.getErrorTrees(), null);
}
@@ -1250,7 +1248,7 @@
Trees trees = Trees.instance(source.fst);
new TreePathScanner<Void, Void>() {
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitMethod(MethodTree node, Void p) {
Element currentMethod = trees.getElement(getCurrentPath());
--- a/langtools/src/jdk.jshell/share/classes/jdk/jshell/TreeDependencyScanner.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.jshell/share/classes/jdk/jshell/TreeDependencyScanner.java Tue Aug 30 08:45:21 2016 -0700
@@ -34,8 +34,6 @@
import com.sun.source.tree.Tree;
import com.sun.source.tree.VariableTree;
import com.sun.source.util.TreeScanner;
-import com.sun.tools.javac.util.DefinedBy;
-import com.sun.tools.javac.util.DefinedBy.Api;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
@@ -67,7 +65,7 @@
// -- Differentiate declaration references from body references ---
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitClass(ClassTree node, Set<String> p) {
scan(node.getModifiers(), p);
scan(node.getTypeParameters(), p);
@@ -77,7 +75,7 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitMethod(MethodTree node, Set<String> p) {
scan(node.getModifiers(), p);
scan(node.getReturnType(), p);
@@ -90,7 +88,7 @@
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitVariable(VariableTree node, Set<String> p) {
scan(node.getModifiers(), p);
scan(node.getType(), p);
@@ -101,12 +99,12 @@
// --- Ignore these ---
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitPackage(PackageTree node, Set<String> p) {
return null;
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitImport(ImportTree node, Set<String> p) {
return null;
}
@@ -114,13 +112,13 @@
// -- Actual Symbol names ---
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitMemberSelect(MemberSelectTree node, Set<String> p) {
add(p, node.getIdentifier());
return super.visitMemberSelect(node, p);
}
- @Override @DefinedBy(Api.COMPILER_TREE)
+ @Override
public Void visitIdentifier(IdentifierTree node, Set<String> p) {
add(p, node.getName());
return super.visitIdentifier(node, p);
--- a/langtools/src/jdk.jshell/share/classes/module-info.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/src/jdk.jshell/share/classes/module-info.java Tue Aug 30 08:45:21 2016 -0700
@@ -34,6 +34,7 @@
requires java.prefs;
requires jdk.compiler;
requires jdk.internal.le;
+ requires jdk.internal.opt;
requires jdk.jdi;
exports jdk.jshell;
--- a/langtools/test/ProblemList.txt Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/ProblemList.txt Tue Aug 30 08:45:21 2016 -0700
@@ -30,6 +30,7 @@
jdk/javadoc/tool/enum/docComments/Main.java 8152313 generic-all convert to doclet test framework
jdk/javadoc/tool/enum/enumType/Main.java 8152313 generic-all convert to doclet test framework
jdk/javadoc/tool/varArgs/Main.java 8152313 generic-all convert to doclet test framework
+jdk/javadoc/doclet/testIOException/TestIOException.java 8164597 windows-all
###########################################################################
#
@@ -77,3 +78,9 @@
#
# jdeps
+###########################################################################
+#
+# jdeprscan
+
+tools/jdeprscan/tests/jdk/jdeprscan/TestLoad.java 8164837 windows-all probably line breaks or encoding
+tools/jdeprscan/tests/jdk/jdeprscan/TestScan.java 8164837 windows-all probably line breaks or encoding
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/jdk/javadoc/doclet/testCopyFiles/TestCopyFiles.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 8157349
+ * @summary test copy of doc-files
+ * @library ../lib
+ * @modules jdk.javadoc/jdk.javadoc.internal.tool
+ * @build JavadocTester
+ * @run main TestCopyFiles
+ */
+
+public class TestCopyFiles extends JavadocTester {
+
+ public static void main(String... args) throws Exception {
+ TestCopyFiles tester = new TestCopyFiles();
+ tester.runTests();
+ }
+
+ @Test
+ void testDocFilesInModules() {
+ javadoc("-d", "modules-out",
+ "--module-source-path", testSrc("modules"),
+ "--module", "acme.mdle");
+ checkExit(Exit.OK);
+ checkOutput("p/doc-files/inpackage.html", true,
+ "In a named module and named package"
+ );
+ }
+
+ @Test
+ void testDocFilesInPackages() {
+ javadoc("-d", "packages-out",
+ "-sourcepath", testSrc("packages"),
+ "p1");
+ checkExit(Exit.OK);
+ checkOutput("p1/doc-files/inpackage.html", true,
+ "A named package in an unnamed module"
+ );
+ }
+
+ @Test
+ void testDocFilesInUnnamedPackages() {
+ javadoc("-d", "unnamed-out",
+ "-sourcepath", testSrc("unnamed"),
+ testSrc("unnamed/Foo.java")
+ );
+ checkExit(Exit.OK);
+ checkOutput("doc-files/inpackage.html", true,
+ "In an unnamed package"
+ );
+ }
+
+ @Test
+ void testDocFilesInPackagesSource7() {
+ javadoc("-d", "packages-out-src7",
+ "-source", "7",
+ "-sourcepath", testSrc("packages"),
+ "p1");
+ checkExit(Exit.OK);
+ checkOutput("p1/doc-files/inpackage.html", true,
+ "A named package in an unnamed module"
+ );
+ }
+
+ @Test
+ void testDocFilesInPackagesSource7UsingClassPath() {
+ javadoc("-d", "packages-out-src7-cp",
+ "-source", "7",
+ "-classpath", testSrc("packages"),
+ "p1");
+ checkExit(Exit.OK);
+ checkOutput("p1/doc-files/inpackage.html", true,
+ "A named package in an unnamed module"
+ );
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/jdk/javadoc/doclet/testCopyFiles/modules/acme.mdle/module-info.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+ /**
+ * A test module.
+ */
+module acme.mdle {
+ exports p;
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/jdk/javadoc/doclet/testCopyFiles/modules/acme.mdle/p/Foo.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package p;
+
+/**
+ * A test class.
+ */
+public class Foo {}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/jdk/javadoc/doclet/testCopyFiles/modules/acme.mdle/p/doc-files/inpackage.html Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,33 @@
+<!--
+Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+
+This code is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License version 2 only, as
+published by the Free Software Foundation. Oracle designates this
+particular file as subject to the "Classpath" exception as provided
+by Oracle in the LICENSE file that accompanied this code.
+
+This code is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+version 2 for more details (a copy is included in the LICENSE file that
+accompanied this code).
+
+You should have received a copy of the GNU General Public License version
+2 along with this work; if not, write to the Free Software Foundation,
+Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+or visit www.oracle.com if you need additional information or have any
+questions.
+-->
+
+<html>
+ <head>
+ <title>"Hello World"</title>
+ </head>
+ <body>
+ In a named module and named package
+ </body>
+</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/jdk/javadoc/doclet/testCopyFiles/packages/p1/Foo.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+ /**
+ * A test class.
+ */
+package p1;
+
+/**
+ * A test class.
+ */
+public class Foo {}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/jdk/javadoc/doclet/testCopyFiles/packages/p1/doc-files/inpackage.html Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,33 @@
+<!--
+Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+
+This code is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License version 2 only, as
+published by the Free Software Foundation. Oracle designates this
+particular file as subject to the "Classpath" exception as provided
+by Oracle in the LICENSE file that accompanied this code.
+
+This code is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+version 2 for more details (a copy is included in the LICENSE file that
+accompanied this code).
+
+You should have received a copy of the GNU General Public License version
+2 along with this work; if not, write to the Free Software Foundation,
+Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+or visit www.oracle.com if you need additional information or have any
+questions.
+-->
+
+<html>
+ <head>
+ <title>"Hello World"</title>
+ </head>
+ <body>
+ A named package in an unnamed module.
+ </body>
+</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/jdk/javadoc/doclet/testCopyFiles/unnamed/Foo.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+ /**
+ * A test class.
+ */
+
+/**
+ * A test class.
+ */
+public class Foo {}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/jdk/javadoc/doclet/testCopyFiles/unnamed/doc-files/inpackage.html Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,33 @@
+<!--
+Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+
+This code is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License version 2 only, as
+published by the Free Software Foundation. Oracle designates this
+particular file as subject to the "Classpath" exception as provided
+by Oracle in the LICENSE file that accompanied this code.
+
+This code is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+version 2 for more details (a copy is included in the LICENSE file that
+accompanied this code).
+
+You should have received a copy of the GNU General Public License version
+2 along with this work; if not, write to the Free Software Foundation,
+Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+or visit www.oracle.com if you need additional information or have any
+questions.
+-->
+
+<html>
+ <head>
+ <title>"Hello World"</title>
+ </head>
+ <body>
+ In an unnamed package
+ </body>
+</html>
--- a/langtools/test/jdk/javadoc/doclet/testFramesNoFrames/TestFramesNoFrames.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/javadoc/doclet/testFramesNoFrames/TestFramesNoFrames.java Tue Aug 30 08:45:21 2016 -0700
@@ -23,7 +23,7 @@
/*
* @test
- * @bug 8162353
+ * @bug 8162353 8164747
* @summary javadoc should provide a way to disable use of frames
* @library /tools/lib ../lib
* @modules
@@ -204,7 +204,7 @@
@Test
void testModules(Path base, FrameKind fKind, OverviewKind oKind, HtmlKind hKind) throws IOException {
javadoc(base, fKind, oKind, hKind,
- "-modulesourcepath", gensrcModules.toString(),
+ "--module-source-path", gensrcModules.toString(),
"--module", "m1,m2,m3");
new Checker(fKind, oKind, hKind)
@@ -283,6 +283,19 @@
// this file is only generated when not in frames mode
checkFiles(!frames,
"allclasses.html");
+
+ if (frames) {
+ checkOutput("allclasses-frame.html", true,
+ classes.stream()
+ .map(c -> "title=\"class in " + packagePart(c) + "\" target=\"classFrame\">" + classPart(c) + "</a>")
+ .toArray(String[]::new));
+ checkOutput("allclasses-noframe.html", false,
+ "target=\"classFrame\">");
+ } else {
+ checkOutput("allclasses.html", false,
+ "target=\"classFrame\">");
+
+ }
}
private void checkFrameFiles() {
@@ -367,6 +380,11 @@
.count();
}
+ private String classPart(String className) {
+ int lastDot = className.lastIndexOf(".");
+ return className.substring(lastDot + 1);
+ }
+
private String packagePart(String className) {
int slash = className.indexOf("/");
int lastDot = className.lastIndexOf(".");
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/jdk/javadoc/doclet/testIOException/TestIOException.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,179 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 8164130
+ * @summary test IOException handling
+ * @library ../lib
+ * @modules jdk.javadoc/jdk.javadoc.internal.tool
+ * @build JavadocTester
+ * @run main TestIOException
+ */
+
+import java.io.File;
+import java.io.FileWriter;
+
+public class TestIOException extends JavadocTester {
+
+ public static void main(String... args) throws Exception {
+ TestIOException tester = new TestIOException();
+ tester.runTests();
+ }
+
+ @Test
+ void testReadOnlyDirectory() {
+ File outDir = new File("out1");
+ if (!outDir.mkdir()) {
+ throw new Error("Cannot create directory");
+ }
+ if (!outDir.setReadOnly()) {
+ throw new Error("could not set directory read-only");
+ }
+ if (outDir.canWrite()) {
+ throw new Error("directory is writable");
+ }
+
+ try {
+ javadoc("-d", outDir.toString(),
+ new File(testSrc, "TestIOException.java").getPath());
+ checkExit(Exit.FAILED);
+ checkOutput(Output.OUT, true,
+ "Destination directory not writable: " + outDir);
+ } finally {
+ outDir.setWritable(true);
+ }
+ }
+
+ @Test
+ void testReadOnlyFile() throws Exception {
+ File outDir = new File("out2");
+ if (!outDir.mkdir()) {
+ throw new Error("Cannot create directory");
+ }
+ File index = new File(outDir, "index.html");
+ try (FileWriter fw = new FileWriter(index)) { }
+ if (!index.setReadOnly()) {
+ throw new Error("could not set index read-only");
+ }
+ if (index.canWrite()) {
+ throw new Error("index is writable");
+ }
+
+ try {
+ setOutputDirectoryCheck(DirectoryCheck.NONE);
+ javadoc("-d", outDir.toString(),
+ new File(testSrc, "TestIOException.java").getPath());
+
+ checkExit(Exit.FAILED);
+ checkOutput(Output.OUT, true,
+ "Error writing file: " + index);
+ } finally {
+ setOutputDirectoryCheck(DirectoryCheck.EMPTY);
+ index.setWritable(true);
+ }
+ }
+
+ @Test
+ void testReadOnlySubdirectory() throws Exception {
+ // init source file
+ File srcDir = new File("src4");
+ File src_p = new File(srcDir, "p");
+ src_p.mkdirs();
+ File src_p_C = new File(src_p, "C.java");
+ try (FileWriter fw = new FileWriter(src_p_C)) {
+ fw.write("package p; public class C { }");
+ }
+
+ // create an unwritable package output directory
+ File outDir = new File("out3");
+ File pkgOutDir = new File(outDir, "p");
+ if (!pkgOutDir.mkdirs()) {
+ throw new Error("Cannot create directory");
+ }
+ if (!pkgOutDir.setReadOnly()) {
+ throw new Error("could not set directory read-only");
+ }
+ if (pkgOutDir.canWrite()) {
+ throw new Error("directory is writable");
+ }
+
+ // run javadoc and check results
+ try {
+ setOutputDirectoryCheck(DirectoryCheck.NONE);
+ javadoc("-d", outDir.toString(),
+ src_p_C.getPath());
+ checkExit(Exit.FAILED);
+ checkOutput(Output.OUT, true,
+ "Error writing file: " + new File(pkgOutDir, "C.html"));
+ } finally {
+ setOutputDirectoryCheck(DirectoryCheck.EMPTY);
+ pkgOutDir.setWritable(true);
+ }
+ }
+
+ @Test
+ void testReadOnlyDocFilesDir() throws Exception {
+ // init source files
+ File srcDir = new File("src4");
+ File src_p = new File(srcDir, "p");
+ src_p.mkdirs();
+ File src_p_C = new File(src_p, "C.java");
+ try (FileWriter fw = new FileWriter(src_p_C)) {
+ fw.write("package p; public class C { }");
+ }
+ File src_p_docfiles = new File(src_p, "doc-files");
+ src_p_docfiles.mkdir();
+ try (FileWriter fw = new FileWriter(new File(src_p_docfiles, "info.txt"))) {
+ fw.write("info");
+ }
+
+ // create an unwritable doc-files output directory
+ File outDir = new File("out4");
+ File pkgOutDir = new File(outDir, "p");
+ File docFilesOutDir = new File(pkgOutDir, "doc-files");
+ if (!docFilesOutDir.mkdirs()) {
+ throw new Error("Cannot create directory");
+ }
+ if (!docFilesOutDir.setReadOnly()) {
+ throw new Error("could not set directory read-only");
+ }
+ if (docFilesOutDir.canWrite()) {
+ throw new Error("directory is writable");
+ }
+
+ try {
+ setOutputDirectoryCheck(DirectoryCheck.NONE);
+ javadoc("-d", outDir.toString(),
+ "-sourcepath", srcDir.getPath(),
+ "p");
+ checkExit(Exit.FAILED);
+ checkOutput(Output.OUT, true,
+ "Error writing file: " + new File(docFilesOutDir, "info.txt"));
+ } finally {
+ setOutputDirectoryCheck(DirectoryCheck.EMPTY);
+ docFilesOutDir.setWritable(true);
+ }
+ }
+}
+
--- a/langtools/test/jdk/javadoc/doclet/testModules/TestModules.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/javadoc/doclet/testModules/TestModules.java Tue Aug 30 08:45:21 2016 -0700
@@ -160,8 +160,8 @@
@Test
void testModuleSummary() {
javadoc("-d", "out-moduleSummary", "-use",
- "-modulesourcepath", testSrc,
- "-addmods", "module1,module2",
+ "--module-source-path", testSrc,
+ "--add-modules", "module1,module2",
"testpkgmdl1", "testpkgmdl2", "module2/testpkg2mdl2");
checkExit(Exit.OK);
checkModuleSummary();
@@ -174,8 +174,8 @@
@Test
void testModuleFilesAndLinks() {
javadoc("-d", "out-modulelinks",
- "-modulesourcepath", testSrc,
- "-addmods", "module1",
+ "--module-source-path", testSrc,
+ "--add-modules", "module1",
"testpkgmdl1");
checkExit(Exit.OK);
checkModuleFilesAndLinks(true);
--- a/langtools/test/jdk/javadoc/doclet/testTypeAnnotations/typeannos/RepeatedAnnotations.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/javadoc/doclet/testTypeAnnotations/typeannos/RepeatedAnnotations.java Tue Aug 30 08:45:21 2016 -0700
@@ -8,7 +8,7 @@
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR RepeatingA PARTICULAR PURPOSE. See the GNU General Public License
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
--- a/langtools/test/jdk/javadoc/tool/modules/FilterOptions.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/javadoc/tool/modules/FilterOptions.java Tue Aug 30 08:45:21 2016 -0700
@@ -27,7 +27,6 @@
* @summary Tests elements filtering options
* @modules
* jdk.javadoc/jdk.javadoc.internal.api
- * jdk.javadoc/jdk.javadoc.internal.doclets.standard
* jdk.javadoc/jdk.javadoc.internal.tool
* jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
@@ -60,7 +59,7 @@
@Test
public void testDefault(Path base) throws Exception {
- execTask("-modulesourcepath", src, "--module", "m1");
+ execTask("--module-source-path", src, "--module", "m1");
checkModulesSpecified("m1");
checkModulesIncluded("m1");
@@ -70,7 +69,7 @@
@Test
public void testModuleModeApi(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1", "--show-module-contents:api");
checkModuleMode("API");
@@ -78,7 +77,7 @@
@Test
public void testModuleModeAll(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1", "--show-module-contents:all");
checkModuleMode("ALL");
@@ -86,7 +85,7 @@
@Test
public void testShowPackagesExported(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"--show-packages:exported"); // default
@@ -98,7 +97,7 @@
@Test
public void testShowPackagesAll(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"--show-packages:all");
checkModulesSpecified("m1");
@@ -111,7 +110,7 @@
@Test
public void testShowTypesPrivate(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"--show-types:private");
@@ -128,7 +127,7 @@
@Test
public void testShowTypesPackage(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"--show-types:package");
@@ -144,7 +143,7 @@
@Test
public void testShowTypesProtected(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"--show-types:protected");
@@ -161,7 +160,7 @@
@Test
public void testShowTypesPublic(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"--show-types:public");
@@ -178,7 +177,7 @@
@Test
public void testShowMembersPrivate(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"--show-members:private");
@@ -187,7 +186,7 @@
@Test
public void testShowMembersPackage(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"--show-members:package");
@@ -196,7 +195,7 @@
@Test
public void testShowMembersProtected(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"--show-members:protected");
@@ -205,7 +204,7 @@
@Test
public void testShowMembersPublic(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"--show-members:public");
@@ -214,7 +213,7 @@
@Test
public void testLegacyPublic(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"-public");
@@ -229,7 +228,7 @@
@Test
public void testLegacyDefault(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1");
checkModuleMode("API");
@@ -243,7 +242,7 @@
@Test
public void testLegacyProtected(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"-protected");
@@ -258,7 +257,7 @@
@Test
public void testLegacyPackage(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"-package");
@@ -277,7 +276,7 @@
@Test
public void testLegacyPrivate(Path base) throws Exception {
- execTask("-modulesourcepath", src,
+ execTask("--module-source-path", src,
"--module", "m1",
"-private");
--- a/langtools/test/jdk/javadoc/tool/modules/Modules.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/javadoc/tool/modules/Modules.java Tue Aug 30 08:45:21 2016 -0700
@@ -27,7 +27,6 @@
* @summary Tests primarily the module graph computations.
* @modules
* jdk.javadoc/jdk.javadoc.internal.api
- * jdk.javadoc/jdk.javadoc.internal.doclets.standard
* jdk.javadoc/jdk.javadoc.internal.tool
* jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
@@ -58,7 +57,7 @@
.classes("package pub; /** Klass A */ public class A {}")
.classes("package pro; /** Klass B */ public class B {}")
.write(src);
- execTask("-modulesourcepath", src.toString(),
+ execTask("--module-source-path", src.toString(),
"--module", "m1");
checkModulesSpecified("m1");
checkPackagesIncluded("pub");
@@ -83,7 +82,7 @@
.classes("package m2pub; /** Klass A */ public class A {}")
.classes("package m2pro; /** Klass B */ public class B {}")
.write(src);
- execTask("-modulesourcepath", src.toString(),
+ execTask("--module-source-path", src.toString(),
"--module", "m1,m2");
checkModulesSpecified("m1", "m2");
checkPackagesIncluded("m1pub", "m2pub");
@@ -109,7 +108,7 @@
.classes("package m2pub; /** Klass A */ public class A {}")
.classes("package m2pro; /** Klass B */ public class B {}")
.write(src);
- execTask("-modulesourcepath", src.toString(),
+ execTask("--module-source-path", src.toString(),
"--module", "m1",
"--module", "m2");
checkModulesSpecified("m1", "m2");
@@ -152,7 +151,7 @@
.classes("package p; public class Main { openO.O o; openN.N n; openL.L l; }")
.write(src);
- execTask("-modulesourcepath", src.toString(),
+ execTask("--module-source-path", src.toString(),
"--module", "M");
checkModulesSpecified("M");
@@ -176,7 +175,7 @@
.classes("package p; public class Main { openO.O o; openN.N n; openL.L l; }")
.write(src);
- execTask("-modulesourcepath", src.toString(),
+ execTask("--module-source-path", src.toString(),
"--module", "M",
"--expand-requires:public");
@@ -201,7 +200,7 @@
.classes("package p; public class Main { openO.O o; openN.N n; openL.L l; }")
.write(src);
- execTask("-modulesourcepath", src.toString(),
+ execTask("--module-source-path", src.toString(),
"--module", "M",
"--expand-requires:all");
@@ -229,7 +228,7 @@
.classes("package p; public class Main { openO.O o; openN.N n; openL.L l; }")
.write(src);
- execNegativeTask("-modulesourcepath", src.toString(),
+ execNegativeTask("--module-source-path", src.toString(),
"--module", "MIA",
"--expand-requires:all");
@@ -251,7 +250,7 @@
.classes("package p; public class Main { openO.O o; openN.N n; openL.L l; }")
.write(src);
- execNegativeTask("-modulesourcepath", src.toString(),
+ execNegativeTask("--module-source-path", src.toString(),
"--module", "M,N,L,MIA,O,P",
"--expand-requires:all");
--- a/langtools/test/jdk/javadoc/tool/modules/PackageOptions.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/javadoc/tool/modules/PackageOptions.java Tue Aug 30 08:45:21 2016 -0700
@@ -27,7 +27,6 @@
* @summary Test modules with packages and subpackages filtering
* @modules
* jdk.javadoc/jdk.javadoc.internal.api
- * jdk.javadoc/jdk.javadoc.internal.doclets.standard
* jdk.javadoc/jdk.javadoc.internal.tool
* jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
@@ -52,8 +51,8 @@
@Test
public void testExportedNonQualifiedPackagesLegacyMode(Path base) throws Exception {
- execTask("-modulesourcepath", createSources(base.resolve("src")),
- "-addmods", "m1",
+ execTask("--module-source-path", createSources(base.resolve("src")),
+ "--add-modules", "m1",
"m1pub");
checkModulesNotSpecified("m1");
@@ -64,8 +63,8 @@
@Test
public void testExportedQualifiedPackagesLegacyMode(Path base) throws Exception {
- execTask("-modulesourcepath", createSources(base.resolve("src")),
- "-addmods", "m1",
+ execTask("--module-source-path", createSources(base.resolve("src")),
+ "--add-modules", "m1",
"m1/m1pub");
checkModulesNotSpecified("m1");
@@ -76,8 +75,8 @@
@Test
public void testNonExportedQualifedPackagesLegacyMode(Path base) throws Exception {
- execTask("-modulesourcepath", createSources(base.resolve("src")),
- "-addmods", "m1",
+ execTask("--module-source-path", createSources(base.resolve("src")),
+ "--add-modules", "m1",
"m1/m1pro.pro1" /* not exported, therefore qualify with module */);
checkModulesNotSpecified("m1");
@@ -92,8 +91,8 @@
public void testTypesLegacyMode(Path base) throws Exception {
Path srcPath = base.resolve("src");
Path typPath = srcPath.resolve("m1/m1pub/A.java");
- execTask("-modulesourcepath", createSources(srcPath),
- "-addmods", "m1",
+ execTask("--module-source-path", createSources(srcPath),
+ "--add-modules", "m1",
typPath.toString());
checkModulesNotSpecified("m1");
checkModulesIncluded("m1");
@@ -109,8 +108,8 @@
public void testSubclassedTypesLegacyMode(Path base) throws Exception {
Path srcPath = base.resolve("src");
Path typPath = srcPath.resolve("m1/m1pub/B.java");
- execTask("-modulesourcepath", createSources(srcPath),
- "-addmods", "m1",
+ execTask("--module-source-path", createSources(srcPath),
+ "--add-modules", "m1",
typPath.toString());
checkModulesNotSpecified("m1");
checkModulesIncluded("m1");
@@ -124,7 +123,7 @@
@Test
public void testDefaultPackages(Path base) throws Exception {
- execTask("-modulesourcepath", createSources(base.resolve("src")),
+ execTask("--module-source-path", createSources(base.resolve("src")),
"--module", "m1");
checkModulesSpecified("m1");
@@ -149,20 +148,20 @@
// I/O error encounted during the iteration
throw ex.getCause();
}
- execTask("-modulesourcepath", src.toString(),
+ execTask("--module-source-path", src.toString(),
"-subpackages", "m1/m1pro");
checkPackagesSpecified("m1pro", "m1pro.pro1", "m1pro.pro2");
// empty package directory should cause an error
- execNegativeTask("-modulesourcepath", src.toString(),
+ execNegativeTask("--module-source-path", src.toString(),
"m1/m1pro");
}
@Test
public void testExportedQualifiedSubpackageWithMultipleModules(Path base) throws Exception {
- execTask("-modulesourcepath", createSources(base.resolve("src"), 2),
+ execTask("--module-source-path", createSources(base.resolve("src"), 2),
"--module", "m1",
"-subpackages", "m1/m1pro.pro1:m1/m1pro.pro2:m2/m2pub.pub1");
@@ -177,7 +176,7 @@
@Test
public void testUnexportedUnqualifiedSubpackages(Path base) throws Exception {
- execNegativeTask("-modulesourcepath", createSources(base.resolve("src")),
+ execNegativeTask("--module-source-path", createSources(base.resolve("src")),
"--module", "m1",
"-subpackages", "m1pub.pub1:pro");
@@ -186,7 +185,7 @@
@Test
public void testUnexportedQualifiedPackage(Path base) throws Exception {
- execTask("-modulesourcepath", createSources(base.resolve("src")),
+ execTask("--module-source-path", createSources(base.resolve("src")),
"--module", "m1",
"m1/m1pro");
@@ -201,7 +200,7 @@
@Test
public void testUnexportedQualifiedSubpackage(Path base) throws Exception {
- execTask("-modulesourcepath", createSources(base.resolve("src")),
+ execTask("--module-source-path", createSources(base.resolve("src")),
"--module", "m1",
"-subpackages", "m1/m1pro");
@@ -216,7 +215,7 @@
@Test
public void testUnexportedQualifiedSubpackageExcludeQualified(Path base) throws Exception {
- execTask("-modulesourcepath", createSources(base.resolve("src")),
+ execTask("--module-source-path", createSources(base.resolve("src")),
"--module", "m1",
"-subpackages", "m1/m1pro",
"-exclude", "m1/m1pro.pro1.pro11:m1/m1pro.pro2.pro21");
@@ -233,7 +232,7 @@
@Test
public void testUnexportedQualifiedSubpackageExcludeUnqualified(Path base) throws Exception {
- execTask("-modulesourcepath", createSources(base.resolve("src")),
+ execTask("--module-source-path", createSources(base.resolve("src")),
"--module", "m1",
"-subpackages", "m1/m1pro",
"-exclude", "m1pro.pro1.pro11:m1pro.pro2.pro21");
@@ -250,7 +249,7 @@
@Test
public void testUnexportedQualifiedSubpackages(Path base) throws Exception {
- execTask("-modulesourcepath", createSources(base.resolve("src")),
+ execTask("--module-source-path", createSources(base.resolve("src")),
"--module", "m1",
"-subpackages", "m1/m1pro.pro1:m1/m1pro.pro2");
--- a/langtools/test/jdk/jshell/CommandCompletionTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/jshell/CommandCompletionTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -58,7 +58,7 @@
}
public void testList() {
- test(false, new String[] {"-nostartup"},
+ test(false, new String[] {"--no-startup"},
a -> assertCompletion(a, "/l|", false, "/list "),
a -> assertCompletion(a, "/list |", false, "-all ", "-history ", "-start "),
a -> assertCompletion(a, "/list -h|", false, "-history "),
@@ -70,7 +70,7 @@
}
public void testDrop() {
- test(false, new String[] {"-nostartup"},
+ test(false, new String[] {"--no-startup"},
a -> assertCompletion(a, "/d|", false, "/drop "),
a -> assertClass(a, "class cTest {}", "class", "cTest"),
a -> assertMethod(a, "int mTest() { return 0; }", "()I", "mTest"),
@@ -81,7 +81,7 @@
}
public void testEdit() {
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
a -> assertCompletion(a, "/e|", false, "/edit ", "/exit "),
a -> assertCompletion(a, "/ed|", false, "/edit "),
a -> assertClass(a, "class cTest {}", "class", "cTest"),
--- a/langtools/test/jdk/jshell/EditorTestBase.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/jshell/EditorTestBase.java Tue Aug 30 08:45:21 2016 -0700
@@ -42,7 +42,7 @@
public abstract void shutdownEditor();
public void testEditor(ReplTest... tests) {
- testEditor(false, new String[]{"-nostartup"}, tests);
+ testEditor(false, new String[]{"--no-startup"}, tests);
}
public void testEditor(boolean defaultStartup, String[] args, ReplTest... tests) {
@@ -71,7 +71,7 @@
@Test
public void testEditNegative() {
for (String edit : new String[] {"/ed", "/edit"}) {
- test(new String[]{"-nostartup"},
+ test(new String[]{"--no-startup"},
a -> assertCommandOutputStartsWith(a, edit + " 1",
"| No such snippet: 1"),
a -> assertCommandOutputStartsWith(a, edit + " unknown",
--- a/langtools/test/jdk/jshell/ExternalEditorTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/jshell/ExternalEditorTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -203,7 +203,7 @@
@Test(enabled = false) // TODO 8159229
public void testRemoveTempFile() {
- test(new String[]{"-nostartup"},
+ test(new String[]{"--no-startup"},
a -> assertCommandCheckOutput(a, "/set editor " + executionScript,
assertStartsWith("| Editor set to: " + executionScript)),
a -> assertVariable(a, "int", "a", "0", "0"),
--- a/langtools/test/jdk/jshell/StartOptionTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/jshell/StartOptionTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -22,7 +22,7 @@
*/
/*
- * @test 8151754 8080883
+ * @test 8151754 8080883 8160089
* @summary Testing start-up options.
* @modules jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
@@ -106,53 +106,68 @@
@Test
public void testUsage() throws Exception {
- start(s -> {
- assertTrue(s.split("\n").length >= 7, "Not enough usage lines: " + s);
- assertTrue(s.startsWith("Usage: jshell <options>"), "Unexpect usage start: " + s);
- }, null, "-help");
+ for (String opt : new String[]{"-h", "--help"}) {
+ start(s -> {
+ assertTrue(s.split("\n").length >= 7, "Not enough usage lines: " + s);
+ assertTrue(s.startsWith("Usage: jshell <options>"), "Unexpect usage start: " + s);
+ }, null, opt);
+ }
}
@Test
public void testUnknown() throws Exception {
- start(s -> {
- assertTrue(s.split("\n").length >= 7, "Not enough usage lines (unknown): " + s);
- assertTrue(s.startsWith("Usage: jshell <options>"), "Unexpect usage start (unknown): " + s);
- }, s -> assertEquals(s.trim(), "Unknown option: -unknown"), "-unknown");
+ start(s -> { },
+ s -> assertEquals(s.trim(), "Unknown option: u"), "-unknown");
+ start(s -> { },
+ s -> assertEquals(s.trim(), "Unknown option: unknown"), "--unknown");
}
public void testStartup() throws Exception {
Compiler compiler = new Compiler();
Path p = compiler.getPath("file.txt");
compiler.writeToFile(p);
- start("", "'-startup' requires a filename argument.", "-startup");
- start("", "Only one -startup or -nostartup option may be used.", "-startup", p.toString(), "-startup", p.toString());
- start("", "Only one -startup or -nostartup option may be used.", "-nostartup", "-startup", p.toString());
- start("", "Only one -startup or -nostartup option may be used.", "-startup", p.toString(), "-nostartup");
- start("", "Only one -startup or -nostartup option may be used.", "-nostartup", "-nostartup");
- start("", "Only one -startup or -nostartup option may be used.", "-nostartup", "-startup");
+ start("", "Argument to startup missing.", "--startup");
+ start("", "Only one --startup or --no-startup option may be used.", "--startup", p.toString(), "--startup", p.toString());
+ start("", "Only one --startup or --no-startup option may be used.", "--no-startup", "--startup", p.toString());
+ start("", "Only one --startup or --no-startup option may be used.", "--startup", p.toString(), "--no-startup");
+ start("", "Argument to startup missing.", "--no-startup", "--startup");
}
public void testStartupUnknown() throws Exception {
- start("", "File 'UNKNOWN' for '-startup' is not found.", "-startup", "UNKNOWN");
+ start("", "File 'UNKNOWN' for '--startup' is not found.", "--startup", "UNKNOWN");
}
@Test
public void testClasspath() throws Exception {
- for (String cp : new String[] {"-cp", "-classpath"}) {
- start("", "Conflicting -classpath option.", cp, ".", "-classpath", ".");
- start("", "Argument to -classpath missing.", cp);
+ for (String cp : new String[] {"--class-path"}) {
+ start("", "Only one --class-path option may be used.", cp, ".", "--class-path", ".");
+ start("", "Argument to class-path missing.", cp);
}
}
@Test
+ public void testFeedbackOptionConflict() throws Exception {
+ start("", "Only one feedback option (--feedback, -q, -s, or -v) may be used.",
+ "--feedback", "concise", "--feedback", "verbose");
+ start("", "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "--feedback", "concise", "-s");
+ start("", "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "--feedback", "verbose", "-q");
+ start("", "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "--feedback", "concise", "-v");
+ start("", "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "-v", "--feedback", "concise");
+ start("", "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "-q", "-v");
+ start("", "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "-s", "-v");
+ start("", "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "-v", "-q");
+ start("", "Only one feedback option (--feedback, -q, -s, or -v) may be used.", "-q", "-s");
+ }
+
+ @Test
public void testNegFeedbackOption() throws Exception {
- start("", "Argument to -feedback missing. Mode required.", "-feedback");
- start("", "Does not match any current feedback mode: blorp -- -feedback blorp", "-feedback", "blorp");
+ start("", "Argument to feedback missing.", "--feedback");
+ start("", "Does not match any current feedback mode: blorp -- --feedback blorp", "--feedback", "blorp");
}
@Test
public void testVersion() throws Exception {
- start(s -> assertTrue(s.startsWith("jshell"), "unexpected version: " + s), null, "-version");
+ start(s -> assertTrue(s.startsWith("jshell"), "unexpected version: " + s), null, "--version");
}
@AfterMethod
--- a/langtools/test/jdk/jshell/ToolBasicTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/jshell/ToolBasicTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -97,7 +97,7 @@
public void testInterrupt() {
ReplTest interrupt = (a) -> assertCommand(a, "\u0003", "");
for (String s : new String[] { "", "\u0003" }) {
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
(a) -> assertCommand(a, "int a = 2 +" + s, ""),
interrupt,
(a) -> assertCommand(a, "int a\u0003", ""),
@@ -190,7 +190,7 @@
}
public void testRerun() {
- test(false, new String[] {"-nostartup"},
+ test(false, new String[] {"--no-startup"},
(a) -> assertCommand(a, "/0", "| No such command or snippet id: /0\n| Type /help for help."),
(a) -> assertCommand(a, "/5", "| No such command or snippet id: /5\n| Type /help for help.")
);
@@ -226,7 +226,7 @@
tests.add((a) -> assertCommandCheckOutput(a, "/-" + (2 * finalI + 1), check));
}
tests.add((a) -> assertCommandCheckOutput(a, "/!", assertStartsWith("int a = 0;")));
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
tests.toArray(new ReplTest[tests.size()]));
}
@@ -243,7 +243,7 @@
Path startup = compiler.getPath("StartupFileOption/startup.txt");
compiler.writeToFile(startup, "int assertionCount = 0;\n" + // id: s1
"void add(int n) { assertionCount += n; }");
- test(new String[]{"-startup", startup.toString()},
+ test(new String[]{"--startup", startup.toString()},
(a) -> assertCommand(a, "add(1)", ""), // id: 1
(a) -> assertCommandCheckOutput(a, "add(ONE)", s -> assertEquals(s.split("\n")[0], "| Error:")), // id: e1
(a) -> assertVariable(a, "int", "ONE", "1", "1"),
@@ -252,7 +252,7 @@
assertRerun.apply("/s1").apply("int assertionCount = 0;", 0), assertVariables
);
- test(false, new String[] {"-nostartup"},
+ test(false, new String[] {"--no-startup"},
(a) -> assertCommand(a, "/s1", "| No such command or snippet id: /s1\n| Type /help for help."),
(a) -> assertCommand(a, "/1", "| No such command or snippet id: /1\n| Type /help for help."),
(a) -> assertCommand(a, "/e1", "| No such command or snippet id: /e1\n| Type /help for help.")
@@ -268,10 +268,7 @@
(a) -> assertCommand(a, "/classpath " + classpath, String.format("| Path '%s' added to classpath", classpath)),
(a) -> evaluateExpression(a, "pkg.A", "new pkg.A();", "A")
);
- test(new String[] { "-cp", classpath.toString() },
- (a) -> evaluateExpression(a, "pkg.A", "new pkg.A();", "A")
- );
- test(new String[] { "-classpath", classpath.toString() },
+ test(new String[] { "--class-path", classpath.toString() },
(a) -> evaluateExpression(a, "pkg.A", "new pkg.A();", "A")
);
}
@@ -287,10 +284,7 @@
(a) -> assertCommand(a, "/classpath " + jarPath, String.format("| Path '%s' added to classpath", jarPath)),
(a) -> evaluateExpression(a, "pkg.A", "new pkg.A();", "A")
);
- test(new String[] { "-cp", jarPath.toString() },
- (a) -> evaluateExpression(a, "pkg.A", "new pkg.A();", "A")
- );
- test(new String[] { "-classpath", jarPath.toString() },
+ test(new String[] { "--class-path", jarPath.toString() },
(a) -> evaluateExpression(a, "pkg.A", "new pkg.A();", "A")
);
}
@@ -300,10 +294,10 @@
Compiler compiler = new Compiler();
Path startup = compiler.getPath("StartupFileOption/startup.txt");
compiler.writeToFile(startup, "class A { public String toString() { return \"A\"; } }");
- test(new String[]{"-startup", startup.toString()},
+ test(new String[]{"--startup", startup.toString()},
(a) -> evaluateExpression(a, "A", "new A()", "A")
);
- test(new String[]{"-nostartup"},
+ test(new String[]{"--no-startup"},
(a) -> assertCommandCheckOutput(a, "printf(\"\")", assertStartsWith("| Error:\n| cannot find symbol"))
);
test(
@@ -550,7 +544,7 @@
}
public void testHistoryReference() {
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
a -> assertCommand(a, "System.err.println(1)", "", "", null, "", "1\n"),
a -> assertCommand(a, "System.err.println(2)", "", "", null, "", "2\n"),
a -> assertCommand(a, "/-2", "System.err.println(1)", "", null, "", "1\n"),
--- a/langtools/test/jdk/jshell/ToolCommandOptionTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/jshell/ToolCommandOptionTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -23,7 +23,7 @@
/*
* @test
- * @bug 8157395 8157393 8157517
+ * @bug 8157395 8157393 8157517 8158738
* @summary Tests of jshell comand options, and undoing operations
* @modules jdk.jshell/jdk.internal.jshell.tool
* @build ToolCommandOptionTest ReplToolTesting
@@ -88,7 +88,7 @@
}
public void dropTest() {
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
(a) -> assertCommand(a, "int x = 5;",
"x ==> 5"),
(a) -> assertCommand(a, "x",
@@ -148,6 +148,8 @@
"| Unknown option: -furball -mattress -- /retain editor -furball -mattress"),
(a) -> assertCommand(a, "/retain editor -default prog",
"| Specify -default option or program, not both -- /retain editor -default prog"),
+ (a) -> assertCommand(a, "/retain editor -default -wait",
+ "| -wait applies to external editors, cannot be used with -default"),
(a) -> assertCommand(a, "/retain editor prog",
"| Editor set to: prog"),
(a) -> assertCommand(a, "/retain editor prog -default",
--- a/langtools/test/jdk/jshell/ToolLocaleMessageTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/jshell/ToolLocaleMessageTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -44,7 +44,7 @@
public class ToolLocaleMessageTest extends ReplToolTesting {
void testLocale(ReplTest... tests) {
- test(Locale.getDefault(), false, new String[]{"-nostartup"}, "", tests);
+ test(Locale.getDefault(), false, new String[]{"--no-startup"}, "", tests);
}
void assertCommandOK(boolean after, String cmd, String... contains) {
--- a/langtools/test/jdk/jshell/ToolReloadTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/jshell/ToolReloadTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -90,7 +90,7 @@
}
public void testReloadDrop() {
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
a -> assertVariable(a, "int", "a"),
a -> dropVariable(a, "/dr 1", "int a = 0", "| dropped variable a"),
a -> assertMethod(a, "int b() { return 0; }", "()I", "b"),
@@ -113,7 +113,7 @@
}
public void testReloadQuiet() {
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
a -> assertVariable(a, "int", "a"),
a -> dropVariable(a, "/dr 1", "int a = 0", "| dropped variable a"),
a -> assertMethod(a, "int b() { return 0; }", "()I", "b"),
@@ -130,7 +130,7 @@
}
public void testReloadRepeat() {
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
(a) -> assertVariable(a, "int", "c", "7", "7"),
(a) -> assertCommand(a, "++c", null),
(a) -> assertCommand(a, "/!", null),
@@ -150,7 +150,7 @@
}
public void testReloadIgnore() {
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
(a) -> assertCommand(a, "(-)", null),
(a) -> assertCommand(a, "/list", null),
(a) -> assertCommand(a, "/history", null),
@@ -201,13 +201,13 @@
}
public void testReloadExitRestore() {
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
(a) -> assertVariable(a, "int", "x", "5", "5"),
(a) -> assertMethod(a, "int m(int z) { return z * z; }",
"(int)int", "m"),
(a) -> evaluateExpression(a, "int", "m(x)", "25")
);
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
(a) -> assertCommand(a, "/reload -restore",
"| Restarting and restoring from previous state.\n" +
"-: int x = 5;\n" +
--- a/langtools/test/jdk/jshell/ToolSimpleTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/jdk/jshell/ToolSimpleTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -23,7 +23,7 @@
/*
* @test
- * @bug 8153716 8143955 8151754 8150382 8153920 8156910 8131024
+ * @bug 8153716 8143955 8151754 8150382 8153920 8156910 8131024 8160089 8153897
* @summary Simple jshell tool tests
* @modules jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
@@ -157,7 +157,6 @@
);
}
- @Test(enabled = false) // TODO 8153897
public void defineUnresolvedVar() {
test(
(a) -> assertCommand(a, "undefined x",
@@ -209,7 +208,7 @@
}
public void testDrop() {
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
a -> assertVariable(a, "int", "a"),
a -> dropVariable(a, "/drop 1", "int a = 0", "| dropped variable a"),
a -> assertMethod(a, "int b() { return 0; }", "()I", "b"),
@@ -223,7 +222,7 @@
a -> assertCommandCheckOutput(a, "/types", assertClasses()),
a -> assertCommandCheckOutput(a, "/imports", assertImports())
);
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
a -> assertVariable(a, "int", "a"),
a -> dropVariable(a, "/drop a", "int a = 0", "| dropped variable a"),
a -> assertMethod(a, "int b() { return 0; }", "()I", "b"),
@@ -238,7 +237,7 @@
}
public void testDropNegative() {
- test(false, new String[]{"-nostartup"},
+ test(false, new String[]{"--no-startup"},
a -> assertCommandOutputStartsWith(a, "/drop 0", "| No such snippet: 0"),
a -> assertCommandOutputStartsWith(a, "/drop a", "| No such snippet: a"),
a -> assertCommandCheckOutput(a, "/drop",
@@ -462,20 +461,20 @@
}
public void testOptionQ() {
- test(new String[]{"-q", "-nostartup"},
+ test(new String[]{"-q", "--no-startup"},
(a) -> assertCommand(a, "1+1", "$1 ==> 2"),
(a) -> assertCommand(a, "int x = 5", "")
);
}
- public void testOptionQq() {
- test(new String[]{"-qq", "-nostartup"},
+ public void testOptionS() {
+ test(new String[]{"-s", "--no-startup"},
(a) -> assertCommand(a, "1+1", "")
);
}
public void testOptionV() {
- test(new String[]{"-v", "-nostartup"},
+ test(new String[]{"-v", "--no-startup"},
(a) -> assertCommand(a, "1+1",
"$1 ==> 2\n" +
"| created scratch variable $1 : int")
@@ -483,14 +482,36 @@
}
public void testOptionFeedback() {
- test(new String[]{"-feedback", "concise", "-nostartup"},
+ test(new String[]{"--feedback", "concise", "--no-startup"},
(a) -> assertCommand(a, "1+1", "$1 ==> 2"),
(a) -> assertCommand(a, "int x = 5", "")
);
}
+ public void testCompoundOptions() {
+ Consumer<String> confirmNoStartup = s -> {
+ assertEquals(0, Stream.of(s.split("\n"))
+ .filter(l -> !l.isEmpty())
+ .count(), "Expected no lines: " + s);
+ };
+ test(new String[]{"-nq"},
+ (a) -> assertCommandCheckOutput(a, "/list -all", confirmNoStartup),
+ (a) -> assertCommand(a, "1+1", "$1 ==> 2"),
+ (a) -> assertCommand(a, "int x = 5", "")
+ );
+ test(new String[]{"-qn"},
+ (a) -> assertCommandCheckOutput(a, "/list -all", confirmNoStartup),
+ (a) -> assertCommand(a, "1+1", "$1 ==> 2"),
+ (a) -> assertCommand(a, "int x = 5", "")
+ );
+ test(new String[]{"-ns"},
+ (a) -> assertCommandCheckOutput(a, "/list -all", confirmNoStartup),
+ (a) -> assertCommand(a, "1+1", "")
+ );
+ }
+
public void testOptionR() {
- test(new String[]{"-R-Dthe.sound=blorp", "-nostartup"},
+ test(new String[]{"-R-Dthe.sound=blorp", "--no-startup"},
(a) -> assertCommand(a, "System.getProperty(\"the.sound\")",
"$1 ==> \"blorp\"")
);
--- a/langtools/test/tools/javac/InnerClassesAttribute/Test.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/InnerClassesAttribute/Test.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2015 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/javac/T8047338/FilterNonMembersToObtainFunctionDescriptorTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 8047338
+ * @summary javac is not correctly filtering non-members methods to obtain the function descriptor
+ * @compile FilterNonMembersToObtainFunctionDescriptorTest.java
+ */
+
+public class FilterNonMembersToObtainFunctionDescriptorTest {
+ <V, E extends Exception> V fails(CallableFail<V, E> callable) throws E {
+ return null;
+ }
+
+ <V, E extends Exception> V failsSub(CallableFailSub<V, E> callable) throws E {
+ return null;
+ }
+
+ void m() throws Exception {
+ fails((String s) -> 2);
+ failsSub((String s) -> 2);
+ }
+
+ interface Callable<V> {
+ V callFail(String s) throws Exception;
+ }
+
+ interface CallableFail<V, E extends Exception> extends Callable<V> {
+ @Override
+ V callFail(String s) throws E;
+ }
+
+ interface CallableFailSub<V, E extends Exception> extends CallableFail<V, E> {}
+}
--- a/langtools/test/tools/javac/VersionOpt.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/VersionOpt.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -44,7 +44,7 @@
// Test functions by comparing the version string from javac against
// a "golden" version generated automatically from the underlying JVM.
// As such, it is only effective in testing the "standard" compiler,
- // and not any development version being tested via -Xpatch.
+ // and not any development version being tested via --patch-modules.
// Check the version of the compiler being used, and let the test pass
// automatically if is is a development version.
Class<?> javacClass = com.sun.tools.javac.Main.class;
--- a/langtools/test/tools/javac/diags/examples/DirPathElementNotDirectory/modulesourcepath Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/diags/examples/DirPathElementNotDirectory/modulesourcepath Tue Aug 30 08:45:21 2016 -0700
@@ -21,5 +21,5 @@
* questions.
*/
-// a file to be passed in where a directory is expected (-modulesourcepath option)
+// a file to be passed in where a directory is expected (--module-source-path option)
// to trigger an error deliberately.
--- a/langtools/test/tools/javac/diags/examples/ModuleNotFoundInModuleSourcePath/ModuleNotFoundInModuleSourcePath.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/diags/examples/ModuleNotFoundInModuleSourcePath/ModuleNotFoundInModuleSourcePath.java Tue Aug 30 08:45:21 2016 -0700
@@ -22,6 +22,6 @@
*/
// key: compiler.err.module.not.found.in.module.source.path
-// options: -m m1 -modulesourcepath src
+// options: -m m1 --module-source-path src
class ModuleNotFoundInModuleSourcePath {}
--- a/langtools/test/tools/javac/diags/examples/XModuleWithModulePath/XModuleWithModulePath.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/diags/examples/XModuleWithModulePath/XModuleWithModulePath.java Tue Aug 30 08:45:21 2016 -0700
@@ -22,6 +22,6 @@
*/
// key: compiler.err.xmodule.no.module.sourcepath
-// options: -Xmodule:java.compiler -modulesourcepath src
+// options: -Xmodule:java.compiler --module-source-path src
class XModuleWithModulePath {}
--- a/langtools/test/tools/javac/file/LimitedImage.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/file/LimitedImage.java Tue Aug 30 08:45:21 2016 -0700
@@ -28,7 +28,7 @@
* @library /tools/lib
* @modules jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
- * @run main/othervm -limitmods jdk.compiler LimitedImage
+ * @run main/othervm --limit-modules jdk.compiler LimitedImage
*/
import java.io.IOException;
@@ -133,4 +133,4 @@
}
}
-}
\ No newline at end of file
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/javac/generics/inference/8164399/T8164399.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 8164399
+ * @summary inference of thrown variable does not work correctly
+ * @compile T8164399.java
+ */
+
+abstract class T8164399 {
+
+ interface ThrowableRunnable<E extends Throwable> {
+ void compute() throws E;
+ }
+
+ public abstract < E extends Exception> void computeException(ThrowableRunnable<E> process) throws E;
+
+
+ public static <T, E extends Throwable> T compute(ThrowableRunnable<E> action) throws E {
+ return null;
+ }
+
+ {
+ computeException(() -> compute(() -> {}));
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/javac/generics/inference/8164399/T8164399b.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,21 @@
+/*
+ * @test /nodynamiccopyright/
+ * @bug 8164399
+ * @summary inference of thrown variable does not work correctly
+ * @compile/fail/ref=T8164399b.out -XDrawDiagnostics T8164399b.java
+ */
+class T8164399b<X extends Throwable> {
+ <T extends Throwable> void m(Class<? super T> arg) throws T {}
+ <T extends X> void g() throws T {}
+
+ void test() {
+ m(RuntimeException.class); // ok
+ m(Exception.class); // error
+ m(Throwable.class); // ok
+ m(java.io.Serializable.class); // error
+ m(Object.class); // error
+ m(Runnable.class); // error
+ T8164399b<? super Exception> x = null;
+ x.g(); // expected: ok; actual: error
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/javac/generics/inference/8164399/T8164399b.out Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,2 @@
+T8164399b.java:17:10: compiler.err.unreported.exception.need.to.catch.or.throw: java.lang.Throwable&java.lang.Runnable
+1 error
--- a/langtools/test/tools/javac/modules/GraphsTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/modules/GraphsTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -194,7 +194,7 @@
.write(modSrc);
String log = new JavacTask(tb)
.options("-XDrawDiagnostics",
- "-modulesourcepath", modSrc.toString())
+ "--module-source-path", modSrc.toString())
.outdir(Files.createDirectories(base.resolve("negative")))
.files(findJavaFiles(modSrc))
.run(Task.Expect.FAIL)
--- a/langtools/test/tools/javac/modules/ModuleSourcePathTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/modules/ModuleSourcePathTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -23,7 +23,7 @@
/*
* @test
- * @summary tests for -modulesourcepath
+ * @summary tests for --module-source-path
* @library /tools/lib
* @modules
* jdk.compiler/com.sun.tools.javac.api
--- a/langtools/test/tools/javac/modules/NPEEmptyFileTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/modules/NPEEmptyFileTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -23,7 +23,7 @@
/**
* @test
- * @summary NPE while compiling empty javafile with -modulesourcepath option
+ * @summary NPE while compiling empty source file with --module-source-path option
* @library /tools/lib
* @modules
* jdk.compiler/com.sun.tools.javac.api
--- a/langtools/test/tools/javac/modules/SingleModuleModeTest.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/modules/SingleModuleModeTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2015-2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/javac/modules/T8161501/EmptyClass.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package pkg1;
+
+class EmptyClass {}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/javac/modules/T8161501/UnnamedModuleUnnamedPackageTest.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 8161501
+ * @summary JSR269 jigsaw update: javax.lang.model.element.ModuleElement.getEnclosedElements() on unnamed module with unnamed package
+ * @compile UnnamedModuleUnnamedPackageTest.java
+ * @compile -processor UnnamedModuleUnnamedPackageTest UnnamedModuleUnnamedPackageTest.java EmptyClass.java
+ */
+
+import javax.annotation.processing.AbstractProcessor;
+import javax.annotation.processing.RoundEnvironment;
+import javax.annotation.processing.SupportedAnnotationTypes;
+import javax.lang.model.SourceVersion;
+import javax.lang.model.element.*;
+
+import java.util.*;
+import java.util.stream.Collectors;
+
+@SupportedAnnotationTypes("*")
+public class UnnamedModuleUnnamedPackageTest extends AbstractProcessor {
+ static final Set<String> expected = new HashSet<>(Arrays.asList("unnamed package", "pkg1"));
+
+ @Override
+ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
+ for (Element e: roundEnv.getRootElements()) {
+ Element m = e.getEnclosingElement();
+ while (!(m instanceof ModuleElement)) {
+ m = m.getEnclosingElement();
+ }
+ Set<String> found = m.getEnclosedElements().stream()
+ .map(p -> ((PackageElement)p).isUnnamed() ?
+ "unnamed package" :
+ ((PackageElement)p).getQualifiedName().toString())
+ .collect(Collectors.toSet());
+ if (!Objects.equals(expected, found)) {
+ System.err.println("expected: " + expected);
+ System.err.println("found: " + found);
+ throw new AssertionError("unexpected packages found");
+ }
+ }
+ return false;
+ }
+
+ @Override
+ public SourceVersion getSupportedSourceVersion() {
+ return SourceVersion.latest();
+ }
+}
--- a/langtools/test/tools/javac/redefineObject/Object1-test.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/redefineObject/Object1-test.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997,2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
--- a/langtools/test/tools/javac/redefineObject/Object2-test.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/javac/redefineObject/Object2-test.java Tue Aug 30 08:45:21 2016 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997,2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/cases/jdk/deprcases/members/ExampleAnnotation.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.deprcases.members;
+
+import java.lang.annotation.*;
+import static java.lang.annotation.ElementType.*;
+
+@Retention(value=RetentionPolicy.RUNTIME)
+@Target({TYPE, METHOD, FIELD})
+public @interface ExampleAnnotation {
+ String file();
+ @Deprecated String name() default "";
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/cases/jdk/deprcases/members/ExampleClass.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.deprcases.members;
+
+public class ExampleClass {
+ public ExampleClass() { }
+
+ @Deprecated
+ public ExampleClass(boolean deprecatedConstructor) { }
+
+ @Deprecated
+ public void method1() { }
+
+ @Deprecated
+ public void method2() { }
+
+ @Deprecated
+ public int field1 = 0;
+
+ @Deprecated
+ public int field2 = 0;
+
+ @Deprecated
+ public static void staticmethod1() { }
+
+ @Deprecated
+ public static int staticfield3 = 0;
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/cases/jdk/deprcases/members/ExampleElements.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.deprcases.members;
+
+public class ExampleElements {
+ @Deprecated
+ Object emptyFalse;
+
+ @Deprecated(since="xyzzy")
+ Object sinceFalse;
+
+ @Deprecated(forRemoval=true)
+ Object emptyTrue;
+
+ @Deprecated(since="plugh", forRemoval=true)
+ Object sinceTrue;
+
+ @Deprecated(since="123,456")
+ Object sinceWithComma;
+
+ @Deprecated(since="7.9 \"pre-beta\" snapshot")
+ Object sinceWithQuote;
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/cases/jdk/deprcases/members/ExampleEnum.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.deprcases.members;
+
+public enum ExampleEnum {
+ ONE,
+ TWO {
+ @Override
+ public void deprMethod1() { }
+ @Override @Deprecated
+ public void deprMethod2() { }
+ },
+ @Deprecated THREE,
+ FOUR,
+ @Deprecated FIVE;
+
+ @Deprecated
+ public void deprMethod1() { }
+
+ public void deprMethod2() { }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/cases/jdk/deprcases/members/ExampleInterface.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.deprcases.members;
+
+public interface ExampleInterface {
+ @Deprecated
+ static final int DEP_FIELD1 = 1;
+
+ @Deprecated
+ static final int DEP_FIELD2 = 2;
+
+ @Deprecated
+ void interfaceMethod1();
+
+ @Deprecated
+ void interfaceMethod2();
+
+ @Deprecated
+ default void defaultMethod() { }
+
+ @Deprecated
+ static void staticmethod2() { }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/cases/jdk/deprcases/members/ExampleSubclass.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.deprcases.members;
+
+public abstract class ExampleSubclass extends ExampleClass implements ExampleInterface {
+ @Override
+ public void method1() { }
+
+ // hides ExampleClass.field1
+ public Object field1 = null;
+
+ @Override
+ public void interfaceMethod2() {
+ }
+
+ // hides ExampleInterface.DEP_FIELD1
+ public Object DEP_FIELD1 = null;
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/cases/jdk/deprcases/types/DeprecatedAnnotation.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.deprcases.types;
+
+import java.lang.annotation.*;
+import static java.lang.annotation.ElementType.*;
+
+@Retention(value=RetentionPolicy.RUNTIME)
+@Target({TYPE, METHOD, FIELD})
+@Deprecated
+public @interface DeprecatedAnnotation {
+ String file() default "x";
+ String value() default "y";
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/cases/jdk/deprcases/types/DeprecatedClass.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.deprcases.types;
+
+@Deprecated
+public class DeprecatedClass {
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/cases/jdk/deprcases/types/DeprecatedEnum.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.deprcases.types;
+
+@Deprecated
+public enum DeprecatedEnum {
+ FIRST,
+ SECOND,
+ THIRD
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/cases/jdk/deprcases/types/DeprecatedException.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.deprcases.types;
+
+@Deprecated
+public class DeprecatedException extends RuntimeException {
+ private static final long serialVersionUID = 0L;
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/cases/jdk/deprcases/types/DeprecatedInterface.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.deprcases.types;
+
+@Deprecated
+public interface DeprecatedInterface {
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/tests/jdk/jdeprscan/TestCSV.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,144 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @summary Basic tests CSV printing and parsing
+ * @modules jdk.jdeps/com.sun.tools.jdeprscan
+ * @build TestCSV
+ * @run testng jdk.jdeprscan.TestCSV
+ */
+
+package jdk.jdeprscan;
+
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import java.io.UnsupportedEncodingException;
+
+import java.util.List;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertTrue;
+
+import com.sun.tools.jdeprscan.CSV;
+import com.sun.tools.jdeprscan.CSVParseException;
+
+@Test
+public class TestCSV {
+ static String NL = System.lineSeparator();
+ ByteArrayOutputStream baos;
+ PrintStream out;
+
+ @BeforeMethod
+ public void setup() throws UnsupportedEncodingException {
+ baos = new ByteArrayOutputStream();
+ out = new PrintStream(baos, true, "UTF-8");
+ }
+
+ String result() {
+ out.flush();
+ return new String(baos.toByteArray(), java.nio.charset.StandardCharsets.UTF_8);
+ }
+
+ /**
+ * Asserts string equality after checking for and removing a trailing line separator.
+ *
+ * @param expected expected result
+ */
+ void checkString(String expected) {
+ String actual = result();
+ assertTrue(actual.endsWith(NL));
+ assertEquals(actual.substring(0, actual.length() - NL.length()), expected);
+ }
+
+ @DataProvider(name = "csvdata")
+ public Object[][] getCSVData() {
+ return new Object[][] {
+ { "", List.of("") },
+ { "a", List.of("a") },
+ { "a,b", List.of("a", "b") },
+ { "a,b,c", List.of("a", "b", "c") },
+ { ",a,b", List.of("", "a", "b") },
+ { "a,b,", List.of("a", "b", "") },
+ { ",a,b,", List.of("", "a", "b", "") },
+ { ",a,,b,", List.of("", "a", "", "b", "") },
+ { ",", List.of("", "") },
+ { ",,", List.of("", "", "") },
+ { ",,,", List.of("", "", "", "") },
+ { " a , b ", List.of(" a ", " b ") },
+ { "a,\",\",b", List.of("a", ",", "b") },
+ { "a,\"b\"\"c\",d", List.of("a", "b\"c", "d") },
+ { "a,\"b,c\",d", List.of("a", "b,c", "d") },
+
+ // from https://en.wikipedia.org/wiki/Comma-separated_values
+ // slightly modified to enable round-tripping
+
+ { "Year,Make,Model,Description,Price",
+ List.of("Year", "Make", "Model", "Description", "Price") },
+ { "1997,Ford,E350,\"ac, abs, moon\",3000.00",
+ List.of("1997", "Ford", "E350", "ac, abs, moon", "3000.00") },
+ { "1999,Chevy,\"Venture \"\"Extended Edition\"\"\",,4900.00",
+ List.of("1999", "Chevy", "Venture \"Extended Edition\"", "", "4900.00") },
+ { "1999,Chevy,\"Venture \"\"Extended Edition, Very Large\"\"\",,5000.00",
+ List.of("1999", "Chevy", "Venture \"Extended Edition, Very Large\"", "", "5000.00") },
+ { "1996,Jeep,Grand Cherokee,\"MUST SELL!\nair, moon roof, loaded\",4799.00",
+ List.of("1996", "Jeep", "Grand Cherokee", "MUST SELL!\nair, moon roof, loaded", "4799.00") }
+ };
+ }
+
+ @Test(dataProvider = "csvdata")
+ public void roundTrip(String input, List<String> parsed) {
+ List<String> actual = CSV.split(input);
+ assertEquals(actual, parsed);
+ CSV.write(out, actual.toArray());
+ checkString(input);
+ }
+
+ // won't round-trip
+ public void testExtraQuote() {
+ assertEquals(CSV.split("a,\"b\",c"), List.of("a", "b", "c"));
+ }
+
+ // won't round-trip
+ public void testEmptyQuote() {
+ assertEquals(CSV.split("a,\"\",b"), List.of("a", "", "b"));
+ }
+
+ @Test(expectedExceptions=CSVParseException.class)
+ public void errorUnexpectedQuote() {
+ CSV.split("ab\"cd");
+ }
+
+ @Test(expectedExceptions=CSVParseException.class)
+ public void errorCharacterAfterQuote() {
+ CSV.split("a,\"b\"c,d");
+ }
+
+ @Test(expectedExceptions=CSVParseException.class)
+ public void errorUnclosedQuote() {
+ CSV.split("a,\"b");
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/tests/jdk/jdeprscan/TestLoad.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,120 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @summary Test of jdeprscan tool loading and printing to aCSV file.
+ * @modules jdk.jdeps/com.sun.tools.jdeprscan
+ * @library ../../../cases
+ * @build jdk.deprcases.members.* jdk.deprcases.types.*
+ * @build jdk.jdeprscan.TestLoad
+ * @run testng jdk.jdeprscan.TestLoad
+ */
+
+package jdk.jdeprscan;
+
+import java.io.BufferedReader;
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.PrintStream;
+import java.io.UnsupportedEncodingException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import com.sun.tools.jdeprscan.Main;
+
+import org.testng.annotations.Test;
+
+import static org.testng.Assert.assertTrue;
+import static org.testng.Assert.assertEquals;
+
+
+public class TestLoad {
+ static final String UTF8 = "UTF-8";
+ static final String EXPECTED = "TestLoadExpected.csv";
+
+ @Test
+ public void test1() throws IOException, UnsupportedEncodingException {
+ String testclasses = System.getProperty("test.classes");
+ String deprcases = testclasses + "/../../../cases";
+ boolean rval;
+
+ System.out.println("test.src = " + System.getProperty("test.src"));
+ ByteArrayOutputStream bout = new ByteArrayOutputStream();
+ ByteArrayOutputStream berr = new ByteArrayOutputStream();
+
+ try (PrintStream prout = new PrintStream(bout, true, UTF8);
+ PrintStream prerr = new PrintStream(berr, true, UTF8)) {
+ System.out.println("Calling JDeprScan --Xprint-csv --Xload-dir " + deprcases);
+ rval = Main.call(prout, prerr, "--Xprint-csv", "--Xload-dir", deprcases);
+ System.out.println("JDeprScan returns " + rval);
+ }
+
+ System.out.println("----- stdout");
+ new ByteArrayInputStream(bout.toByteArray()).transferTo(System.out);
+ System.out.println("----- end stdout");
+ System.out.println("----- stderr");
+ new ByteArrayInputStream(berr.toByteArray()).transferTo(System.out);
+ System.out.println("----- end stderr");
+
+ List<String> actualList;
+ try (ByteArrayInputStream bais = new ByteArrayInputStream(bout.toByteArray());
+ InputStreamReader isr = new InputStreamReader(bais);
+ BufferedReader br = new BufferedReader(isr)) {
+ actualList = br.lines().collect(Collectors.toList());
+ }
+
+ Path expfile = Paths.get(System.getProperty("test.src"), EXPECTED);
+ List<String> expectedList = Files.readAllLines(expfile);
+
+ Set<String> actual = new HashSet<>(actualList.subList(1, actualList.size()));
+ Set<String> expected = new HashSet<>(expectedList.subList(1, expectedList.size()));
+
+ Set<String> diff1 = new HashSet<>(actual);
+ diff1.removeAll(expected);
+ Set<String> diff2 = new HashSet<>(expected);
+ diff2.removeAll(actual);
+ if (diff1.size() > 0) {
+ System.out.println("Extra lines in output:");
+ diff1.forEach(System.out::println);
+ }
+
+ if (diff2.size() > 0) {
+ System.out.println("Lines missing from output:");
+ diff2.forEach(System.out::println);
+ }
+
+ assertTrue(rval);
+ assertEquals(berr.toByteArray().length, 0);
+ assertEquals(actual.size(), actualList.size() - 1);
+ assertEquals(diff1.size(), 0);
+ assertEquals(diff2.size(), 0);
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/tests/jdk/jdeprscan/TestLoadExpected.csv Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,30 @@
+#jdepr 1
+METHOD,jdk/deprcases/members/ExampleAnnotation,name()Ljava/lang/String;,,false
+FIELD,jdk/deprcases/members/ExampleClass,field1,,false
+FIELD,jdk/deprcases/members/ExampleClass,field2,,false
+FIELD,jdk/deprcases/members/ExampleClass,staticfield3,,false
+CONSTRUCTOR,jdk/deprcases/members/ExampleClass,<init>(Z)V,,false
+METHOD,jdk/deprcases/members/ExampleClass,method1()V,,false
+METHOD,jdk/deprcases/members/ExampleClass,method2()V,,false
+METHOD,jdk/deprcases/members/ExampleClass,staticmethod1()V,,false
+METHOD,jdk/deprcases/members/ExampleEnum$1,deprMethod2()V,,false
+ENUM_CONSTANT,jdk/deprcases/members/ExampleEnum,THREE,,false
+ENUM_CONSTANT,jdk/deprcases/members/ExampleEnum,FIVE,,false
+METHOD,jdk/deprcases/members/ExampleEnum,deprMethod1()V,,false
+FIELD,jdk/deprcases/members/ExampleInterface,DEP_FIELD1,,false
+FIELD,jdk/deprcases/members/ExampleInterface,DEP_FIELD2,,false
+METHOD,jdk/deprcases/members/ExampleInterface,interfaceMethod1()V,,false
+METHOD,jdk/deprcases/members/ExampleInterface,interfaceMethod2()V,,false
+METHOD,jdk/deprcases/members/ExampleInterface,defaultMethod()V,,false
+METHOD,jdk/deprcases/members/ExampleInterface,staticmethod2()V,,false
+ANNOTATION_TYPE,jdk/deprcases/types/DeprecatedAnnotation,,,false
+CLASS,jdk/deprcases/types/DeprecatedClass,,,false
+ENUM,jdk/deprcases/types/DeprecatedEnum,,,false
+CLASS,jdk/deprcases/types/DeprecatedException,,,false
+INTERFACE,jdk/deprcases/types/DeprecatedInterface,,,false
+FIELD,jdk/deprcases/members/ExampleElements,emptyFalse,,false
+FIELD,jdk/deprcases/members/ExampleElements,sinceFalse,xyzzy,false
+FIELD,jdk/deprcases/members/ExampleElements,emptyTrue,,true
+FIELD,jdk/deprcases/members/ExampleElements,sinceTrue,plugh,true
+FIELD,jdk/deprcases/members/ExampleElements,sinceWithComma,"123,456",false
+FIELD,jdk/deprcases/members/ExampleElements,sinceWithQuote,"7.9 ""pre-beta"" snapshot",false
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/tests/jdk/jdeprscan/TestMethodSig.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @summary Simple tests for method signature parsing
+ * @modules jdk.jdeps/com.sun.tools.jdeprscan.scan
+ * @build TestMethodSig
+ * @run testng jdk.jdeprscan.TestMethodSig
+ */
+
+package jdk.jdeprscan;
+
+import org.testng.annotations.Test;
+import static org.testng.Assert.assertEquals;
+import static com.sun.tools.jdeprscan.scan.MethodSig.fromDesc;
+
+public class TestMethodSig {
+ @Test
+ public void testSimple() {
+ assertEquals(fromDesc("(Ljava/rmi/RMISecurityManager;)Ljava/lang/Object;").toString(),
+ "parameters 0=Ljava/rmi/RMISecurityManager; return Ljava/lang/Object;");
+ }
+
+ @Test
+ public void testMultParamVoidReturn() {
+ assertEquals(fromDesc("([[IZLjava/lang/String;B[J)V").toString(),
+ "parameters 0=[[I 1=Z 2=Ljava/lang/String; 3=B 4=[J return V");
+ }
+
+ @Test
+ public void testNoParams() {
+ assertEquals(fromDesc("()J").toString(),
+ "parameters none return J");
+ }
+
+ @Test(expectedExceptions = IllegalArgumentException.class)
+ public void testMissingReturnType() {
+ fromDesc("(ISJZ)");
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/tests/jdk/jdeprscan/TestScan.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,110 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @summary Basic test of jdeprscan's scanning phase.
+ * @modules jdk.jdeps/com.sun.tools.jdeprscan
+ * @library ../../../cases
+ * @library ../../../usage
+ * @build jdk.deprcases.members.* jdk.deprcases.types.*
+ * @build jdk.deprusage.*
+ * @build jdk.jdeprscan.TestScan
+ * @run testng jdk.jdeprscan.TestScan
+ */
+
+package jdk.jdeprscan;
+
+import com.sun.tools.jdeprscan.Main;
+import java.io.BufferedReader;
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.stream.Collectors;
+import org.testng.Assert;
+
+import org.testng.annotations.Test;
+
+import static org.testng.Assert.assertTrue;
+
+
+public class TestScan {
+ Set<String> loadExpected() throws IOException {
+ Path expFile = Paths.get(System.getProperty("test.src"), "TestScanExpected.txt");
+ return new HashSet<>(Files.readAllLines(expFile, StandardCharsets.UTF_8));
+ }
+
+ @Test
+ public void testScanAgainstReferenceFile() throws IOException {
+ String testclasses = System.getProperty("test.classes");
+ String deprcases = testclasses + "/../../../cases";
+ String deprusage = testclasses + "/../../../usage";
+
+ Set<String> expected = loadExpected();
+ System.out.println("expected = " + expected);
+
+ ByteArrayOutputStream baos = new ByteArrayOutputStream();
+ try (PrintStream out = new PrintStream(baos, false, "UTF-8")) {
+ boolean r = Main.call(out, System.err,
+ "-cp", deprcases, "--Xload-dir", deprcases, deprusage);
+ assertTrue(r);
+ }
+ byte[] bytes = baos.toByteArray();
+
+ System.out.println("--- output ---");
+ ByteArrayInputStream bais = new ByteArrayInputStream(bytes);
+ bais.transferTo(System.out);
+ System.out.println("--- end output ---");
+
+ Set<String> actual =
+ new BufferedReader(
+ new InputStreamReader(
+ new ByteArrayInputStream(bytes), StandardCharsets.UTF_8))
+ .lines()
+ .map(line -> line.split(" +"))
+ .map(array -> array[1])
+ .collect(Collectors.toSet());
+ System.out.println("actual = " + actual);
+
+ Set<String> diff1 = new HashSet<>(expected);
+ diff1.removeAll(actual);
+ Set<String> diff2 = new HashSet<>(actual);
+ diff2.removeAll(expected);
+
+ if (diff1.size() > 0 || diff2.size() > 0) {
+ System.out.println("missing items: " + diff1);
+ System.out.println("extra items: " + diff2);
+ }
+
+ Assert.assertEquals(diff1.size(), 0);
+ Assert.assertEquals(diff2.size(), 0);
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/tests/jdk/jdeprscan/TestScanExpected.txt Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,47 @@
+jdk/jdeprusage/UseClass$ArrayCreation
+jdk/jdeprusage/UseClass$ArrayFieldUsage
+jdk/jdeprusage/UseClass$ArrayMethodCall
+jdk/jdeprusage/UseClass$Cast
+jdk/jdeprusage/UseClass$ClassLiteral
+jdk/jdeprusage/UseClass$Construct
+jdk/jdeprusage/UseClass$Extends
+jdk/jdeprusage/UseClass$FieldType
+jdk/jdeprusage/UseClass$InstanceOf
+jdk/jdeprusage/UseClass$MethodParameter
+jdk/jdeprusage/UseClass$MethodReturn
+jdk/jdeprusage/UseEnum$ClassObject
+jdk/jdeprusage/UseEnum$EnumConstant
+jdk/jdeprusage/UseEnum$FieldType
+jdk/jdeprusage/UseEnum$MethodParameter
+jdk/jdeprusage/UseEnum$ReturnValue
+jdk/jdeprusage/UseEnum$ValueOfMethod
+jdk/jdeprusage/UseEnum$ValuesMethod
+jdk/jdeprusage/UseEnumMembers$1
+jdk/jdeprusage/UseEnumMembers$MethodInEnum1
+jdk/jdeprusage/UseEnumMembers$MethodOnConstant1
+jdk/jdeprusage/UseEnumMembers$ReturnValue
+jdk/jdeprusage/UseException$Catch
+jdk/jdeprusage/UseException$Throws
+jdk/jdeprusage/UseField$Direct
+jdk/jdeprusage/UseField$FromSubclass
+jdk/jdeprusage/UseField$Inherited
+jdk/jdeprusage/UseField$StaticField
+jdk/jdeprusage/UseField$SuperFromSubclass
+jdk/jdeprusage/UseInterface$ClassImplements
+jdk/jdeprusage/UseInterface$InterfaceExtends
+jdk/jdeprusage/UseMethod$ClassStatic
+jdk/jdeprusage/UseMethod$Constructor
+jdk/jdeprusage/UseMethod$ConstructorFromSubclass
+jdk/jdeprusage/UseMethod$Direct
+jdk/jdeprusage/UseMethod$Inherited
+jdk/jdeprusage/UseMethod$InheritedDefault
+jdk/jdeprusage/UseMethod$InheritedFromSubclass
+jdk/jdeprusage/UseMethod$InheritedInterface
+jdk/jdeprusage/UseMethod$InheritedInterfaceDefault
+jdk/jdeprusage/UseMethod$InterfaceDefault
+jdk/jdeprusage/UseMethod$InterfaceDirect
+jdk/jdeprusage/UseMethod$InterfaceStatic
+jdk/jdeprusage/UseMethod$OverrideClassMethod
+jdk/jdeprusage/UseMethod$OverrideDefaultMethod
+jdk/jdeprusage/UseMethod$OverrideInterfaceMethod
+jdk/jdeprusage/UseMethod$SuperFromSubclass
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/usage/jdk/deprusage/UseAnnotation.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.jdeprusage;
+
+import jdk.deprcases.types.DeprecatedAnnotation;
+
+public class UseAnnotation {
+ @DeprecatedAnnotation
+ static class AnnotatedClass { }
+
+ static class AnnotatedMethod {
+ @DeprecatedAnnotation
+ void foo() { }
+ }
+
+ static class AnnotatedField {
+ @DeprecatedAnnotation
+ int foo = 1;
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/usage/jdk/deprusage/UseClass.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.jdeprusage;
+
+import jdk.deprcases.types.DeprecatedClass;
+
+public class UseClass {
+ static class Extends extends DeprecatedClass {
+ }
+
+ static class ClassLiteral {
+ Class<?> clazz = DeprecatedClass.class;
+ }
+
+ static class FieldType {
+ DeprecatedClass obj = null;
+ }
+
+ static class MethodParameter {
+ void foo(DeprecatedClass x) { }
+ }
+
+ static class MethodReturn {
+ DeprecatedClass foo() { return null; }
+ }
+
+ static class ArrayCreation {
+ Object foo() {
+ return new DeprecatedClass[1];
+ }
+ }
+
+ static class ArrayFieldUsage {
+ int foo(Object o) {
+ return ((DeprecatedClass[])o).length;
+ }
+ }
+
+ static class ArrayMethodCall {
+ Object foo(Object o) {
+ return ((DeprecatedClass[])o).clone();
+ }
+ }
+
+ static class InstanceOf {
+ boolean foo(Object o) {
+ return o instanceof DeprecatedClass;
+ }
+ }
+
+ static class Cast {
+ Object foo(Object o) {
+ return (DeprecatedClass)o;
+ }
+ }
+
+ static class Generic<T> {
+ static <U> void g() { }
+ }
+
+ static class ClassTypeArg extends Generic<DeprecatedClass> { }
+
+ static class MethodTypeArg {
+ void foo() {
+ Generic.<DeprecatedClass>g();
+ }
+ }
+
+ static class ConstructorTypeArg {
+ Object foo() {
+ return new Generic<DeprecatedClass>();
+ }
+ }
+
+ static class Construct {
+ Object foo() {
+ return new DeprecatedClass();
+ }
+ }
+
+ static class Local {
+ void foo() {
+ DeprecatedClass obj = null;
+ }
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/usage/jdk/deprusage/UseEnum.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.jdeprusage;
+
+import jdk.deprcases.types.DeprecatedEnum;
+
+public class UseEnum {
+ static class ReturnValue {
+ static DeprecatedEnum returnValue() { return null; }
+ }
+
+ static class MethodParameter {
+ static void methodParameterType(DeprecatedEnum e) { }
+ }
+
+ static class FieldType {
+ static DeprecatedEnum field;
+ }
+
+ static class EnumConstant {
+ static Object field2 = DeprecatedEnum.FIRST;
+ }
+
+ static class ValuesMethod {
+ static Object[] valuesMethod() {
+ return DeprecatedEnum.values();
+ }
+ }
+
+ static class ValueOfMethod {
+ static Object valueOfMethod(String s) {
+ return DeprecatedEnum.valueOf(s);
+ }
+ }
+
+ static class ClassObject {
+ static Object classObject() {
+ return DeprecatedEnum.class;
+ }
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/usage/jdk/deprusage/UseEnumMembers.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.jdeprusage;
+
+import jdk.deprcases.members.ExampleEnum;
+
+public class UseEnumMembers {
+ static class ReturnValue {
+ static ExampleEnum returnValue() {
+ return ExampleEnum.FIVE;
+ }
+ }
+
+ static class UseInSwitch {
+ // enum switch generates inner class UseEnumMembers$UseInSwitch$1
+ static void useInSwitch(ExampleEnum e) {
+ switch (e) {
+ case ONE:
+ case TWO:
+ case FOUR:
+ // no deprecation
+ break;
+ case THREE:
+ // deprecated
+ break;
+ }
+ }
+ }
+
+ static class MethodInEnum1 {
+ static void methodInEnum1(ExampleEnum e) {
+ e.deprMethod1();
+ }
+ }
+
+ static class MethodOnConstant1 {
+ static void methodOnConstant1() {
+ // surprising that there is a warning here;
+ // the method deprMethod1 is overridden in TWO
+ ExampleEnum.TWO.deprMethod1();
+ }
+ }
+
+ static void methodInEnum2(ExampleEnum e) {
+ e.deprMethod2();
+ }
+
+ static void methodOnConstant2() {
+ // surprising there is no warning here;
+ // the method is deprecated in TWO
+ ExampleEnum.TWO.deprMethod2();
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/usage/jdk/deprusage/UseException.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.jdeprusage;
+
+import jdk.deprcases.types.DeprecatedException;
+
+public class UseException {
+ static class Throws {
+ static void foo() throws DeprecatedException { }
+ }
+
+ static class Catch {
+ void foo() {
+ try {
+ Throws.foo();
+ } catch (DeprecatedException de) { }
+ }
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/usage/jdk/deprusage/UseField.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.jdeprusage;
+
+import jdk.deprcases.members.ExampleClass;
+import jdk.deprcases.members.ExampleInterface;
+import jdk.deprcases.members.ExampleSubclass;
+
+public class UseField {
+ static class Direct {
+ int f(ExampleClass ec) {
+ return ec.field1;
+ }
+ }
+
+ static class Inherited {
+ int f(ExampleSubclass esc) {
+ return esc.field2;
+ }
+ }
+
+ static class InterfaceInherited {
+ int f(ExampleSubclass esc) {
+ return esc.DEP_FIELD2;
+ }
+ }
+
+ static class InterfaceDirect {
+ int f(ExampleInterface ei) {
+ return ei.DEP_FIELD1;
+ }
+ }
+
+ static class FromSubclass extends ExampleClass {
+ int f() {
+ return field1;
+ }
+ }
+
+ static class SuperFromSubclass extends ExampleClass {
+ int f() {
+ return super.field1;
+ }
+ }
+
+ static class StaticField {
+ int f() {
+ return ExampleClass.staticfield3;
+ }
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/usage/jdk/deprusage/UseInterface.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.jdeprusage;
+
+import jdk.deprcases.types.DeprecatedInterface;
+
+public class UseInterface {
+ static class ClassImplements implements DeprecatedInterface {
+
+ }
+
+ interface InterfaceExtends extends DeprecatedInterface {
+
+ }
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/tools/jdeprscan/usage/jdk/deprusage/UseMethod.java Tue Aug 30 08:45:21 2016 -0700
@@ -0,0 +1,123 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.jdeprusage;
+
+import jdk.deprcases.members.ExampleClass;
+import jdk.deprcases.members.ExampleInterface;
+import jdk.deprcases.members.ExampleSubclass;
+
+public class UseMethod {
+ static class Direct {
+ void m(ExampleClass ec) {
+ ec.method1();
+ }
+ }
+
+ static class Inherited {
+ void m(ExampleSubclass esc) {
+ esc.method2();
+ }
+ }
+
+ static class InheritedDefault {
+ void m(ExampleSubclass esc) {
+ esc.defaultMethod();
+ }
+ }
+
+ static class InterfaceDirect {
+ void m(ExampleInterface ei) {
+ ei.interfaceMethod1();
+ }
+ }
+
+ static class InterfaceDefault {
+ void m(ExampleInterface ei) {
+ ei.defaultMethod();
+ }
+ }
+
+ static class ClassStatic {
+ void m() {
+ ExampleClass.staticmethod1();
+ }
+ }
+
+ static class InterfaceStatic {
+ void m() {
+ ExampleInterface.staticmethod2();
+ }
+ }
+
+ static class SuperFromSubclass extends ExampleClass {
+ void m() {
+ super.method1();
+ }
+ }
+
+ static class InheritedFromSubclass extends ExampleClass {
+ void m() {
+ method1();
+ }
+ }
+
+ static class Constructor {
+ Object m() {
+ return new ExampleClass(true);
+ }
+ }
+
+ static class ConstructorFromSubclass extends ExampleClass {
+ public ConstructorFromSubclass() {
+ super(true);
+ }
+ }
+
+ abstract static class InheritedInterfaceDefault extends ExampleSubclass {
+ void m() {
+ defaultMethod();
+ }
+ }
+
+ abstract static class InheritedInterface extends ExampleSubclass {
+ void m() {
+ interfaceMethod1();
+ }
+ }
+
+ static class OverrideClassMethod extends ExampleClass {
+ @Override
+ public void method1() { }
+ }
+
+ abstract static class OverrideInterfaceMethod implements ExampleInterface {
+ @Override
+ public void interfaceMethod1() { }
+ }
+
+ abstract static class OverrideDefaultMethod implements ExampleInterface {
+ @Override
+ public void defaultMethod() { }
+ }
+}
--- a/langtools/test/tools/jdeps/jdkinternals/RemovedJDKInternals.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/jdeps/jdkinternals/RemovedJDKInternals.java Tue Aug 30 08:45:21 2016 -0700
@@ -73,7 +73,7 @@
// patch jdk.unsupported and set -cp to codec types
assertTrue(CompilerUtils.compile(Paths.get(TEST_SRC, "src", "p"),
CLASSES_DIR,
- "-Xpatch:jdk.unsupported=" + patchDir,
+ "--patch-module", "jdk.unsupported=" + patchDir,
"-cp", codecDest.toString()));
}
--- a/langtools/test/tools/jdeps/lib/CompilerUtils.java Tue Aug 30 11:07:58 2016 +0530
+++ b/langtools/test/tools/jdeps/lib/CompilerUtils.java Tue Aug 30 08:45:21 2016 -0700
@@ -100,7 +100,7 @@
}
Stream<String> opts = Arrays.stream(new String[] {
- "-modulesourcepath", source.toString(), "-m", moduleName
+ "--module-source-path", source.toString(), "-m", moduleName
});
List<String> javacOpts = Stream.concat(opts, Arrays.stream(options))
.collect(Collectors.toList());
--- a/nashorn/.hgtags Tue Aug 30 11:07:58 2016 +0530
+++ b/nashorn/.hgtags Tue Aug 30 08:45:21 2016 -0700
@@ -366,3 +366,4 @@
0de67a63e2c73781ecf5979a2f3aa9619a445c37 jdk-9+130
ee77c6b3713ab293e027ac3ea1cc16f86dac535f jdk-9+131
55a75af751dfe44039baef2b762ee7347021025b jdk-9+132
+3a924b820d02b108cf57b51e145b5150d1eedcca jdk-9+133
--- a/nashorn/src/jdk.scripting.nashorn.shell/share/classes/jdk/nashorn/tools/jjs/Main.java Tue Aug 30 11:07:58 2016 +0530
+++ b/nashorn/src/jdk.scripting.nashorn.shell/share/classes/jdk/nashorn/tools/jjs/Main.java Tue Aug 30 08:45:21 2016 -0700
@@ -172,7 +172,7 @@
final Consumer<String> evaluator = str -> {
// could be called from different thread (GUI), we need to handle Context set/reset
final Global _oldGlobal = Context.getGlobal();
- final boolean _globalChanged = (oldGlobal != global);
+ final boolean _globalChanged = (_oldGlobal != global);
if (_globalChanged) {
Context.setGlobal(global);
}
--- a/nashorn/src/jdk.scripting.nashorn/share/classes/jdk/nashorn/internal/codegen/OptimisticTypesCalculator.java Tue Aug 30 11:07:58 2016 +0530
+++ b/nashorn/src/jdk.scripting.nashorn/share/classes/jdk/nashorn/internal/codegen/OptimisticTypesCalculator.java Tue Aug 30 08:45:21 2016 -0700
@@ -79,7 +79,7 @@
@Override
public boolean enterPropertyNode(final PropertyNode propertyNode) {
- if(propertyNode.getKeyName().equals(ScriptObject.PROTO_PROPERTY_NAME)) {
+ if(ScriptObject.PROTO_PROPERTY_NAME.equals(propertyNode.getKeyName())) {
tagNeverOptimistic(propertyNode.getValue());
}
return super.enterPropertyNode(propertyNode);
--- a/nashorn/src/jdk.scripting.nashorn/share/classes/jdk/nashorn/internal/runtime/resources/Functions.properties Tue Aug 30 11:07:58 2016 +0530
+++ b/nashorn/src/jdk.scripting.nashorn/share/classes/jdk/nashorn/internal/runtime/resources/Functions.properties Tue Aug 30 08:45:21 2016 -0700
@@ -173,3 +173,20 @@
String.prototype.toLocaleUpperCase=returns a new string representing the calling string value converted to upper case according to any locale specific case mappings
String.prototype.trim=returns a new string representing the calling string with white space removed from both ends
+
+Boolean.prototype.toString=returns string representation of specified Boolean object
+
+Boolean.prototype.valueOf=returns the primitive value of the specified Boolean object
+
+Number.prototype.toString=returns string representation of specified object in the specified radix
+
+Number.prototype.toLocaleString=returns a string with a language sensitive representation of this number
+
+Number.prototype.valueOf=returns the primitive value of the specified object
+
+Number.prototype.toFixed=returns a string representing the number in decimal fixed-point notation
+
+Number.prototype.toExponential=returns a string representing the number in decimal exponential notation
+
+Number.prototype.toPrecision=returns a string representing the number to a specified precision in fixed-point or exponential notation
+