src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/SerializedFormWriter.java

Print this page

        

@@ -1,7 +1,7 @@
 /*
- * 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
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this

@@ -21,16 +21,20 @@
  * 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.doclets.internal.toolkit;
+package jdk.javadoc.internal.doclets.toolkit;
 
 import java.io.*;
 
-import com.sun.javadoc.*;
+import javax.lang.model.element.ExecutableElement;
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.element.VariableElement;
 
+import com.sun.source.doctree.DocTree;
+
 /**
  * The interface for writing serialized form output.
  *
  *  <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.

@@ -89,14 +93,14 @@
     public Content getClassSerializedHeader();
 
     /**
      * Get the heading for the serializable class.
      *
-     * @param classDoc the class being processed
+     * @param typeElement the class being processed
      * @return a content tree for the class heading
      */
-    public Content getClassHeader(ClassDoc classDoc);
+    public Content getClassHeader(TypeElement typeElement);
 
     /**
      * Get the serial UID info header.
      *
      * @return a content tree for the serial uid info header

@@ -123,18 +127,18 @@
     /**
      * Return an instance of a SerialFieldWriter.
      *
      * @return an instance of a SerialFieldWriter.
      */
-    public SerialFieldWriter getSerialFieldWriter(ClassDoc classDoc);
+    public SerialFieldWriter getSerialFieldWriter(TypeElement typeElement);
 
     /**
      * Return an instance of a SerialMethodWriter.
      *
      * @return an instance of a SerialMethodWriter.
      */
-    public SerialMethodWriter getSerialMethodWriter(ClassDoc classDoc);
+    public SerialMethodWriter getSerialMethodWriter(TypeElement typeElement);
 
     /**
      * Close the writer.
      */
     public abstract void close() throws IOException;

@@ -194,35 +198,35 @@
          * Adds the deprecated information for this member.
          *
          * @param field the field to document.
          * @param contentTree content tree to which the deprecated information will be added
          */
-        public void addMemberDeprecatedInfo(FieldDoc field, Content contentTree);
+        public void addMemberDeprecatedInfo(VariableElement field, Content contentTree);
 
         /**
          * Adds the description text for this member.
          *
          * @param field the field to document.
          * @param contentTree content tree to which the member description will be added
          */
-        public void addMemberDescription(FieldDoc field, Content contentTree);
+        public void addMemberDescription(VariableElement field, Content contentTree);
 
         /**
          * Adds the description text for this member represented by the tag.
          *
          * @param serialFieldTag the field to document (represented by tag).
          * @param contentTree content tree to which the member description will be added
          */
-        public void addMemberDescription(SerialFieldTag serialFieldTag, Content contentTree);
+        public void addMemberDescription(VariableElement field, DocTree serialFieldTag, Content contentTree);
 
         /**
          * Adds the tag information for this member.
          *
          * @param field the field to document.
          * @param contentTree content tree to which the member tags will be added
          */
-        public void addMemberTags(FieldDoc field, Content contentTree);
+        public void addMemberTags(VariableElement field, Content contentTree);
 
         /**
          * Adds the member header.
          *
          * @param fieldType the type of the field.

@@ -230,11 +234,11 @@
          * 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(ClassDoc fieldType, String fieldTypeStr,
+        public void addMemberHeader(TypeElement fieldType, String fieldTypeStr,
             String fieldDimensions, String fieldName, Content contentTree);
 
         /**
          * Check to see if overview details should be printed. If
          * nocomment option set or if there is no text to be printed

@@ -242,11 +246,11 @@
          * do not print overview details.
          *
          * @param field the field to check overview details for.
          * @return true if overview details need to be printed
          */
-        public boolean shouldPrintOverview(FieldDoc field);
+        public boolean shouldPrintOverview(VariableElement field);
     }
 
     /**
      * Write the serialized form for a given field.
      */

@@ -288,35 +292,35 @@
          * Adds the header.
          *
          * @param member the member to write the header for
          * @param methodsContentTree content tree to which the header will be added
          */
-        public void addMemberHeader(MethodDoc member, Content methodsContentTree);
+        public void addMemberHeader(ExecutableElement member, Content methodsContentTree);
 
         /**
          * Adds the deprecated information for this member.
          *
          * @param member the member to write the deprecated information for
          * @param methodsContentTree content tree to which the deprecated
          * information will be added
          */
-        public void addDeprecatedMemberInfo(MethodDoc member, Content methodsContentTree);
+        public void addDeprecatedMemberInfo(ExecutableElement member, Content methodsContentTree);
 
         /**
          * Adds the description for this member.
          *
          * @param member the member to write the information for
          * @param methodsContentTree content tree to which the member
          * information will be added
          */
-        public void addMemberDescription(MethodDoc member, Content methodsContentTree);
+        public void addMemberDescription(ExecutableElement member, Content methodsContentTree);
 
         /**
          * Adds the tag information for this member.
          *
          * @param member the member to write the tags information for
          * @param methodsContentTree content tree to which the tags
          * information will be added
          */
-        public void addMemberTags(MethodDoc member, Content methodsContentTree);
+        public void addMemberTags(ExecutableElement member, Content methodsContentTree);
     }
 }