src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/FieldWriterImpl.java
Print this page
*** 1,7 ****
/*
! * Copyright (c) 1997, 2015, 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
--- 1,7 ----
/*
! * Copyright (c) 1997, 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,39 ****
* 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.formats.html;
import java.io.*;
! import com.sun.javadoc.*;
! import com.sun.tools.doclets.formats.html.markup.*;
! import com.sun.tools.doclets.internal.toolkit.*;
! import com.sun.tools.doclets.internal.toolkit.util.*;
/**
* Writes field documentation in HTML format.
*
* <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.
--- 21,49 ----
* 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 jdk.javadoc.internal.doclets.formats.html;
import java.io.*;
+ import java.util.Arrays;
+ import java.util.List;
! import javax.lang.model.element.Element;
! import javax.lang.model.element.TypeElement;
! import javax.lang.model.element.VariableElement;
+ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
+ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
+ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
+ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
+ import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
+ import jdk.javadoc.internal.doclets.toolkit.Content;
+ import jdk.javadoc.internal.doclets.toolkit.FieldWriter;
+ import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
+
/**
* Writes field documentation in HTML format.
*
* <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.
*** 46,71 ****
* @author Bhavesh Patel (Modified)
*/
public class FieldWriterImpl extends AbstractMemberWriter
implements FieldWriter, MemberSummaryWriter {
! public FieldWriterImpl(SubWriterHolderWriter writer, ClassDoc classdoc) {
! super(writer, classdoc);
}
public FieldWriterImpl(SubWriterHolderWriter writer) {
super(writer);
}
/**
* {@inheritDoc}
*/
! public Content getMemberSummaryHeader(ClassDoc classDoc,
Content memberSummaryTree) {
memberSummaryTree.addContent(HtmlConstants.START_OF_FIELD_SUMMARY);
Content memberTree = writer.getMemberTreeHeader();
! writer.addSummaryHeader(this, classDoc, memberTree);
return memberTree;
}
/**
* {@inheritDoc}
--- 56,82 ----
* @author Bhavesh Patel (Modified)
*/
public class FieldWriterImpl extends AbstractMemberWriter
implements FieldWriter, MemberSummaryWriter {
! public FieldWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
! super(writer, typeElement);
}
public FieldWriterImpl(SubWriterHolderWriter writer) {
super(writer);
}
/**
* {@inheritDoc}
*/
! @Override
! public Content getMemberSummaryHeader(TypeElement typeElement,
Content memberSummaryTree) {
memberSummaryTree.addContent(HtmlConstants.START_OF_FIELD_SUMMARY);
Content memberTree = writer.getMemberTreeHeader();
! writer.addSummaryHeader(this, typeElement, memberTree);
return memberTree;
}
/**
* {@inheritDoc}
*** 75,86 ****
}
/**
* {@inheritDoc}
*/
! public Content getFieldDetailsTreeHeader(ClassDoc classDoc,
! Content memberDetailsTree) {
memberDetailsTree.addContent(HtmlConstants.START_OF_FIELD_DETAILS);
Content fieldDetailsTree = writer.getMemberTreeHeader();
fieldDetailsTree.addContent(writer.getMarkerAnchor(
SectionName.FIELD_DETAIL));
Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
--- 86,97 ----
}
/**
* {@inheritDoc}
*/
! @Override
! public Content getFieldDetailsTreeHeader(TypeElement typeElement, Content memberDetailsTree) {
memberDetailsTree.addContent(HtmlConstants.START_OF_FIELD_DETAILS);
Content fieldDetailsTree = writer.getMemberTreeHeader();
fieldDetailsTree.addContent(writer.getMarkerAnchor(
SectionName.FIELD_DETAIL));
Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
*** 90,174 ****
}
/**
* {@inheritDoc}
*/
! public Content getFieldDocTreeHeader(FieldDoc field,
! Content fieldDetailsTree) {
! fieldDetailsTree.addContent(
! writer.getMarkerAnchor(field.name()));
! Content fieldDocTree = writer.getMemberTreeHeader();
Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
! heading.addContent(field.name());
! fieldDocTree.addContent(heading);
! return fieldDocTree;
}
/**
* {@inheritDoc}
*/
! public Content getSignature(FieldDoc field) {
Content pre = new HtmlTree(HtmlTag.PRE);
writer.addAnnotationInfo(field, pre);
addModifiers(field, pre);
Content fieldlink = writer.getLink(new LinkInfoImpl(
! configuration, LinkInfoImpl.Kind.MEMBER, field.type()));
pre.addContent(fieldlink);
pre.addContent(" ");
if (configuration.linksource) {
! Content fieldName = new StringContent(field.name());
writer.addSrcLink(field, fieldName, pre);
} else {
! addName(field.name(), pre);
}
return pre;
}
/**
* {@inheritDoc}
*/
! public void addDeprecated(FieldDoc field, Content fieldDocTree) {
! addDeprecatedInfo(field, fieldDocTree);
}
/**
* {@inheritDoc}
*/
! public void addComments(FieldDoc field, Content fieldDocTree) {
! ClassDoc holder = field.containingClass();
! if (field.inlineTags().length > 0) {
! if (holder.equals(classdoc) ||
! (! (holder.isPublic() || utils.isLinkable(holder, configuration)))) {
! writer.addInlineComment(field, fieldDocTree);
! } else {
! Content link =
! writer.getDocLink(LinkInfoImpl.Kind.FIELD_DOC_COPY,
! holder, field,
! holder.isIncluded() ?
! holder.typeName() : holder.qualifiedTypeName(),
! false);
! Content codeLink = HtmlTree.CODE(link);
! Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel, holder.isClass()?
! writer.descfrmClassLabel : writer.descfrmInterfaceLabel);
! descfrmLabel.addContent(writer.getSpace());
! descfrmLabel.addContent(codeLink);
! fieldDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
! writer.addInlineComment(field, fieldDocTree);
}
}
- }
/**
* {@inheritDoc}
*/
! public void addTags(FieldDoc field, Content fieldDocTree) {
! writer.addTagsInfo(field, fieldDocTree);
}
/**
* {@inheritDoc}
*/
public Content getFieldDetails(Content fieldDetailsTree) {
if (configuration.allowTag(HtmlTag.SECTION)) {
HtmlTree htmlTree = HtmlTree.SECTION(getMemberTree(fieldDetailsTree));
return htmlTree;
}
--- 101,171 ----
}
/**
* {@inheritDoc}
*/
! @Override
! public Content getFieldDocTreeHeader(VariableElement field, Content fieldDetailsTree) {
! fieldDetailsTree.addContent(writer.getMarkerAnchor(name(field)));
! Content fieldTree = writer.getMemberTreeHeader();
Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
! heading.addContent(name(field));
! fieldTree.addContent(heading);
! return fieldTree;
}
/**
* {@inheritDoc}
*/
! @Override
! public Content getSignature(VariableElement field) {
Content pre = new HtmlTree(HtmlTag.PRE);
writer.addAnnotationInfo(field, pre);
addModifiers(field, pre);
Content fieldlink = writer.getLink(new LinkInfoImpl(
! configuration, LinkInfoImpl.Kind.MEMBER, field.asType()));
pre.addContent(fieldlink);
pre.addContent(" ");
if (configuration.linksource) {
! Content fieldName = new StringContent(name(field));
writer.addSrcLink(field, fieldName, pre);
} else {
! addName(name(field), pre);
}
return pre;
}
/**
* {@inheritDoc}
*/
! @Override
! public void addDeprecated(VariableElement field, Content fieldTree) {
! addDeprecatedInfo(field, fieldTree);
}
/**
* {@inheritDoc}
*/
! @Override
! public void addComments(VariableElement field, Content fieldTree) {
! if (!utils.getBody(field).isEmpty()) {
! writer.addInlineComment(field, fieldTree);
}
}
/**
* {@inheritDoc}
*/
! @Override
! public void addTags(VariableElement field, Content fieldTree) {
! writer.addTagsInfo(field, fieldTree);
}
/**
* {@inheritDoc}
*/
+ @Override
public Content getFieldDetails(Content fieldDetailsTree) {
if (configuration.allowTag(HtmlTag.SECTION)) {
HtmlTree htmlTree = HtmlTree.SECTION(getMemberTree(fieldDetailsTree));
return htmlTree;
}
*** 176,264 ****
}
/**
* {@inheritDoc}
*/
! public Content getFieldDoc(Content fieldDocTree,
boolean isLastContent) {
! return getMemberTree(fieldDocTree, isLastContent);
}
/**
* Close the writer.
*/
public void close() throws IOException {
writer.close();
}
- public int getMemberKind() {
- return VisibleMemberMap.FIELDS;
- }
-
/**
* {@inheritDoc}
*/
public void addSummaryLabel(Content memberTree) {
Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
writer.getResource("doclet.Field_Summary"));
memberTree.addContent(label);
}
/**
* {@inheritDoc}
*/
public String getTableSummary() {
return configuration.getText("doclet.Member_Table_Summary",
configuration.getText("doclet.Field_Summary"),
configuration.getText("doclet.fields"));
}
/**
* {@inheritDoc}
*/
public Content getCaption() {
return configuration.getResource("doclet.Fields");
}
/**
* {@inheritDoc}
*/
! public String[] getSummaryTableHeader(ProgramElementDoc member) {
! String[] header = new String[] {
! writer.getModifierTypeHeader(),
configuration.getText("doclet.0_and_1",
configuration.getText("doclet.Field"),
! configuration.getText("doclet.Description"))
! };
return header;
}
/**
* {@inheritDoc}
*/
! public void addSummaryAnchor(ClassDoc cd, Content memberTree) {
memberTree.addContent(writer.getMarkerAnchor(
SectionName.FIELD_SUMMARY));
}
/**
* {@inheritDoc}
*/
! public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) {
inheritedTree.addContent(writer.getMarkerAnchor(
! SectionName.FIELDS_INHERITANCE, configuration.getClassName(cd)));
}
/**
* {@inheritDoc}
*/
! public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) {
Content classLink = writer.getPreQualifiedClassLink(
! LinkInfoImpl.Kind.MEMBER, cd, false);
! Content label = new StringContent(cd.isClass() ?
! configuration.getText("doclet.Fields_Inherited_From_Class") :
! configuration.getText("doclet.Fields_Inherited_From_Interface"));
Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING,
label);
labelHeading.addContent(writer.getSpace());
labelHeading.addContent(classLink);
inheritedTree.addContent(labelHeading);
--- 173,264 ----
}
/**
* {@inheritDoc}
*/
! @Override
! public Content getFieldDoc(Content fieldTree,
boolean isLastContent) {
! return getMemberTree(fieldTree, isLastContent);
}
/**
* Close the writer.
*/
+ @Override
public void close() throws IOException {
writer.close();
}
/**
* {@inheritDoc}
*/
+ @Override
public void addSummaryLabel(Content memberTree) {
Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
writer.getResource("doclet.Field_Summary"));
memberTree.addContent(label);
}
/**
* {@inheritDoc}
*/
+ @Override
public String getTableSummary() {
return configuration.getText("doclet.Member_Table_Summary",
configuration.getText("doclet.Field_Summary"),
configuration.getText("doclet.fields"));
}
/**
* {@inheritDoc}
*/
+ @Override
public Content getCaption() {
return configuration.getResource("doclet.Fields");
}
/**
* {@inheritDoc}
*/
! @Override
! public List<String> getSummaryTableHeader(Element member) {
! List<String> header = Arrays.asList(writer.getModifierTypeHeader(),
configuration.getText("doclet.0_and_1",
configuration.getText("doclet.Field"),
! configuration.getText("doclet.Description")));
return header;
}
/**
* {@inheritDoc}
*/
! @Override
! public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
memberTree.addContent(writer.getMarkerAnchor(
SectionName.FIELD_SUMMARY));
}
/**
* {@inheritDoc}
*/
! @Override
! public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
inheritedTree.addContent(writer.getMarkerAnchor(
! SectionName.FIELDS_INHERITANCE, configuration.getClassName(typeElement)));
}
/**
* {@inheritDoc}
*/
! @Override
! public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
Content classLink = writer.getPreQualifiedClassLink(
! LinkInfoImpl.Kind.MEMBER, typeElement, false);
! Content label = new StringContent(utils.isClass(typeElement)
! ? configuration.getText("doclet.Fields_Inherited_From_Class")
! : configuration.getText("doclet.Fields_Inherited_From_Interface"));
Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING,
label);
labelHeading.addContent(writer.getSpace());
labelHeading.addContent(classLink);
inheritedTree.addContent(labelHeading);
*** 265,330 ****
}
/**
* {@inheritDoc}
*/
! protected void addSummaryLink(LinkInfoImpl.Kind context, ClassDoc cd, ProgramElementDoc member,
Content tdSummary) {
Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink,
! writer.getDocLink(context, cd , (MemberDoc) member, member.name(), false));
Content code = HtmlTree.CODE(memberLink);
tdSummary.addContent(code);
}
/**
* {@inheritDoc}
*/
! protected void addInheritedSummaryLink(ClassDoc cd,
! ProgramElementDoc member, Content linksTree) {
linksTree.addContent(
! writer.getDocLink(LinkInfoImpl.Kind.MEMBER, cd, (MemberDoc)member,
! member.name(), false));
}
/**
* {@inheritDoc}
*/
! protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) {
! FieldDoc field = (FieldDoc)member;
! addModifierAndType(field, field.type(), tdSummaryType);
}
/**
* {@inheritDoc}
*/
! protected Content getDeprecatedLink(ProgramElementDoc member) {
! return writer.getDocLink(LinkInfoImpl.Kind.MEMBER,
! (MemberDoc) member, ((FieldDoc)member).qualifiedName());
}
/**
* {@inheritDoc}
*/
! protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
if (link) {
! if (cd == null) {
return writer.getHyperLink(
SectionName.FIELD_SUMMARY,
writer.getResource("doclet.navField"));
} else {
return writer.getHyperLink(
SectionName.FIELDS_INHERITANCE,
! configuration.getClassName(cd), writer.getResource("doclet.navField"));
}
} else {
return writer.getResource("doclet.navField");
}
}
/**
* {@inheritDoc}
*/
protected void addNavDetailLink(boolean link, Content liNav) {
if (link) {
liNav.addContent(writer.getHyperLink(
SectionName.FIELD_DETAIL,
writer.getResource("doclet.navField")));
--- 265,334 ----
}
/**
* {@inheritDoc}
*/
! @Override
! protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element member,
Content tdSummary) {
Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink,
! writer.getDocLink(context, typeElement , member, name(member), false));
Content code = HtmlTree.CODE(memberLink);
tdSummary.addContent(code);
}
/**
* {@inheritDoc}
*/
! @Override
! protected void addInheritedSummaryLink(TypeElement typeElement, Element member, Content linksTree) {
linksTree.addContent(
! writer.getDocLink(LinkInfoImpl.Kind.MEMBER, typeElement, member,
! name(member), false));
}
/**
* {@inheritDoc}
*/
! @Override
! protected void addSummaryType(Element member, Content tdSummaryType) {
! addModifierAndType(member, member.asType(), tdSummaryType);
}
/**
* {@inheritDoc}
*/
! @Override
! protected Content getDeprecatedLink(Element member) {
! String name = utils.getFullyQualifiedName(member) + "." + member.getSimpleName();
! return writer.getDocLink(LinkInfoImpl.Kind.MEMBER, member, name);
}
/**
* {@inheritDoc}
*/
! @Override
! protected Content getNavSummaryLink(TypeElement typeElement, boolean link) {
if (link) {
! if (typeElement == null) {
return writer.getHyperLink(
SectionName.FIELD_SUMMARY,
writer.getResource("doclet.navField"));
} else {
return writer.getHyperLink(
SectionName.FIELDS_INHERITANCE,
! configuration.getClassName(typeElement), writer.getResource("doclet.navField"));
}
} else {
return writer.getResource("doclet.navField");
}
}
/**
* {@inheritDoc}
*/
+ @Override
protected void addNavDetailLink(boolean link, Content liNav) {
if (link) {
liNav.addContent(writer.getHyperLink(
SectionName.FIELD_DETAIL,
writer.getResource("doclet.navField")));