src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConstantsSummaryWriterImpl.java
Print this page
*** 1,7 ****
/*
! * Copyright (c) 2001, 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) 2001, 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,40 ****
* 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 java.util.*;
! 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.*;
/**
* Write the Constants Summary Page 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,52 ----
* 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.*;
! import javax.lang.model.element.Modifier;
! import javax.lang.model.element.PackageElement;
! import javax.lang.model.element.TypeElement;
! import javax.lang.model.element.VariableElement;
+ import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
+ 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.ConstantsSummaryWriter;
+ import jdk.javadoc.internal.doclets.toolkit.Content;
+ import jdk.javadoc.internal.doclets.toolkit.util.DocLink;
+ import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
+
+
/**
* Write the Constants Summary Page 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.
*** 43,68 ****
*
* @author Jamie Ho
* @author Bhavesh Patel (Modified)
* @since 1.4
*/
! public class ConstantsSummaryWriterImpl extends HtmlDocletWriter
! implements ConstantsSummaryWriter {
/**
* The configuration used in this run of the standard doclet.
*/
ConfigurationImpl configuration;
/**
* The current class being documented.
*/
! private ClassDoc currentClassDoc;
private final String constantsTableSummary;
! private final String[] constantsTableHeader;
/**
* The HTML tree for main tag.
*/
private HtmlTree mainTree = HtmlTree.MAIN();
--- 55,79 ----
*
* @author Jamie Ho
* @author Bhavesh Patel (Modified)
* @since 1.4
*/
! public class ConstantsSummaryWriterImpl extends HtmlDocletWriter implements ConstantsSummaryWriter {
/**
* The configuration used in this run of the standard doclet.
*/
ConfigurationImpl configuration;
/**
* The current class being documented.
*/
! private TypeElement currentTypeElement;
private final String constantsTableSummary;
! private final List<String> constantsTableHeader;
/**
* The HTML tree for main tag.
*/
private HtmlTree mainTree = HtmlTree.MAIN();
*** 81,95 ****
throws IOException {
super(configuration, DocPaths.CONSTANT_VALUES);
this.configuration = configuration;
constantsTableSummary = configuration.getText("doclet.Constants_Table_Summary",
configuration.getText("doclet.Constants_Summary"));
! constantsTableHeader = new String[] {
! getModifierTypeHeader(),
! configuration.getText("doclet.ConstantField"),
! configuration.getText("doclet.Value")
! };
}
/**
* {@inheritDoc}
*/
--- 92,105 ----
throws IOException {
super(configuration, DocPaths.CONSTANT_VALUES);
this.configuration = configuration;
constantsTableSummary = configuration.getText("doclet.Constants_Table_Summary",
configuration.getText("doclet.Constants_Summary"));
! constantsTableHeader = new ArrayList<>();
! constantsTableHeader.add(getModifierTypeHeader());
! constantsTableHeader.add(configuration.getText("doclet.ConstantField"));
! constantsTableHeader.add(configuration.getText("doclet.Value"));
}
/**
* {@inheritDoc}
*/
*** 115,139 ****
}
/**
* {@inheritDoc}
*/
! public void addLinkToPackageContent(PackageDoc pkg, String parsedPackageName,
! Set<String> printedPackageHeaders, Content contentListTree) {
! String packageName = pkg.name();
//add link to summary
Content link;
! if (packageName.length() == 0) {
link = getHyperLink(getDocLink(
SectionName.UNNAMED_PACKAGE_ANCHOR),
defaultPackageLabel, "", "");
} else {
Content packageNameContent = getPackageLabel(parsedPackageName);
packageNameContent.addContent(".*");
link = getHyperLink(DocLink.fragment(parsedPackageName),
packageNameContent, "", "");
! printedPackageHeaders.add(parsedPackageName);
}
contentListTree.addContent(HtmlTree.LI(link));
}
/**
--- 125,150 ----
}
/**
* {@inheritDoc}
*/
! public void addLinkToPackageContent(PackageElement pkg,
! Set<PackageElement> printedPackageHeaders, Content contentListTree) {
//add link to summary
Content link;
! if (pkg.isUnnamed()) {
link = getHyperLink(getDocLink(
SectionName.UNNAMED_PACKAGE_ANCHOR),
defaultPackageLabel, "", "");
} else {
+ String parsedPackageName = utils.parsePackageName(pkg);
Content packageNameContent = getPackageLabel(parsedPackageName);
packageNameContent.addContent(".*");
link = getHyperLink(DocLink.fragment(parsedPackageName),
packageNameContent, "", "");
! PackageElement abbrevPkg = utils.elementUtils.getPackageElement(parsedPackageName);
! printedPackageHeaders.add(abbrevPkg);
}
contentListTree.addContent(HtmlTree.LI(link));
}
/**
*** 171,192 ****
}
/**
* {@inheritDoc}
*/
! public void addPackageName(String parsedPackageName, Content summariesTree, boolean first) {
Content pkgNameContent;
if (!first && configuration.allowTag(HtmlTag.SECTION)) {
summariesTree.addContent(summaryTree);
}
! if (parsedPackageName.length() == 0) {
summariesTree.addContent(getMarkerAnchor(
SectionName.UNNAMED_PACKAGE_ANCHOR));
pkgNameContent = defaultPackageLabel;
} else {
! summariesTree.addContent(getMarkerAnchor(
! parsedPackageName));
pkgNameContent = getPackageLabel(parsedPackageName);
}
Content headingContent = new StringContent(".*");
Content heading = HtmlTree.HEADING(HtmlConstants.PACKAGE_HEADING, true,
pkgNameContent);
--- 182,203 ----
}
/**
* {@inheritDoc}
*/
! public void addPackageName(PackageElement pkg, Content summariesTree, boolean first) {
Content pkgNameContent;
if (!first && configuration.allowTag(HtmlTag.SECTION)) {
summariesTree.addContent(summaryTree);
}
! if (pkg.isUnnamed()) {
summariesTree.addContent(getMarkerAnchor(
SectionName.UNNAMED_PACKAGE_ANCHOR));
pkgNameContent = defaultPackageLabel;
} else {
! String parsedPackageName = utils.parsePackageName(pkg);
! summariesTree.addContent(getMarkerAnchor(parsedPackageName));
pkgNameContent = getPackageLabel(parsedPackageName);
}
Content headingContent = new StringContent(".*");
Content heading = HtmlTree.HEADING(HtmlConstants.PACKAGE_HEADING, true,
pkgNameContent);
*** 219,241 ****
}
/**
* Get the table caption and header for the constant summary table
*
! * @param cd classdoc to be documented
* @return constant members header content
*/
! public Content getConstantMembersHeader(ClassDoc cd) {
//generate links backward only to public classes.
! Content classlink = (cd.isPublic() || cd.isProtected()) ?
getLink(new LinkInfoImpl(configuration,
! LinkInfoImpl.Kind.CONSTANT_SUMMARY, cd)) :
! new StringContent(cd.qualifiedName());
! String name = cd.containingPackage().name();
! if (name.length() > 0) {
Content cb = new ContentBuilder();
! cb.addContent(name);
cb.addContent(".");
cb.addContent(classlink);
return getClassName(cb);
} else {
return getClassName(classlink);
--- 230,253 ----
}
/**
* Get the table caption and header for the constant summary table
*
! * @param typeElement the TypeElement to be documented
* @return constant members header content
*/
! public Content getConstantMembersHeader(TypeElement typeElement) {
//generate links backward only to public classes.
! Content classlink = (utils.isPublic(typeElement) || utils.isProtected(typeElement)) ?
getLink(new LinkInfoImpl(configuration,
! LinkInfoImpl.Kind.CONSTANT_SUMMARY, typeElement)) :
! new StringContent(utils.getFullyQualifiedName(typeElement));
!
! PackageElement enclosingPackage = utils.containingPackage(typeElement);
! if (!enclosingPackage.isUnnamed()) {
Content cb = new ContentBuilder();
! cb.addContent(enclosingPackage.getQualifiedName().toString());
cb.addContent(".");
cb.addContent(classlink);
return getClassName(cb);
} else {
return getClassName(classlink);
*** 258,281 ****
}
/**
* {@inheritDoc}
*/
! public void addConstantMembers(ClassDoc cd, List<FieldDoc> fields,
Content classConstantTree) {
! currentClassDoc = cd;
Content tbody = new HtmlTree(HtmlTag.TBODY);
! for (int i = 0; i < fields.size(); ++i) {
HtmlTree tr = new HtmlTree(HtmlTag.TR);
! if (i%2 == 0)
! tr.addStyle(HtmlStyle.altColor);
! else
! tr.addStyle(HtmlStyle.rowColor);
! addConstantMember(fields.get(i), tr);
tbody.addContent(tr);
}
! Content table = getConstantMembersHeader(cd);
table.addContent(tbody);
Content li = HtmlTree.LI(HtmlStyle.blockList, table);
classConstantTree.addContent(li);
}
--- 270,292 ----
}
/**
* {@inheritDoc}
*/
! public void addConstantMembers(TypeElement typeElement, Collection<VariableElement> fields,
Content classConstantTree) {
! currentTypeElement = typeElement;
Content tbody = new HtmlTree(HtmlTag.TBODY);
! boolean altColor = true;
! for (VariableElement field : fields) {
HtmlTree tr = new HtmlTree(HtmlTag.TR);
! tr.addStyle(altColor ? HtmlStyle.altColor : HtmlStyle.rowColor);
! addConstantMember(field, tr);
tbody.addContent(tr);
+ altColor = !altColor;
}
! Content table = getConstantMembersHeader(typeElement);
table.addContent(tbody);
Content li = HtmlTree.LI(HtmlStyle.blockList, table);
classConstantTree.addContent(li);
}
*** 283,293 ****
* Add the row for the constant summary table.
*
* @param member the field to be documented.
* @param trTree an htmltree object for the table row
*/
! private void addConstantMember(FieldDoc member, HtmlTree trTree) {
trTree.addContent(getTypeColumn(member));
trTree.addContent(getNameColumn(member));
trTree.addContent(getValue(member));
}
--- 294,304 ----
* Add the row for the constant summary table.
*
* @param member the field to be documented.
* @param trTree an htmltree object for the table row
*/
! private void addConstantMember(VariableElement member, HtmlTree trTree) {
trTree.addContent(getTypeColumn(member));
trTree.addContent(getNameColumn(member));
trTree.addContent(getValue(member));
}
*** 295,317 ****
* Get the type column for the constant summary table row.
*
* @param member the field to be documented.
* @return the type column of the constant table row
*/
! private Content getTypeColumn(FieldDoc member) {
! Content anchor = getMarkerAnchor(currentClassDoc.qualifiedName() +
! "." + member.name());
Content tdType = HtmlTree.TD(HtmlStyle.colFirst, anchor);
Content code = new HtmlTree(HtmlTag.CODE);
! StringTokenizer mods = new StringTokenizer(member.modifiers());
! while(mods.hasMoreTokens()) {
! Content modifier = new StringContent(mods.nextToken());
code.addContent(modifier);
code.addContent(getSpace());
}
Content type = getLink(new LinkInfoImpl(configuration,
! LinkInfoImpl.Kind.CONSTANT_SUMMARY, member.type()));
code.addContent(type);
tdType.addContent(code);
return tdType;
}
--- 306,327 ----
* Get the type column for the constant summary table row.
*
* @param member the field to be documented.
* @return the type column of the constant table row
*/
! private Content getTypeColumn(VariableElement member) {
! Content anchor = getMarkerAnchor(currentTypeElement.getQualifiedName() +
! "." + member.getSimpleName());
Content tdType = HtmlTree.TD(HtmlStyle.colFirst, anchor);
Content code = new HtmlTree(HtmlTag.CODE);
! for (Modifier mod : member.getModifiers()) {
! Content modifier = new StringContent(mod.toString());
code.addContent(modifier);
code.addContent(getSpace());
}
Content type = getLink(new LinkInfoImpl(configuration,
! LinkInfoImpl.Kind.CONSTANT_SUMMARY, member.asType()));
code.addContent(type);
tdType.addContent(code);
return tdType;
}
*** 319,331 ****
* Get the name column for the constant summary table row.
*
* @param member the field to be documented.
* @return the name column of the constant table row
*/
! private Content getNameColumn(FieldDoc member) {
! Content nameContent = getDocLink(
! LinkInfoImpl.Kind.CONSTANT_SUMMARY, member, member.name(), false);
Content code = HtmlTree.CODE(nameContent);
return HtmlTree.TD(code);
}
/**
--- 329,341 ----
* Get the name column for the constant summary table row.
*
* @param member the field to be documented.
* @return the name column of the constant table row
*/
! private Content getNameColumn(VariableElement member) {
! Content nameContent = getDocLink(LinkInfoImpl.Kind.CONSTANT_SUMMARY,
! member, member.getSimpleName().toString(), false);
Content code = HtmlTree.CODE(nameContent);
return HtmlTree.TD(code);
}
/**
*** 332,343 ****
* Get the value column for the constant summary table row.
*
* @param member the field to be documented.
* @return the value column of the constant table row
*/
! private Content getValue(FieldDoc member) {
! Content valueContent = new StringContent(member.constantValueExpression());
Content code = HtmlTree.CODE(valueContent);
return HtmlTree.TD(HtmlStyle.colLast, code);
}
/**
--- 342,354 ----
* Get the value column for the constant summary table row.
*
* @param member the field to be documented.
* @return the value column of the constant table row
*/
! private Content getValue(VariableElement member) {
! String value = utils.constantValueExpresion(member);
! Content valueContent = new StringContent(value);
Content code = HtmlTree.CODE(valueContent);
return HtmlTree.TD(HtmlStyle.colLast, code);
}
/**