duke@1: /*
jjg@1357:  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.internal.toolkit.builders;
duke@1: 
duke@1: import java.io.*;
duke@1: import java.util.*;
jjg@1357: 
bpatel@233: import com.sun.javadoc.*;
jjg@1357: import com.sun.tools.doclets.internal.toolkit.*;
bpatel@233: import com.sun.tools.doclets.internal.toolkit.util.*;
bpatel@233: 
duke@1: /**
duke@1:  * Builds the serialized form.
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
duke@1:  *
duke@1:  * @author Jamie Ho
bpatel@233:  * @author Bhavesh Patel (Modified)
duke@1:  * @since 1.5
duke@1:  */
duke@1: public class SerializedFormBuilder extends AbstractBuilder {
duke@1: 
duke@1:     /**
duke@1:      * The root element of the serialized form XML is {@value}.
duke@1:      */
duke@1:     public static final String NAME = "SerializedForm";
duke@1: 
duke@1:     /**
duke@1:      * The writer for this builder.
duke@1:      */
duke@1:     private SerializedFormWriter writer;
duke@1: 
duke@1:     /**
duke@1:      * The writer for serializable fields.
duke@1:      */
duke@1:     private SerializedFormWriter.SerialFieldWriter fieldWriter;
duke@1: 
duke@1:     /**
duke@1:      * The writer for serializable method documentation.
duke@1:      */
duke@1:     private SerializedFormWriter.SerialMethodWriter methodWriter;
duke@1: 
duke@1:     /**
duke@1:      * The header for the serial version UID.  Save the string
duke@1:      * here instead of the properties file because we do not want
duke@1:      * this string to be localized.
duke@1:      */
duke@1:     private static final String SERIAL_VERSION_UID_HEADER = "serialVersionUID:";
duke@1: 
duke@1:     /**
duke@1:      * The current package being documented.
duke@1:      */
duke@1:     private PackageDoc currentPackage;
duke@1: 
duke@1:     /**
duke@1:      * The current class being documented.
duke@1:      */
duke@1:     private ClassDoc currentClass;
duke@1: 
duke@1:     /**
duke@1:      * The current member being documented.
duke@1:      */
duke@1:     protected MemberDoc currentMember;
duke@1: 
bpatel@766:     /**
bpatel@766:      * The content that will be added to the serialized form documentation tree.
bpatel@766:      */
bpatel@766:     private Content contentTree;
bpatel@766: 
jjg@1410: 
jjg@1410:     /**
jjg@1410:      * Construct a new SerializedFormBuilder.
jjg@1410:      * @param context  the build context.
jjg@1410:      */
jjg@1410:     private SerializedFormBuilder(Context context) {
jjg@1410:         super(context);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Construct a new SerializedFormBuilder.
jjg@1410:      * @param context  the build context.
duke@1:      */
jjg@1410:     public static SerializedFormBuilder getInstance(Context context) {
jjg@1410:         return new SerializedFormBuilder(context);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Build the serialized form.
duke@1:      */
duke@1:     public void build() throws IOException {
duke@1:         if (! serialClassFoundToDocument(configuration.root.classes())) {
duke@1:             //Nothing to document.
duke@1:             return;
duke@1:         }
duke@1:         try {
duke@1:             writer = configuration.getWriterFactory().getSerializedFormWriter();
duke@1:             if (writer == null) {
duke@1:                 //Doclet does not support this output.
duke@1:                 return;
duke@1:             }
duke@1:         } catch (Exception e) {
duke@1:             throw new DocletAbortException();
duke@1:         }
jjg@1410:         build(layoutParser.parseXML(NAME), contentTree);
duke@1:         writer.close();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public String getName() {
duke@1:         return NAME;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Build the serialized form.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param serializedTree content tree to which the documentation will be added
duke@1:      */
bpatel@766:     public void buildSerializedForm(XMLNode node, Content serializedTree) throws Exception {
bpatel@766:         serializedTree = writer.getHeader(configuration.getText(
bpatel@766:                 "doclet.Serialized_Form"));
bpatel@766:         buildChildren(node, serializedTree);
bpatel@766:         writer.addFooter(serializedTree);
bpatel@766:         writer.printDocument(serializedTree);
duke@1:         writer.close();
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * Build the serialized form summaries.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param serializedTree content tree to which the documentation will be added
duke@1:      */
bpatel@766:     public void buildSerializedFormSummaries(XMLNode node, Content serializedTree) {
bpatel@766:         Content serializedSummariesTree = writer.getSerializedSummariesHeader();
bpatel@766:         PackageDoc[] packages = configuration.packages;
bpatel@766:         for (int i = 0; i < packages.length; i++) {
bpatel@766:             currentPackage = packages[i];
bpatel@766:             buildChildren(node, serializedSummariesTree);
bpatel@766:         }
bpatel@766:         serializedTree.addContent(writer.getSerializedContent(
bpatel@766:                 serializedSummariesTree));
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * Build the package serialized form for the current package being processed.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param serializedSummariesTree content tree to which the documentation will be added
duke@1:      */
bpatel@766:     public void buildPackageSerializedForm(XMLNode node, Content serializedSummariesTree) {
bpatel@766:         Content packageSerializedTree = writer.getPackageSerializedHeader();
duke@1:         String foo = currentPackage.name();
duke@1:         ClassDoc[] classes = currentPackage.allClasses(false);
duke@1:         if (classes == null || classes.length == 0) {
duke@1:             return;
duke@1:         }
duke@1:         if (!serialInclude(currentPackage)) {
duke@1:             return;
duke@1:         }
duke@1:         if (!serialClassFoundToDocument(classes)) {
duke@1:             return;
duke@1:         }
bpatel@766:         buildChildren(node, packageSerializedTree);
bpatel@766:         serializedSummariesTree.addContent(packageSerializedTree);
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * Build the package header.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param packageSerializedTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildPackageHeader(XMLNode node, Content packageSerializedTree) {
bpatel@766:         packageSerializedTree.addContent(writer.getPackageHeader(
bpatel@766:                 Util.getPackageName(currentPackage)));
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * Build the class serialized form.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param packageSerializedTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildClassSerializedForm(XMLNode node, Content packageSerializedTree) {
bpatel@766:         Content classSerializedTree = writer.getClassSerializedHeader();
duke@1:         ClassDoc[] classes = currentPackage.allClasses(false);
duke@1:         Arrays.sort(classes);
duke@1:         for (int j = 0; j < classes.length; j++) {
duke@1:             currentClass = classes[j];
duke@1:             fieldWriter = writer.getSerialFieldWriter(currentClass);
duke@1:             methodWriter = writer.getSerialMethodWriter(currentClass);
duke@1:             if(currentClass.isClass() && currentClass.isSerializable()) {
duke@1:                 if(!serialClassInclude(currentClass)) {
duke@1:                     continue;
duke@1:                 }
bpatel@766:                 Content classTree = writer.getClassHeader(currentClass);
bpatel@766:                 buildChildren(node, classTree);
bpatel@766:                 classSerializedTree.addContent(classTree);
duke@1:             }
duke@1:         }
bpatel@766:         packageSerializedTree.addContent(classSerializedTree);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Build the serial UID information for the given class.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param classTree content tree to which the serial UID information will be added
duke@1:      */
bpatel@766:     public void buildSerialUIDInfo(XMLNode node, Content classTree) {
bpatel@766:         Content serialUidTree = writer.getSerialUIDInfoHeader();
duke@1:         FieldDoc[] fields = currentClass.fields(false);
duke@1:         for (int i = 0; i < fields.length; i++) {
duke@1:             if (fields[i].name().equals("serialVersionUID") &&
duke@1:                 fields[i].constantValueExpression() != null) {
bpatel@766:                 writer.addSerialUIDInfo(SERIAL_VERSION_UID_HEADER,
bpatel@766:                         fields[i].constantValueExpression(), serialUidTree);
bpatel@766:                 break;
bpatel@766:             }
bpatel@766:         }
bpatel@766:         classTree.addContent(serialUidTree);
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the summaries for the methods and fields.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param classTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildClassContent(XMLNode node, Content classTree) {
bpatel@766:         Content classContentTree = writer.getClassContentHeader();
bpatel@766:         buildChildren(node, classContentTree);
bpatel@766:         classTree.addContent(classContentTree);
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the summaries for the methods that belong to the given
bpatel@766:      * class.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param classContentTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildSerializableMethods(XMLNode node, Content classContentTree) {
bpatel@766:         Content serializableMethodTree = methodWriter.getSerializableMethodsHeader();
bpatel@766:         MemberDoc[] members = currentClass.serializationMethods();
bpatel@766:         int membersLength = members.length;
bpatel@766:         if (membersLength > 0) {
bpatel@766:             for (int i = 0; i < membersLength; i++) {
bpatel@766:                 currentMember = members[i];
bpatel@766:                 Content methodsContentTree = methodWriter.getMethodsContentHeader(
bpatel@766:                         (i == membersLength - 1));
bpatel@766:                 buildChildren(node, methodsContentTree);
bpatel@766:                 serializableMethodTree.addContent(methodsContentTree);
bpatel@766:             }
bpatel@766:         }
bpatel@766:         if (currentClass.serializationMethods().length > 0) {
bpatel@766:             classContentTree.addContent(methodWriter.getSerializableMethods(
bpatel@766:                     configuration.getText("doclet.Serialized_Form_methods"),
bpatel@766:                     serializableMethodTree));
bpatel@766:             if (currentClass.isSerializable() && !currentClass.isExternalizable()) {
bpatel@766:                 if (currentClass.serializationMethods().length == 0) {
bpatel@766:                     Content noCustomizationMsg = methodWriter.getNoCustomizationMsg(
bpatel@766:                             configuration.getText(
bpatel@766:                             "doclet.Serializable_no_customization"));
bpatel@766:                     classContentTree.addContent(methodWriter.getSerializableMethods(
bpatel@766:                     configuration.getText("doclet.Serialized_Form_methods"),
bpatel@766:                     noCustomizationMsg));
bpatel@766:                 }
duke@1:             }
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * Build the method sub header.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param methodsContentTree content tree to which the documentation will be added
duke@1:      */
bpatel@766:     public void buildMethodSubHeader(XMLNode node, Content methodsContentTree)  {
bpatel@766:         methodWriter.addMemberHeader((MethodDoc)currentMember, methodsContentTree);
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the deprecated method description.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param methodsContentTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildDeprecatedMethodInfo(XMLNode node, Content methodsContentTree) {
bpatel@766:         methodWriter.addDeprecatedMemberInfo((MethodDoc) currentMember, methodsContentTree);
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the information for the method.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param methodsContentTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildMethodInfo(XMLNode node, Content methodsContentTree)  {
bpatel@766:         if(configuration.nocomment){
bpatel@766:             return;
bpatel@766:         }
bpatel@766:         buildChildren(node, methodsContentTree);
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build method description.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param methodsContentTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildMethodDescription(XMLNode node, Content methodsContentTree) {
bpatel@766:         methodWriter.addMemberDescription((MethodDoc) currentMember, methodsContentTree);
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the method tags.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param methodsContentTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildMethodTags(XMLNode node, Content methodsContentTree) {
bpatel@766:         methodWriter.addMemberTags((MethodDoc) currentMember, methodsContentTree);
bpatel@766:         MethodDoc method = (MethodDoc)currentMember;
bpatel@766:         if (method.name().compareTo("writeExternal") == 0
bpatel@766:                 && method.tags("serialData").length == 0) {
bpatel@766:             if (configuration.serialwarn) {
bpatel@766:                 configuration.getDocletSpecificMsg().warning(
bpatel@766:                         currentMember.position(), "doclet.MissingSerialDataTag",
bpatel@766:                         method.containingClass().qualifiedName(), method.name());
bpatel@766:             }
bpatel@766:         }
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the field header.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param classContentTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildFieldHeader(XMLNode node, Content classContentTree) {
bpatel@766:         if (currentClass.serializableFields().length > 0) {
bpatel@766:             buildFieldSerializationOverview(currentClass, classContentTree);
bpatel@766:         }
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the serialization overview for the given class.
bpatel@766:      *
bpatel@766:      * @param classDoc the class to print the overview for.
bpatel@766:      * @param classContentTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildFieldSerializationOverview(ClassDoc classDoc, Content classContentTree) {
bpatel@766:         if (classDoc.definesSerializableFields()) {
jjg@910:             FieldDoc serialPersistentField = classDoc.serializableFields()[0];
bpatel@766:             // Check to see if there are inline comments, tags or deprecation
bpatel@766:             // information to be printed.
bpatel@766:             if (fieldWriter.shouldPrintOverview(serialPersistentField)) {
bpatel@766:                 Content serializableFieldsTree = fieldWriter.getSerializableFieldsHeader();
bpatel@766:                 Content fieldsOverviewContentTree = fieldWriter.getFieldsContentHeader(true);
bpatel@766:                 fieldWriter.addMemberDeprecatedInfo(serialPersistentField,
bpatel@766:                         fieldsOverviewContentTree);
bpatel@766:                 if (!configuration.nocomment) {
bpatel@766:                     fieldWriter.addMemberDescription(serialPersistentField,
bpatel@766:                             fieldsOverviewContentTree);
bpatel@766:                     fieldWriter.addMemberTags(serialPersistentField,
bpatel@766:                             fieldsOverviewContentTree);
bpatel@766:                 }
bpatel@766:                 serializableFieldsTree.addContent(fieldsOverviewContentTree);
bpatel@766:                 classContentTree.addContent(fieldWriter.getSerializableFields(
bpatel@766:                         configuration.getText("doclet.Serialized_Form_class"),
bpatel@766:                         serializableFieldsTree));
bpatel@766:             }
bpatel@766:         }
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the summaries for the fields that belong to the given class.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param classContentTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildSerializableFields(XMLNode node, Content classContentTree) {
bpatel@766:         MemberDoc[] members = currentClass.serializableFields();
bpatel@766:         int membersLength = members.length;
bpatel@766:         if (membersLength > 0) {
bpatel@766:             Content serializableFieldsTree = fieldWriter.getSerializableFieldsHeader();
bpatel@766:             for (int i = 0; i < membersLength; i++) {
bpatel@766:                 currentMember = members[i];
bpatel@766:                 if (!currentClass.definesSerializableFields()) {
bpatel@766:                     Content fieldsContentTree = fieldWriter.getFieldsContentHeader(
bpatel@766:                             (i == membersLength - 1));
bpatel@766:                     buildChildren(node, fieldsContentTree);
bpatel@766:                     serializableFieldsTree.addContent(fieldsContentTree);
bpatel@766:                 }
bpatel@766:                 else {
bpatel@766:                     buildSerialFieldTagsInfo(serializableFieldsTree);
bpatel@766:                 }
bpatel@766:             }
bpatel@766:             classContentTree.addContent(fieldWriter.getSerializableFields(
bpatel@766:                     configuration.getText("doclet.Serialized_Form_fields"),
bpatel@766:                     serializableFieldsTree));
bpatel@766:         }
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the field sub header.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param fieldsContentTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildFieldSubHeader(XMLNode node, Content fieldsContentTree) {
bpatel@766:         if (!currentClass.definesSerializableFields()) {
bpatel@766:             FieldDoc field = (FieldDoc) currentMember;
bpatel@766:             fieldWriter.addMemberHeader(field.type().asClassDoc(),
bpatel@766:                     field.type().typeName(), field.type().dimension(), field.name(),
bpatel@766:                     fieldsContentTree);
bpatel@766:         }
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the field deprecation information.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param fieldsContentTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildFieldDeprecationInfo(XMLNode node, Content fieldsContentTree) {
bpatel@766:         if (!currentClass.definesSerializableFields()) {
bpatel@766:             FieldDoc field = (FieldDoc)currentMember;
bpatel@766:             fieldWriter.addMemberDeprecatedInfo(field, fieldsContentTree);
bpatel@766:         }
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the serial field tags information.
bpatel@766:      *
bpatel@766:      * @param serializableFieldsTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildSerialFieldTagsInfo(Content serializableFieldsTree) {
bpatel@766:         if(configuration.nocomment){
bpatel@766:             return;
bpatel@766:         }
bpatel@766:         FieldDoc field = (FieldDoc)currentMember;
bpatel@766:         // Process Serializable Fields specified as array of
bpatel@766:         // ObjectStreamFields. Print a member for each serialField tag.
bpatel@766:         // (There should be one serialField tag per ObjectStreamField
bpatel@766:         // element.)
bpatel@766:         SerialFieldTag[] tags = field.serialFieldTags();
bpatel@766:         Arrays.sort(tags);
bpatel@766:         int tagsLength = tags.length;
bpatel@766:         for (int i = 0; i < tagsLength; i++) {
jjg@1372:             if (tags[i].fieldName() == null || tags[i].fieldType() == null) // ignore malformed @serialField tags
jjg@1372:                 continue;
bpatel@766:             Content fieldsContentTree = fieldWriter.getFieldsContentHeader(
bpatel@766:                     (i == tagsLength - 1));
bpatel@766:             fieldWriter.addMemberHeader(tags[i].fieldTypeDoc(),
bpatel@766:                     tags[i].fieldType(), "", tags[i].fieldName(), fieldsContentTree);
bpatel@766:             fieldWriter.addMemberDescription(tags[i], fieldsContentTree);
bpatel@766:             serializableFieldsTree.addContent(fieldsContentTree);
bpatel@766:         }
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the field information.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param fieldsContentTree content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildFieldInfo(XMLNode node, Content fieldsContentTree) {
bpatel@766:         if(configuration.nocomment){
bpatel@766:             return;
bpatel@766:         }
bpatel@766:         FieldDoc field = (FieldDoc)currentMember;
bpatel@766:         ClassDoc cd = field.containingClass();
bpatel@766:         // Process default Serializable field.
bpatel@766:         if ((field.tags("serial").length == 0) && ! field.isSynthetic()
bpatel@766:                 && configuration.serialwarn) {
bpatel@766:             configuration.message.warning(field.position(),
bpatel@766:                     "doclet.MissingSerialTag", cd.qualifiedName(),
bpatel@766:                     field.name());
bpatel@766:         }
bpatel@766:         fieldWriter.addMemberDescription(field, fieldsContentTree);
bpatel@766:         fieldWriter.addMemberTags(field, fieldsContentTree);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if the given Doc should be included
duke@1:      * in the serialized form.
duke@1:      *
duke@1:      * @param doc the Doc object to check for serializability.
duke@1:      */
duke@1:     public static boolean serialInclude(Doc doc) {
duke@1:         if (doc == null) {
duke@1:             return false;
duke@1:         }
duke@1:         return doc.isClass() ?
duke@1:             serialClassInclude((ClassDoc)doc) :
duke@1:             serialDocInclude(doc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if the given ClassDoc should be included
duke@1:      * in the serialized form.
duke@1:      *
duke@1:      * @param cd the ClassDoc object to check for serializability.
duke@1:      */
duke@1:     private static boolean serialClassInclude(ClassDoc cd) {
duke@1:         if (cd.isEnum()) {
duke@1:             return false;
duke@1:         }
duke@1:         try {
duke@1:             cd.superclassType();
duke@1:         } catch (NullPointerException e) {
duke@1:             //Workaround for null pointer bug in ClassDoc.superclassType().
duke@1:             return false;
duke@1:         }
duke@1:         if (cd.isSerializable()) {
duke@1:             if (cd.tags("serial").length > 0) {
duke@1:                 return serialDocInclude(cd);
duke@1:             } else if (cd.isPublic() || cd.isProtected()) {
duke@1:                 return true;
duke@1:             } else {
duke@1:                 return false;
duke@1:             }
duke@1:         }
duke@1:         return false;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if the given Doc should be included
duke@1:      * in the serialized form.
duke@1:      *
duke@1:      * @param doc the Doc object to check for serializability.
duke@1:      */
duke@1:     private static boolean serialDocInclude(Doc doc) {
duke@1:         if (doc.isEnum()) {
duke@1:             return false;
duke@1:         }
duke@1:         Tag[] serial = doc.tags("serial");
duke@1:         if (serial.length > 0) {
duke@1:             String serialtext = serial[0].text().toLowerCase();
duke@1:             if (serialtext.indexOf("exclude") >= 0) {
duke@1:                 return false;
duke@1:             } else if (serialtext.indexOf("include") >= 0) {
duke@1:                 return true;
duke@1:             }
duke@1:         }
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if any of the given classes have a @serialinclude tag.
duke@1:      *
duke@1:      * @param classes the classes to check.
duke@1:      * @return true if any of the given classes have a @serialinclude tag.
duke@1:      */
duke@1:     private boolean serialClassFoundToDocument(ClassDoc[] classes) {
duke@1:         for (int i = 0; i < classes.length; i++) {
duke@1:             if (serialClassInclude(classes[i])) {
duke@1:                 return true;
duke@1:             }
duke@1:         }
duke@1:         return false;
duke@1:     }
duke@1: }