changeset 352:7c2d6da61646

6865399: some javac files are missing Sun internal API comment Reviewed-by: darcy
author jjg
date Mon, 27 Jul 2009 19:52:42 -0700
parents cf08b64e87da
children e4ce529b2249 777a3efad0d5
files src/share/classes/com/sun/tools/javac/api/DiagnosticFormatter.java src/share/classes/com/sun/tools/javac/api/Formattable.java src/share/classes/com/sun/tools/javac/api/Messages.java src/share/classes/com/sun/tools/javac/code/BoundKind.java src/share/classes/com/sun/tools/javac/code/Printer.java src/share/classes/com/sun/tools/javac/file/BaseFileObject.java src/share/classes/com/sun/tools/javac/file/CacheFSInfo.java src/share/classes/com/sun/tools/javac/file/FSInfo.java src/share/classes/com/sun/tools/javac/file/JavacFileManager.java src/share/classes/com/sun/tools/javac/file/RegularFileObject.java src/share/classes/com/sun/tools/javac/file/RelativePath.java src/share/classes/com/sun/tools/javac/file/SymbolArchive.java src/share/classes/com/sun/tools/javac/file/ZipArchive.java src/share/classes/com/sun/tools/javac/file/ZipFileIndex.java src/share/classes/com/sun/tools/javac/file/ZipFileIndexArchive.java src/share/classes/com/sun/tools/javac/parser/ParserFactory.java src/share/classes/com/sun/tools/javac/util/AbstractDiagnosticFormatter.java src/share/classes/com/sun/tools/javac/util/BasicDiagnosticFormatter.java src/share/classes/com/sun/tools/javac/util/ForwardingDiagnosticFormatter.java src/share/classes/com/sun/tools/javac/util/RawDiagnosticFormatter.java src/share/classes/com/sun/tools/javac/util/RichDiagnosticFormatter.java src/share/classes/com/sun/tools/javac/util/Warner.java
diffstat 22 files changed, 115 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/com/sun/tools/javac/api/DiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/api/DiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
@@ -32,6 +32,11 @@
 /**
  * Provides simple functionalities for javac diagnostic formatting.
  * @param <D> type of diagnostic handled by this formatter
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 interface DiagnosticFormatter<D extends Diagnostic<?>> {
 
--- a/src/share/classes/com/sun/tools/javac/api/Formattable.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/api/Formattable.java	Mon Jul 27 19:52:42 2009 -0700
@@ -31,6 +31,11 @@
  * This interface must be implemented by any javac class that has non-trivial
  * formatting needs (e.g. where toString() does not apply because of localization).
  *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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>
+ *
  * @author Maurizio Cimadamore
  */
 public interface Formattable {
--- a/src/share/classes/com/sun/tools/javac/api/Messages.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/api/Messages.java	Mon Jul 27 19:52:42 2009 -0700
@@ -32,6 +32,11 @@
  * This interface defines the minimum requirements in order to provide support
  * for localized formatted strings.
  *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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>
+ *
  * @author Maurizio Cimadamore
  */
 public interface Messages {
--- a/src/share/classes/com/sun/tools/javac/code/BoundKind.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/code/BoundKind.java	Mon Jul 27 19:52:42 2009 -0700
@@ -25,7 +25,13 @@
 
 package com.sun.tools.javac.code;
 
-
+/**
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 enum BoundKind {
     EXTENDS("? extends "),
     SUPER("? super "),
--- a/src/share/classes/com/sun/tools/javac/code/Printer.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/code/Printer.java	Mon Jul 27 19:52:42 2009 -0700
@@ -40,6 +40,11 @@
 /**
  * A combined type/symbol visitor for generating non-trivial localized string
  * representation of types and symbols.
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 abstract class Printer implements Type.Visitor<String, Locale>, Symbol.Visitor<String, Locale> {
 
--- a/src/share/classes/com/sun/tools/javac/file/BaseFileObject.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/file/BaseFileObject.java	Mon Jul 27 19:52:42 2009 -0700
@@ -36,6 +36,12 @@
 
 import static javax.tools.JavaFileObject.Kind.*;
 
+/**
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 abstract class BaseFileObject implements JavaFileObject {
     protected BaseFileObject(JavacFileManager fileManager) {
         this.fileManager = fileManager;
--- a/src/share/classes/com/sun/tools/javac/file/CacheFSInfo.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/file/CacheFSInfo.java	Mon Jul 27 19:52:42 2009 -0700
@@ -34,7 +34,12 @@
 import java.util.concurrent.ConcurrentHashMap;
 
 /**
- * Caching implementation of FSInfo
+ * Caching implementation of FSInfo.
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 CacheFSInfo extends FSInfo {
 
--- a/src/share/classes/com/sun/tools/javac/file/FSInfo.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/file/FSInfo.java	Mon Jul 27 19:52:42 2009 -0700
@@ -16,6 +16,11 @@
 /**
  * Get meta-info about files. Default direct (non-caching) implementation.
  * @see CacheFSInfo
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 FSInfo {
 
--- a/src/share/classes/com/sun/tools/javac/file/JavacFileManager.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/file/JavacFileManager.java	Mon Jul 27 19:52:42 2009 -0700
@@ -82,6 +82,11 @@
 /**
  * This class provides access to the source, class and other files
  * used by the compiler and related tools.
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 JavacFileManager implements StandardJavaFileManager {
 
--- a/src/share/classes/com/sun/tools/javac/file/RegularFileObject.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/file/RegularFileObject.java	Mon Jul 27 19:52:42 2009 -0700
@@ -42,6 +42,11 @@
 
 /**
  * A subclass of JavaFileObject representing regular files.
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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>
  */
 class RegularFileObject extends BaseFileObject {
 
--- a/src/share/classes/com/sun/tools/javac/file/RelativePath.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/file/RelativePath.java	Mon Jul 27 19:52:42 2009 -0700
@@ -34,6 +34,11 @@
  * Used to represent a platform-neutral path within a platform-specific
  * container, such as a directory or zip file.
  * Internally, the file separator is always '/'.
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 abstract class RelativePath implements Comparable<RelativePath> {
     /**
--- a/src/share/classes/com/sun/tools/javac/file/SymbolArchive.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/file/SymbolArchive.java	Mon Jul 27 19:52:42 2009 -0700
@@ -35,6 +35,12 @@
 import com.sun.tools.javac.file.RelativePath.RelativeFile;
 import com.sun.tools.javac.util.List;
 
+/**
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 SymbolArchive extends ZipArchive {
 
     final File origFile;
--- a/src/share/classes/com/sun/tools/javac/file/ZipArchive.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/file/ZipArchive.java	Mon Jul 27 19:52:42 2009 -0700
@@ -48,6 +48,12 @@
 import com.sun.tools.javac.file.RelativePath.RelativeFile;
 import com.sun.tools.javac.util.List;
 
+/**
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 ZipArchive implements Archive {
 
     public ZipArchive(JavacFileManager fm, ZipFile zdir) throws IOException {
--- a/src/share/classes/com/sun/tools/javac/file/ZipFileIndex.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/file/ZipFileIndex.java	Mon Jul 27 19:52:42 2009 -0700
@@ -67,6 +67,11 @@
  * If nonBatchMode option is specified (-XDnonBatchMode) the compiler will use timestamp
  * checking to reindex the zip files if it is needed. In batch mode the timestamps are not checked
  * and the compiler uses the cached indexes.
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 ZipFileIndex {
     private static final String MIN_CHAR = String.valueOf(Character.MIN_VALUE);
--- a/src/share/classes/com/sun/tools/javac/file/ZipFileIndexArchive.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/file/ZipFileIndexArchive.java	Mon Jul 27 19:52:42 2009 -0700
@@ -44,6 +44,12 @@
 import com.sun.tools.javac.file.RelativePath.RelativeFile;
 import com.sun.tools.javac.util.List;
 
+/**
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 ZipFileIndexArchive implements Archive {
 
     private final ZipFileIndex zfIndex;
--- a/src/share/classes/com/sun/tools/javac/parser/ParserFactory.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/parser/ParserFactory.java	Mon Jul 27 19:52:42 2009 -0700
@@ -34,6 +34,11 @@
 
 /**
  * A factory for creating parsers.
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 ParserFactory {
 
--- a/src/share/classes/com/sun/tools/javac/util/AbstractDiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/util/AbstractDiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
@@ -57,6 +57,10 @@
  *  <li> Provides the formatting logic for rendering the arguments of a JCDiagnostic object.
  * <ul>
  *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 abstract class AbstractDiagnosticFormatter implements DiagnosticFormatter<JCDiagnostic> {
 
--- a/src/share/classes/com/sun/tools/javac/util/BasicDiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/util/BasicDiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
@@ -57,6 +57,11 @@
  * <li>%m: the text or the diagnostic, including any appropriate arguments
  * <li>%_: space delimiter, useful for formatting purposes
  * </ul>
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 BasicDiagnosticFormatter extends AbstractDiagnosticFormatter {
 
--- a/src/share/classes/com/sun/tools/javac/util/ForwardingDiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/util/ForwardingDiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
@@ -37,6 +37,11 @@
 /**
  * A delegated diagnostic formatter delegates all formatting
  * actions to an underlying formatter (aka the delegated formatter).
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 ForwardingDiagnosticFormatter<D extends Diagnostic<?>, F extends DiagnosticFormatter<D>>
         implements DiagnosticFormatter<D> {
--- a/src/share/classes/com/sun/tools/javac/util/RawDiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/util/RawDiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
@@ -39,6 +39,11 @@
  * The raw formatter will format a diagnostic according to one of two format patterns, depending on whether
  * or not the source name and position are set. This formatter provides a standardized, localize-independent
  * implementation of a diagnostic formatter; as such, this formatter is best suited for testing purposes.
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 final class RawDiagnosticFormatter extends AbstractDiagnosticFormatter {
 
--- a/src/share/classes/com/sun/tools/javac/util/RichDiagnosticFormatter.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/util/RichDiagnosticFormatter.java	Mon Jul 27 19:52:42 2009 -0700
@@ -58,6 +58,11 @@
  * formatted and (iii) type-variable disambiguation - when the diagnostic refers
  * to two different type-variables with the same name, their representation is
  * disambiguated by appending an index to the type variable name.
+ *
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 RichDiagnosticFormatter extends
         ForwardingDiagnosticFormatter<JCDiagnostic, AbstractDiagnosticFormatter> {
--- a/src/share/classes/com/sun/tools/javac/util/Warner.java	Mon Jul 27 15:20:03 2009 -0700
+++ b/src/share/classes/com/sun/tools/javac/util/Warner.java	Mon Jul 27 19:52:42 2009 -0700
@@ -31,10 +31,10 @@
  * An interface to support optional warnings, needed for support of
  * unchecked conversions and unchecked casts.
  *
- * <p>Nothing described in this source file is 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.
+ * <p><b>This is NOT part of any API supported by Sun Microsystems.
+ * 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 Warner {
     public static final Warner noWarnings = new Warner();