< prev index next >

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AnnotationTypeOptionalMemberWriterImpl.java

Print this page
rev 47482 : 8190295: Introduce a new Table builder class
rev 47486 : 8190821: Introduce a new Links builder class


  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.javadoc.internal.doclets.formats.html;
  27 
  28 
  29 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader;
  30 
  31 import javax.lang.model.element.AnnotationValue;
  32 import javax.lang.model.element.Element;
  33 import javax.lang.model.element.ExecutableElement;
  34 import javax.lang.model.element.TypeElement;
  35 
  36 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
  37 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;

  38 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
  39 import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeOptionalMemberWriter;
  40 import jdk.javadoc.internal.doclets.toolkit.Content;
  41 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
  42 
  43 
  44 /**
  45  * Writes annotation type optional member documentation in HTML format.
  46  *
  47  *  <p><b>This is NOT part of any supported API.
  48  *  If you write code that depends on this, you do so at your own risk.
  49  *  This code and its internal interfaces are subject to change or
  50  *  deletion without notice.</b>
  51  *
  52  * @author Jamie Ho
  53  * @author Bhavesh Patel (Modified)
  54  */
  55 public class AnnotationTypeOptionalMemberWriterImpl extends
  56         AnnotationTypeRequiredMemberWriterImpl
  57     implements AnnotationTypeOptionalMemberWriter, MemberSummaryWriter {


 131      */
 132     @Override
 133     protected Content getCaption() {
 134         return contents.getContent("doclet.Annotation_Type_Optional_Members");
 135     }
 136 
 137     /**
 138      * {@inheritDoc}
 139      */
 140     @Override
 141     public TableHeader getSummaryTableHeader(Element member) {
 142         return new TableHeader(contents.modifierAndTypeLabel,
 143                 contents.annotationTypeOptionalMemberLabel, contents.descriptionLabel);
 144     }
 145 
 146     /**
 147      * {@inheritDoc}
 148      */
 149     @Override
 150     public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
 151         memberTree.addContent(writer.getMarkerAnchor(
 152                 SectionName.ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY));
 153     }
 154 
 155     /**
 156      * {@inheritDoc}
 157      */
 158     @Override
 159     protected Content getNavSummaryLink(TypeElement typeElement, boolean link) {
 160         if (link) {
 161             return writer.getHyperLink(
 162                     SectionName.ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY,
 163                     contents.navAnnotationTypeOptionalMember);
 164         } else {
 165             return contents.navAnnotationTypeOptionalMember;
 166         }
 167     }
 168 }


  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.javadoc.internal.doclets.formats.html;
  27 
  28 
  29 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader;
  30 
  31 import javax.lang.model.element.AnnotationValue;
  32 import javax.lang.model.element.Element;
  33 import javax.lang.model.element.ExecutableElement;
  34 import javax.lang.model.element.TypeElement;
  35 
  36 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
  37 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
  38 import jdk.javadoc.internal.doclets.formats.html.markup.Links;
  39 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
  40 import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeOptionalMemberWriter;
  41 import jdk.javadoc.internal.doclets.toolkit.Content;
  42 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
  43 
  44 
  45 /**
  46  * Writes annotation type optional member documentation in HTML format.
  47  *
  48  *  <p><b>This is NOT part of any supported API.
  49  *  If you write code that depends on this, you do so at your own risk.
  50  *  This code and its internal interfaces are subject to change or
  51  *  deletion without notice.</b>
  52  *
  53  * @author Jamie Ho
  54  * @author Bhavesh Patel (Modified)
  55  */
  56 public class AnnotationTypeOptionalMemberWriterImpl extends
  57         AnnotationTypeRequiredMemberWriterImpl
  58     implements AnnotationTypeOptionalMemberWriter, MemberSummaryWriter {


 132      */
 133     @Override
 134     protected Content getCaption() {
 135         return contents.getContent("doclet.Annotation_Type_Optional_Members");
 136     }
 137 
 138     /**
 139      * {@inheritDoc}
 140      */
 141     @Override
 142     public TableHeader getSummaryTableHeader(Element member) {
 143         return new TableHeader(contents.modifierAndTypeLabel,
 144                 contents.annotationTypeOptionalMemberLabel, contents.descriptionLabel);
 145     }
 146 
 147     /**
 148      * {@inheritDoc}
 149      */
 150     @Override
 151     public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
 152         memberTree.addContent(links.createAnchor(
 153                 SectionName.ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY));
 154     }
 155 
 156     /**
 157      * {@inheritDoc}
 158      */
 159     @Override
 160     protected Content getNavSummaryLink(TypeElement typeElement, boolean link) {
 161         if (link) {
 162             return Links.createLink(
 163                     SectionName.ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY,
 164                     contents.navAnnotationTypeOptionalMember);
 165         } else {
 166             return contents.navAnnotationTypeOptionalMember;
 167         }
 168     }
 169 }
< prev index next >