infernap12/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2026-05-11 14:11:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

8012311: Cleanup names and duplicatre code in TagletManager

Browse Source 
Reviewed-by: darcy
This commit is contained in:
Jonathan Gibbons 2013-05-14 10:14:56 -07:00
parent 3cbf2d13c3
commit 2a88c7b71d
6 changed files with 77 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java
View File

@ -248,7 +248,7 @@ public class HtmlDocletWriter extends HtmlDocWriter {
}
TagletOutputImpl output = new TagletOutputImpl();
TagletWriter.genTagOuput(configuration.tagletManager, doc,
configuration.tagletManager.getCustomTags(doc),
configuration.tagletManager.getCustomTaglets(doc),
getTagletWriterInstance(false), output);
dl.addContent(output.getContent());
htmltree.addContent(dl);
@ -264,7 +264,7 @@ public class HtmlDocletWriter extends HtmlDocWriter {
protected boolean hasSerializationOverviewTags(FieldDoc field) {
TagletOutputImpl output = new TagletOutputImpl();
TagletWriter.genTagOuput(configuration.tagletManager, field,
configuration.tagletManager.getCustomTags(field),
configuration.tagletManager.getCustomTaglets(field),
getTagletWriterInstance(false), output);
return !output.getContent().isEmpty();
}

2
langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlSerialFieldWriter.java
View File

@ -188,7 +188,7 @@ public class HtmlSerialFieldWriter extends FieldWriterImpl
public void addMemberTags(FieldDoc field, Content contentTree) {
TagletOutputImpl output = new TagletOutputImpl();
TagletWriter.genTagOuput(configuration.tagletManager, field,
configuration.tagletManager.getCustomTags(field),
configuration.tagletManager.getCustomTaglets(field),
writer.getTagletWriterInstance(false), output);
Content tagContent = output.getContent();
Content dlTags = new HtmlTree(HtmlTag.DL);

2
langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlSerialMethodWriter.java
View File

@ -150,7 +150,7 @@ public class HtmlSerialMethodWriter extends MethodWriterImpl implements
TagletManager tagletManager =
configuration.tagletManager;
TagletWriter.genTagOuput(tagletManager, member,
tagletManager.getSerializedFormTags(),
tagletManager.getSerializedFormTaglets(),
writer.getTagletWriterInstance(false), output);
Content tagContent = output.getContent();
Content dlTags = new HtmlTree(HtmlTag.DL);

154
langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/TagletManager.java
View File

@ -183,7 +183,7 @@ public class TagletManager {
this.showauthor = showauthor;
this.javafx = javafx;
this.message = message;
initStandardTags();
initStandardTaglets();
initStandardTagsLowercase();
}
@ -453,9 +453,9 @@ public class TagletManager {
* @return the array of <code>Taglet</code>s that can
* appear in packages.
*/
public Taglet[] getPackageCustomTags() {
public Taglet[] getPackageCustomTaglets() {
if (packageTags == null) {
initCustomTagArrays();
initCustomTagletArrays();
}
return packageTags;
}
@ -466,9 +466,9 @@ public class TagletManager {
* @return the array of <code>Taglet</code>s that can
* appear in classes or interfaces.
*/
public Taglet[] getTypeCustomTags() {
public Taglet[] getTypeCustomTaglets() {
if (typeTags == null) {
initCustomTagArrays();
initCustomTagletArrays();
}
return typeTags;
}
@ -479,9 +479,9 @@ public class TagletManager {
* @return the array of <code>Taglet</code>s that can
* appear in comments.
*/
public Taglet[] getInlineCustomTags() {
public Taglet[] getInlineCustomTaglets() {
if (inlineTags == null) {
initCustomTagArrays();
initCustomTagletArrays();
}
return inlineTags;
}
@ -492,9 +492,9 @@ public class TagletManager {
* @return the array of <code>Taglet</code>s that can
* appear in field.
*/
public Taglet[] getFieldCustomTags() {
public Taglet[] getFieldCustomTaglets() {
if (fieldTags == null) {
initCustomTagArrays();
initCustomTagletArrays();
}
return fieldTags;
}
@ -505,9 +505,9 @@ public class TagletManager {
* @return the array of <code>Taglet</code>s that can
* appear in the serialized form.
*/
public Taglet[] getSerializedFormTags() {
public Taglet[] getSerializedFormTaglets() {
if (serializedFormTags == null) {
initCustomTagArrays();
initCustomTagletArrays();
}
return serializedFormTags;
}
@ -516,19 +516,19 @@ public class TagletManager {
* @return the array of <code>Taglet</code>s that can
* appear in the given Doc.
*/
public Taglet[] getCustomTags(Doc doc) {
public Taglet[] getCustomTaglets(Doc doc) {
if (doc instanceof ConstructorDoc) {
return getConstructorCustomTags();
return getConstructorCustomTaglets();
} else if (doc instanceof MethodDoc) {
return getMethodCustomTags();
return getMethodCustomTaglets();
} else if (doc instanceof FieldDoc) {
return getFieldCustomTags();
return getFieldCustomTaglets();
} else if (doc instanceof ClassDoc) {
return getTypeCustomTags();
return getTypeCustomTaglets();
} else if (doc instanceof PackageDoc) {
return getPackageCustomTags();
return getPackageCustomTaglets();
} else if (doc instanceof RootDoc) {
return getOverviewCustomTags();
return getOverviewCustomTaglets();
}
return null;
}
@ -539,9 +539,9 @@ public class TagletManager {
* @return the array of <code>Taglet</code>s that can
* appear in constructors.
*/
public Taglet[] getConstructorCustomTags() {
public Taglet[] getConstructorCustomTaglets() {
if (constructorTags == null) {
initCustomTagArrays();
initCustomTagletArrays();
}
return constructorTags;
}
@ -552,9 +552,9 @@ public class TagletManager {
* @return the array of <code>Taglet</code>s that can
* appear in methods.
*/
public Taglet[] getMethodCustomTags() {
public Taglet[] getMethodCustomTaglets() {
if (methodTags == null) {
initCustomTagArrays();
initCustomTagletArrays();
}
return methodTags;
}
@ -565,9 +565,9 @@ public class TagletManager {
* @return the array of <code>Taglet</code>s that can
* appear in overview.
*/
public Taglet[] getOverviewCustomTags() {
public Taglet[] getOverviewCustomTaglets() {
if (overviewTags == null) {
initCustomTagArrays();
initCustomTagletArrays();
}
return overviewTags;
}
@ -575,7 +575,7 @@ public class TagletManager {
/**
* Initialize the custom tag arrays.
*/
private void initCustomTagArrays() {
private void initCustomTagletArrays() {
Iterator<Taglet> it = customTags.values().iterator();
ArrayList<Taglet> pTags = new ArrayList<Taglet>(customTags.size());
ArrayList<Taglet> tTags = new ArrayList<Taglet>(customTags.size());
@ -630,84 +630,72 @@ public class TagletManager {
/**
* Initialize standard Javadoc tags for ordering purposes.
*/
private void initStandardTags() {
private void initStandardTaglets() {
Taglet temp;
customTags.put((temp = new ParamTaglet()).getName(), temp);
customTags.put((temp = new ReturnTaglet()).getName(), temp);
customTags.put((temp = new ThrowsTaglet()).getName(), temp);
customTags.put((temp = new SimpleTaglet("exception",
null, SimpleTaglet.METHOD + SimpleTaglet.CONSTRUCTOR)).getName(), temp);
if (!nosince) {
customTags.put((temp = new SimpleTaglet("since", message.getText("doclet.Since"),
SimpleTaglet.ALL)).getName(), temp);
}
if (showversion) {
customTags.put((temp = new SimpleTaglet("version", message.getText("doclet.Version"),
SimpleTaglet.PACKAGE + SimpleTaglet.TYPE + SimpleTaglet.OVERVIEW)).getName(), temp);
}
if (showauthor) {
customTags.put((temp = new SimpleTaglet("author", message.getText("doclet.Author"),
SimpleTaglet.PACKAGE + SimpleTaglet.TYPE + SimpleTaglet.OVERVIEW)).getName(), temp);
}
customTags.put((temp = new SimpleTaglet("serialData", message.getText("doclet.SerialData"),
SimpleTaglet.EXCLUDED)).getName(), temp);
addStandardTaglet(new ParamTaglet());
addStandardTaglet(new ReturnTaglet());
addStandardTaglet(new ThrowsTaglet());
addStandardTaglet(new SimpleTaglet("exception", null,
SimpleTaglet.METHOD + SimpleTaglet.CONSTRUCTOR));
addStandardTaglet(!nosince, new SimpleTaglet("since", message.getText("doclet.Since"),
SimpleTaglet.ALL));
addStandardTaglet(showversion, new SimpleTaglet("version", message.getText("doclet.Version"),
SimpleTaglet.PACKAGE + SimpleTaglet.TYPE + SimpleTaglet.OVERVIEW));
addStandardTaglet(showauthor, new SimpleTaglet("author", message.getText("doclet.Author"),
SimpleTaglet.PACKAGE + SimpleTaglet.TYPE + SimpleTaglet.OVERVIEW));
addStandardTaglet(new SimpleTaglet("serialData", message.getText("doclet.SerialData"),
SimpleTaglet.EXCLUDED));
customTags.put((temp = new SimpleTaglet("factory", message.getText("doclet.Factory"),
SimpleTaglet.METHOD)).getName(), temp);
customTags.put((temp = new SeeTaglet()).getName(), temp);
addStandardTaglet(new SeeTaglet());
//Standard inline tags
customTags.put((temp = new DocRootTaglet()).getName(), temp);
customTags.put((temp = new InheritDocTaglet()).getName(), temp);
customTags.put((temp = new ValueTaglet()).getName(), temp);
customTags.put((temp = new LiteralTaglet()).getName(), temp);
customTags.put((temp = new CodeTaglet()).getName(), temp);
addStandardTaglet(new DocRootTaglet());
addStandardTaglet(new InheritDocTaglet());
addStandardTaglet(new ValueTaglet());
addStandardTaglet(new LiteralTaglet());
addStandardTaglet(new CodeTaglet());
//Keep track of the names of standard tags for error
//checking purposes.
standardTags.add("param");
standardTags.add("return");
standardTags.add("throws");
standardTags.add("exception");
standardTags.add("since");
standardTags.add("version");
standardTags.add("author");
standardTags.add("see");
// Keep track of the names of standard tags for error
// checking purposes. The following are not handled above.
// See, for example, com.sun.tools.javadoc.Comment
standardTags.add("deprecated");
standardTags.add("link");
standardTags.add("linkplain");
standardTags.add("inheritDoc");
standardTags.add("docRoot");
standardTags.add("value");
standardTags.add("serial");
standardTags.add("serialData");
standardTags.add("serialField");
standardTags.add("Text");
standardTags.add("literal");
standardTags.add("code");
if (javafx) {
initJavaFXTags();
initJavaFXTaglets();
}
}
/**
* Initialize JavaFX-related tags.
*/
private void initJavaFXTags() {
Taglet temp;
customTags.put((temp = new PropertyGetterTaglet()).getName(), temp);
customTags.put((temp = new PropertySetterTaglet()).getName(), temp);
customTags.put((temp = new SimpleTaglet("propertyDescription", message.getText("doclet.PropertyDescription"),
SimpleTaglet.FIELD + SimpleTaglet.METHOD)).getName(), temp);
customTags.put((temp = new SimpleTaglet("defaultValue", message.getText("doclet.DefaultValue"),
SimpleTaglet.FIELD + SimpleTaglet.METHOD)).getName(), temp);
customTags.put((temp = new SimpleTaglet("treatAsPrivate", null,
SimpleTaglet.FIELD + SimpleTaglet.METHOD + SimpleTaglet.TYPE)).getName(), temp);
private void initJavaFXTaglets() {
addStandardTaglet(new PropertyGetterTaglet());
addStandardTaglet(new PropertySetterTaglet());
addStandardTaglet(new SimpleTaglet("propertyDescription",
message.getText("doclet.PropertyDescription"),
SimpleTaglet.FIELD + SimpleTaglet.METHOD));
addStandardTaglet(new SimpleTaglet("defaultValue", message.getText("doclet.DefaultValue"),
SimpleTaglet.FIELD + SimpleTaglet.METHOD));
addStandardTaglet(new SimpleTaglet("treatAsPrivate", null,
SimpleTaglet.FIELD + SimpleTaglet.METHOD + SimpleTaglet.TYPE));
}
standardTags.add("propertyGetter");
standardTags.add("propertySetter");
standardTags.add("propertyDescription");
standardTags.add("defaultValue");
standardTags.add("treatAsPrivate");
void addStandardTaglet(Taglet taglet) {
String name = taglet.getName();
customTags.put(name, taglet);
standardTags.add(name);
}
void addStandardTaglet(boolean enable, Taglet taglet) {
String name = taglet.getName();
if (enable)
customTags.put(name, taglet);
standardTags.add(name);
}
/**

2
langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/TagletWriter.java
View File

@ -244,7 +244,7 @@ public abstract class TagletWriter {
*/
public static TagletOutput getInlineTagOuput(TagletManager tagletManager,
Tag holderTag, Tag inlineTag, TagletWriter tagletWriter) {
Taglet[] definedTags = tagletManager.getInlineCustomTags();
Taglet[] definedTags = tagletManager.getInlineCustomTaglets();
//This is a custom inline tag.
for (int j = 0; j < definedTags.length; j++) {
if (("@"+definedTags[j].getName()).equals(inlineTag.name())) {

2
langtools/test/com/sun/javadoc/testJavaFX/TestJavaFX.java
View File

@ -23,7 +23,7 @@
/*
* @test
* @bug 7112427
* @bug 7112427 8012295
* @summary Test of the JavaFX doclet features.
* @author jvalenta
* @library ../lib/