duke@1: /*
duke@1:  * Copyright 2003-2004 Sun Microsystems, Inc.  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
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun 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:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.formats.html;
duke@1: 
bpatel@233: import java.io.*;
bpatel@233: 
bpatel@233: import com.sun.javadoc.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.*;
duke@1: 
duke@1: /**
duke@1:  * Writes annotation type required member documentation in HTML format.
duke@1:  *
duke@1:  * @author Jamie Ho
duke@1:  */
duke@1: public class AnnotationTypeRequiredMemberWriterImpl extends AbstractMemberWriter
duke@1:     implements AnnotationTypeRequiredMemberWriter, MemberSummaryWriter {
duke@1: 
duke@1:     /**
duke@1:      * Construct a new AnnotationTypeRequiredMemberWriterImpl.
duke@1:      *
duke@1:      * @param writer         the writer that will write the output.
duke@1:      * @param annotationType the AnnotationType that holds this member.
duke@1:      */
duke@1:     public AnnotationTypeRequiredMemberWriterImpl(SubWriterHolderWriter writer,
duke@1:         AnnotationTypeDoc annotationType) {
duke@1:         super(writer, annotationType);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the annotation type member summary header for the given class.
duke@1:      *
duke@1:      * @param classDoc the class the summary belongs to.
duke@1:      */
duke@1:     public void writeMemberSummaryHeader(ClassDoc classDoc) {
duke@1:         writer.println("<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->");
duke@1:         writer.println();
duke@1:         writer.printSummaryHeader(this, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the annotation type member summary footer for the given class.
duke@1:      *
duke@1:      * @param classDoc the class the summary belongs to.
duke@1:      */
duke@1:     public void writeMemberSummaryFooter(ClassDoc classDoc) {
duke@1:         writer.printSummaryFooter(this, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeInheritedMemberSummaryHeader(ClassDoc classDoc) {
duke@1:         //Not appliable.
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeInheritedMemberSummary(ClassDoc classDoc,
duke@1:         ProgramElementDoc member, boolean isFirst, boolean isLast) {
duke@1:         //Not appliable.
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeInheritedMemberSummaryFooter(ClassDoc classDoc) {
duke@1:         //Not appliable.
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeHeader(ClassDoc classDoc, String header) {
duke@1:         writer.println();
duke@1:         writer.println("<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->");
duke@1:         writer.println();
duke@1:         writer.anchor("annotation_type_element_detail");
duke@1:         writer.printTableHeadingBackground(header);
duke@1:         writer.println();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeMemberHeader(MemberDoc member, boolean isFirst) {
duke@1:         if (! isFirst) {
duke@1:             writer.printMemberHeader();
duke@1:             writer.println("");
duke@1:         }
duke@1:         writer.anchor(member.name() + ((ExecutableMemberDoc) member).signature());
duke@1:         writer.h3();
duke@1:         writer.print(member.name());
duke@1:         writer.h3End();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeSignature(MemberDoc member) {
duke@1:         writer.pre();
duke@1:         writer.writeAnnotationInfo(member);
duke@1:         printModifiers(member);
duke@1:         writer.printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER,
duke@1:             getType(member)));
duke@1:         print(' ');
duke@1:         if (configuration().linksource) {
duke@1:             writer.printSrcLink(member, member.name());
duke@1:         } else {
bpatel@182:             strong(member.name());
duke@1:         }
duke@1:         writer.preEnd();
bpatel@233:         assert !writer.getMemberDetailsListPrinted();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeComments(MemberDoc member) {
bpatel@233:         printComment(member);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the tag output for the given member.
duke@1:      *
duke@1:      * @param member the member being documented.
duke@1:      */
duke@1:     public void writeTags(MemberDoc member) {
duke@1:         writer.printTags(member);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the annotation type member footer.
duke@1:      */
duke@1:     public void writeMemberFooter() {
bpatel@233:         printMemberFooter();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the footer for the annotation type member documentation.
duke@1:      *
duke@1:      * @param classDoc the class that the annotation type member belong to.
duke@1:      */
duke@1:     public void writeFooter(ClassDoc classDoc) {
duke@1:         //No footer to write for annotation type member documentation
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Close the writer.
duke@1:      */
duke@1:     public void close() throws IOException {
duke@1:         writer.close();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void printSummaryLabel(ClassDoc cd) {
bpatel@182:         writer.strongText("doclet.Annotation_Type_Required_Member_Summary");
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void printSummaryAnchor(ClassDoc cd) {
duke@1:         writer.anchor("annotation_type_required_element_summary");
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void printInheritedSummaryAnchor(ClassDoc cd) {
duke@1:     }   // no such
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void printInheritedSummaryLabel(ClassDoc cd) {
duke@1:         // no such
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     protected void writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member) {
bpatel@182:         writer.strong();
duke@1:         writer.printDocLink(context, (MemberDoc) member, member.name(), false);
bpatel@182:         writer.strongEnd();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     protected void writeInheritedSummaryLink(ClassDoc cd,
duke@1:             ProgramElementDoc member) {
duke@1:         //Not applicable.
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     protected void printSummaryType(ProgramElementDoc member) {
duke@1:         MemberDoc m = (MemberDoc)member;
duke@1:         printModifierAndType(m, getType(m));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     protected void writeDeprecatedLink(ProgramElementDoc member) {
duke@1:         writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER,
duke@1:             (MemberDoc) member, ((MemberDoc)member).qualifiedName(), false);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     protected void printNavSummaryLink(ClassDoc cd, boolean link) {
duke@1:         if (link) {
duke@1:             writer.printHyperLink("", "annotation_type_required_element_summary",
duke@1:                     configuration().getText("doclet.navAnnotationTypeRequiredMember"));
duke@1:         } else {
duke@1:             writer.printText("doclet.navAnnotationTypeRequiredMember");
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     protected void printNavDetailLink(boolean link) {
duke@1:         if (link) {
duke@1:             writer.printHyperLink("", "annotation_type_element_detail",
duke@1:                 configuration().getText("doclet.navAnnotationTypeMember"));
duke@1:         } else {
duke@1:             writer.printText("doclet.navAnnotationTypeMember");
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeDeprecated(MemberDoc member) {
bpatel@233:         printDeprecated(member);
duke@1:     }
duke@1: 
duke@1:     private Type getType(MemberDoc member) {
duke@1:         if (member instanceof FieldDoc) {
duke@1:             return ((FieldDoc) member).type();
duke@1:         } else {
duke@1:             return ((MethodDoc) member).returnType();
duke@1:         }
duke@1:     }
duke@1: }