diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java index e7c5385d937..b671ed16c3b 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java @@ -535,7 +535,7 @@ public abstract class AbstractMemberWriter { TypeElement superClass = utils.getSuperClass(typeElement); while (superClass != null) { - if (visibleMemberMap.hasMembersFor(superClass)) { + if (visibleMemberMap.hasMembers(superClass)) { liNav.addContent(getNavSummaryLink(superClass, true)); return; } diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConfigurationImpl.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConfigurationImpl.java index d2607ba41b8..3485be66d24 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConfigurationImpl.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConfigurationImpl.java @@ -135,8 +135,6 @@ public class ConfigurationImpl extends Configuration { */ public String docrootparent = ""; - public boolean sortedMethodDetails = false; - /** * True if command line option "-nohelp" is used. Default value is false. */ diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConstructorWriterImpl.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConstructorWriterImpl.java index be59ef815c9..612c2e0db06 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConstructorWriterImpl.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConstructorWriterImpl.java @@ -72,7 +72,7 @@ public class ConstructorWriterImpl extends AbstractExecutableMemberWriter VisibleMemberMap visibleMemberMap = new VisibleMemberMap( typeElement, VisibleMemberMap.Kind.CONSTRUCTORS, configuration); - SortedSet constructors = visibleMemberMap.getMembersFor(typeElement); + List constructors = visibleMemberMap.getMembers(typeElement); for (Element constructor : constructors) { if (utils.isProtected(constructor) || utils.isPrivate(constructor)) { setFoundNonPubConstructor(true); diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractMemberBuilder.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractMemberBuilder.java index ee0dba08fee..3bc2b1a1939 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractMemberBuilder.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractMemberBuilder.java @@ -25,6 +25,15 @@ package jdk.javadoc.internal.doclets.toolkit.builders; +import java.util.Collection; +import java.util.Comparator; +import java.util.Iterator; +import java.util.SortedSet; +import java.util.TreeSet; + +import javax.lang.model.element.Element; + +import jdk.javadoc.internal.doclets.formats.html.ConfigurationImpl; import jdk.javadoc.internal.doclets.toolkit.Content; import jdk.javadoc.internal.doclets.toolkit.DocletException; @@ -42,6 +51,7 @@ import jdk.javadoc.internal.doclets.toolkit.DocletException; */ public abstract class AbstractMemberBuilder extends AbstractBuilder { + public final Comparator comparator; /** * Construct a SubBuilder. * @param context a context object, providing information used in this run @@ -49,6 +59,7 @@ public abstract class AbstractMemberBuilder extends AbstractBuilder { */ public AbstractMemberBuilder(Context context) { super(context); + comparator = utils.makeGeneralPurposeComparator(); } /** @@ -83,4 +94,10 @@ public abstract class AbstractMemberBuilder extends AbstractBuilder { * @return true if this subbuilder has anything to document */ public abstract boolean hasMembersToDocument(); + + public SortedSet asSortedSet(Collection members) { + SortedSet out = new TreeSet<>(comparator); + out.addAll(members); + return out; + } } diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeFieldBuilder.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeFieldBuilder.java index f8d020ab904..9026429b7c9 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeFieldBuilder.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeFieldBuilder.java @@ -67,7 +67,7 @@ public class AnnotationTypeFieldBuilder extends AbstractMemberBuilder { /** * The list of members being documented. */ - protected SortedSet members; + protected List members; /** * The index of the current member that is being documented at this point @@ -91,7 +91,7 @@ public class AnnotationTypeFieldBuilder extends AbstractMemberBuilder { this.typeElement = typeElement; this.writer = writer; this.visibleMemberMap = new VisibleMemberMap(typeElement, memberType, configuration); - this.members = this.visibleMemberMap.getMembersFor(typeElement); + this.members = this.visibleMemberMap.getMembers(typeElement); } @@ -118,26 +118,6 @@ public class AnnotationTypeFieldBuilder extends AbstractMemberBuilder { return "AnnotationTypeFieldDetails"; } - /** - * Returns a list of members that will be documented for the given class. - * This information can be used for doclet specific documentation - * generation. - * - * @param typeElement the TypeElement we want to check. - * @return a list of members that will be documented. - */ - public SortedSet members(TypeElement typeElement) { - return visibleMemberMap.getMembersFor(typeElement); - } - - /** - * Returns the visible member map for the members of this class. - * - * @return the visible member map for the members of this class. - */ - public VisibleMemberMap getVisibleMemberMap() { - return visibleMemberMap; - } /** * Returns whether or not there are members to document. @@ -145,7 +125,7 @@ public class AnnotationTypeFieldBuilder extends AbstractMemberBuilder { */ @Override public boolean hasMembersToDocument() { - return members.size() > 0; + return !members.isEmpty(); } /** @@ -172,16 +152,19 @@ public class AnnotationTypeFieldBuilder extends AbstractMemberBuilder { if (writer == null) { return; } - if (!members.isEmpty()) { + if (hasMembersToDocument()) { writer.addAnnotationFieldDetailsMarker(memberDetailsTree); - for (Element element : members) { - currentMember = element; + + Element lastElement = members.get(members.size() - 1); + for (Element member : members) { + currentMember = member; Content detailsTree = writer.getMemberTreeHeader(); writer.addAnnotationDetailsTreeHeader(typeElement, detailsTree); - Content annotationDocTree = writer.getAnnotationDocTreeHeader(element, detailsTree); + Content annotationDocTree = writer.getAnnotationDocTreeHeader(currentMember, + detailsTree); buildChildren(node, annotationDocTree); detailsTree.addContent(writer.getAnnotationDoc( - annotationDocTree, currentMember == members.last())); + annotationDocTree, currentMember == lastElement)); memberDetailsTree.addContent(writer.getAnnotationDetails(detailsTree)); } } diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeRequiredMemberBuilder.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeRequiredMemberBuilder.java index 8f4a678c585..412f723ef16 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeRequiredMemberBuilder.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AnnotationTypeRequiredMemberBuilder.java @@ -68,7 +68,7 @@ public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder { /** * The list of members being documented. */ - protected SortedSet members; + protected List members; /** * The index of the current member that is being documented at this point @@ -82,6 +82,7 @@ public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder { * @param context the build context. * @param typeElement the class whose members are being documented. * @param writer the doclet specific writer. + * @param memberType the kind of member this builder processes. */ protected AnnotationTypeRequiredMemberBuilder(Context context, TypeElement typeElement, @@ -91,7 +92,7 @@ public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder { this.typeElement = typeElement; this.writer = writer; this.visibleMemberMap = new VisibleMemberMap(typeElement, memberType, configuration); - this.members = this.visibleMemberMap.getMembersFor(typeElement); + this.members = this.visibleMemberMap.getMembers(typeElement); } @@ -101,6 +102,7 @@ public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder { * @param context the build context. * @param typeElement the class whose members are being documented. * @param writer the doclet specific writer. + * @return an instance of this object */ public static AnnotationTypeRequiredMemberBuilder getInstance( Context context, TypeElement typeElement, @@ -118,34 +120,13 @@ public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder { return "AnnotationTypeRequiredMemberDetails"; } - /** - * Returns a list of members that will be documented for the given class. - * This information can be used for doclet specific documentation - * generation. - * - * @param typeElement the {@link TypeElement} we want to check. - * @return a list of members that will be documented. - */ - public SortedSet members(TypeElement typeElement) { - return visibleMemberMap.getMembersFor(typeElement); - } - - /** - * Returns the visible member map for the members of this class. - * - * @return the visible member map for the members of this class. - */ - public VisibleMemberMap getVisibleMemberMap() { - return visibleMemberMap; - } - /** * Returns whether or not there are members to document. * @return whether or not there are members to document */ @Override public boolean hasMembersToDocument() { - return members.size() > 0; + return !members.isEmpty(); } /** @@ -165,24 +146,25 @@ public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder { * * @param node the XML element that specifies which components to document * @param memberDetailsTree the content tree to which the documentation will be added + * @throws DocletException if an error occurs */ public void buildAnnotationTypeMember(XMLNode node, Content memberDetailsTree) throws DocletException { if (writer == null) { return; } - int size = members.size(); - if (size > 0) { + if (hasMembersToDocument()) { writer.addAnnotationDetailsMarker(memberDetailsTree); - for (Element element : members) { - currentMember = element; + Element lastMember = members.get((members.size() - 1)); + for (Element member : members) { + currentMember = member; Content detailsTree = writer.getMemberTreeHeader(); writer.addAnnotationDetailsTreeHeader(typeElement, detailsTree); Content annotationDocTree = writer.getAnnotationDocTreeHeader( - element, detailsTree); + currentMember, detailsTree); buildChildren(node, annotationDocTree); detailsTree.addContent(writer.getAnnotationDoc( - annotationDocTree, currentMember == members.last())); + annotationDocTree, currentMember == lastMember)); memberDetailsTree.addContent(writer.getAnnotationDetails(detailsTree)); } } diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstantsSummaryBuilder.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstantsSummaryBuilder.java index 45eea2bc5b9..75a01fa5c73 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstantsSummaryBuilder.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstantsSummaryBuilder.java @@ -275,7 +275,7 @@ public class ConstantsSummaryBuilder extends AbstractBuilder { private boolean hasConstantField (TypeElement typeElement) { VisibleMemberMap visibleMemberMapFields = new VisibleMemberMap(typeElement, VisibleMemberMap.Kind.FIELDS, configuration); - SortedSet fields = visibleMemberMapFields.getLeafClassMembers(); + List fields = visibleMemberMapFields.getLeafMembers(); for (Element f : fields) { VariableElement field = (VariableElement)f; if (field.getConstantValue() != null) { @@ -350,21 +350,21 @@ public class ConstantsSummaryBuilder extends AbstractBuilder { } /** - * Return the list of visible constant fields for the given TypeElement. - * @return the list of visible constant fields for the given TypeElement. + * Returns a set of visible constant fields for the given type. + * @return the set of visible constant fields for the given type. */ protected SortedSet members() { - SortedSet list = visibleMemberMapFields.getLeafClassMembers(); - list.addAll(visibleMemberMapEnumConst.getLeafClassMembers()); - SortedSet inclList = + List members = visibleMemberMapFields.getLeafMembers(); + members.addAll(visibleMemberMapEnumConst.getLeafMembers()); + SortedSet includes = new TreeSet<>(utils.makeGeneralPurposeComparator()); - for (Element element : list) { + for (Element element : members) { VariableElement member = (VariableElement)element; if (member.getConstantValue() != null) { - inclList.add(member); + includes.add(member); } } - return inclList; + return includes; } } } diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstructorBuilder.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstructorBuilder.java index 787ba257eb7..ee8076bb72f 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstructorBuilder.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ConstructorBuilder.java @@ -59,7 +59,7 @@ public class ConstructorBuilder extends AbstractMemberBuilder { /** * The current constructor that is being documented at this point in time. */ - private ExecutableElement constructor; + private ExecutableElement currentConstructor; /** * The class whose constructors are being documented. @@ -79,7 +79,7 @@ public class ConstructorBuilder extends AbstractMemberBuilder { /** * The constructors being documented. */ - private final SortedSet constructors; + private final List constructors; /** * Construct a new ConstructorBuilder. @@ -99,7 +99,7 @@ public class ConstructorBuilder extends AbstractMemberBuilder { typeElement, VisibleMemberMap.Kind.CONSTRUCTORS, configuration); - constructors = visibleMemberMap.getMembersFor(typeElement); + constructors = visibleMemberMap.getMembers(typeElement); for (Element ctor : constructors) { if (utils.isProtected(ctor) || utils.isPrivate(ctor)) { writer.setFoundNonPubConstructor(true); @@ -136,18 +136,6 @@ public class ConstructorBuilder extends AbstractMemberBuilder { return !constructors.isEmpty(); } - /** - * Returns a list of constructors that will be documented for the given class. - * This information can be used for doclet specific documentation - * generation. - * - * @param typeElement the class - * @return a list of constructors that will be documented. - */ - public SortedSet members(TypeElement typeElement) { - return visibleMemberMap.getMembersFor(typeElement); - } - /** * Return the constructor writer for this builder. * @@ -168,17 +156,17 @@ public class ConstructorBuilder extends AbstractMemberBuilder { if (writer == null) { return; } - int size = constructors.size(); - if (size > 0) { + if (hasMembersToDocument()) { Content constructorDetailsTree = writer.getConstructorDetailsTreeHeader(typeElement, memberDetailsTree); - for (Element ctor : constructors) { - constructor = (ExecutableElement)ctor; - Content constructorDocTree = writer.getConstructorDocTreeHeader( - constructor, constructorDetailsTree); + + Element lastElement = constructors.get(constructors.size() - 1); + for (Element contructor : constructors) { + currentConstructor = (ExecutableElement)contructor; + Content constructorDocTree = writer.getConstructorDocTreeHeader(currentConstructor, constructorDetailsTree); buildChildren(node, constructorDocTree); constructorDetailsTree.addContent(writer.getConstructorDoc(constructorDocTree, - constructors.last().equals(constructor))); + currentConstructor == lastElement)); } memberDetailsTree.addContent( writer.getConstructorDetails(constructorDetailsTree)); @@ -192,7 +180,7 @@ public class ConstructorBuilder extends AbstractMemberBuilder { * @param constructorDocTree the content tree to which the documentation will be added */ public void buildSignature(XMLNode node, Content constructorDocTree) { - constructorDocTree.addContent(writer.getSignature(constructor)); + constructorDocTree.addContent(writer.getSignature(currentConstructor)); } /** @@ -202,7 +190,7 @@ public class ConstructorBuilder extends AbstractMemberBuilder { * @param constructorDocTree the content tree to which the documentation will be added */ public void buildDeprecationInfo(XMLNode node, Content constructorDocTree) { - writer.addDeprecated(constructor, constructorDocTree); + writer.addDeprecated(currentConstructor, constructorDocTree); } /** @@ -214,7 +202,7 @@ public class ConstructorBuilder extends AbstractMemberBuilder { */ public void buildConstructorComments(XMLNode node, Content constructorDocTree) { if (!configuration.nocomment) { - writer.addComments(constructor, constructorDocTree); + writer.addComments(currentConstructor, constructorDocTree); } } @@ -225,6 +213,6 @@ public class ConstructorBuilder extends AbstractMemberBuilder { * @param constructorDocTree the content tree to which the documentation will be added */ public void buildTagInfo(XMLNode node, Content constructorDocTree) { - writer.addTags(constructor, constructorDocTree); + writer.addTags(currentConstructor, constructorDocTree); } } diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/EnumConstantBuilder.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/EnumConstantBuilder.java index 47ac296c5e9..ddb6619225e 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/EnumConstantBuilder.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/EnumConstantBuilder.java @@ -67,9 +67,9 @@ public class EnumConstantBuilder extends AbstractMemberBuilder { private final EnumConstantWriter writer; /** - * The list of enum constants being documented. + * The set of enum constants being documented. */ - private final SortedSet enumConstants; + private final List enumConstants; /** * The current enum constant that is being documented at this point @@ -94,7 +94,7 @@ public class EnumConstantBuilder extends AbstractMemberBuilder { typeElement, VisibleMemberMap.Kind.ENUM_CONSTANTS, configuration); - enumConstants = visibleMemberMap.getMembersFor(typeElement); + enumConstants = visibleMemberMap.getMembers(typeElement); } /** @@ -118,27 +118,6 @@ public class EnumConstantBuilder extends AbstractMemberBuilder { return "EnumConstantDetails"; } - /** - * Returns a list of enum constants that will be documented for the given class. - * This information can be used for doclet specific documentation - * generation. - * - * @param typeElement the {@link TypeElement} we want to check. - * @return a list of enum constants that will be documented. - */ - public SortedSet members(TypeElement typeElement) { - return visibleMemberMap.getMembersFor(typeElement); - } - - /** - * Returns the visible member map for the enum constants of this class. - * - * @return the visible member map for the enum constants of this class. - */ - public VisibleMemberMap getVisibleMemberMap() { - return visibleMemberMap; - } - /** * Returns whether or not there are members to document. * @@ -146,7 +125,7 @@ public class EnumConstantBuilder extends AbstractMemberBuilder { */ @Override public boolean hasMembersToDocument() { - return enumConstants.size() > 0; + return !enumConstants.isEmpty(); } /** @@ -160,16 +139,17 @@ public class EnumConstantBuilder extends AbstractMemberBuilder { if (writer == null) { return; } - if (!enumConstants.isEmpty()) { + if (hasMembersToDocument()) { Content enumConstantsDetailsTree = writer.getEnumConstantsDetailsTreeHeader(typeElement, memberDetailsTree); - for (Element element : enumConstants) { - currentElement = (VariableElement)element; + Element lastElement = enumConstants.get(enumConstants.size() - 1); + for (Element enumConstant : enumConstants) { + currentElement = (VariableElement)enumConstant; Content enumConstantsTree = writer.getEnumConstantsTreeHeader(currentElement, enumConstantsDetailsTree); buildChildren(node, enumConstantsTree); enumConstantsDetailsTree.addContent(writer.getEnumConstants( - enumConstantsTree, currentElement.equals(enumConstants.last()))); + enumConstantsTree, currentElement == lastElement)); } memberDetailsTree.addContent( writer.getEnumConstantsDetails(enumConstantsDetailsTree)); diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/FieldBuilder.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/FieldBuilder.java index 09f6965f07f..ccb5671b9ab 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/FieldBuilder.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/FieldBuilder.java @@ -69,7 +69,7 @@ public class FieldBuilder extends AbstractMemberBuilder { /** * The list of fields being documented. */ - private final SortedSet fields; + private final List fields; /** * The index of the current field that is being documented at this point @@ -95,7 +95,7 @@ public class FieldBuilder extends AbstractMemberBuilder { typeElement, VisibleMemberMap.Kind.FIELDS, configuration); - fields = visibleMemberMap.getLeafClassMembers(); + fields = visibleMemberMap.getLeafMembers(); } /** @@ -120,27 +120,6 @@ public class FieldBuilder extends AbstractMemberBuilder { return "FieldDetails"; } - /** - * Returns a list of fields that will be documented for the given class. - * This information can be used for doclet specific documentation - * generation. - * - * @param typeElement the {@link TypeElement} we want to check. - * @return a list of fields that will be documented. - */ - public SortedSet members(TypeElement typeElement) { - return visibleMemberMap.getMembersFor(typeElement); - } - - /** - * Returns the visible member map for the fields of this class. - * - * @return the visible member map for the fields of this class. - */ - public VisibleMemberMap getVisibleMemberMap() { - return visibleMemberMap; - } - /** * Returns whether or not there are members to document. * @@ -164,12 +143,14 @@ public class FieldBuilder extends AbstractMemberBuilder { } if (!fields.isEmpty()) { Content fieldDetailsTree = writer.getFieldDetailsTreeHeader(typeElement, memberDetailsTree); + + Element lastElement = fields.get(fields.size() - 1); for (Element element : fields) { currentElement = (VariableElement)element; Content fieldDocTree = writer.getFieldDocTreeHeader(currentElement, fieldDetailsTree); buildChildren(node, fieldDocTree); fieldDetailsTree.addContent(writer.getFieldDoc( - fieldDocTree, currentElement.equals(fields.last()))); + fieldDocTree, currentElement == lastElement)); } memberDetailsTree.addContent( writer.getFieldDetails(fieldDetailsTree)); diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MemberSummaryBuilder.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MemberSummaryBuilder.java index 713fc028e7c..5534abd0bd3 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MemberSummaryBuilder.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MemberSummaryBuilder.java @@ -182,7 +182,9 @@ public class MemberSummaryBuilder extends AbstractMemberBuilder { * @see VisibleMemberMap */ public SortedSet members(VisibleMemberMap.Kind type) { - return visibleMemberMaps.get(type).getLeafClassMembers(); + TreeSet out = new TreeSet<>(comparator); + out.addAll(visibleMemberMaps.get(type).getLeafMembers()); + return out; } /** @@ -336,7 +338,7 @@ public class MemberSummaryBuilder extends AbstractMemberBuilder { */ private void buildSummary(MemberSummaryWriter writer, VisibleMemberMap visibleMemberMap, LinkedList summaryTreeList) { - SortedSet members = visibleMemberMap.getLeafClassMembers(); + SortedSet members = asSortedSet(visibleMemberMap.getLeafMembers()); if (!members.isEmpty()) { List tableContents = new LinkedList<>(); int counter = 0; @@ -492,7 +494,7 @@ public class MemberSummaryBuilder extends AbstractMemberBuilder { if (inhclass == typeElement) { continue; } - SortedSet inhmembers = visibleMemberMap.getMembersFor(inhclass); + SortedSet inhmembers = asSortedSet(visibleMemberMap.getMembers(inhclass)); if (!inhmembers.isEmpty()) { Content inheritedTree = writer.getInheritedSummaryHeader(inhclass); Content linksTree = writer.getInheritedSummaryLinksTree(); diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MethodBuilder.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MethodBuilder.java index 7511bdad07d..ba0e88a287b 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MethodBuilder.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MethodBuilder.java @@ -78,7 +78,7 @@ public class MethodBuilder extends AbstractMemberBuilder { /** * The methods being documented. */ - private final SortedSet methods; + private final List methods; /** @@ -98,7 +98,7 @@ public class MethodBuilder extends AbstractMemberBuilder { typeElement, VisibleMemberMap.Kind.METHODS, configuration); - methods = visibleMemberMap.getLeafClassMembers(); + methods = visibleMemberMap.getLeafMembers(); } /** @@ -123,27 +123,6 @@ public class MethodBuilder extends AbstractMemberBuilder { return "MethodDetails"; } - /** - * Returns a list of methods that will be documented for the given class. - * This information can be used for doclet specific documentation - * generation. - * - * @param typeElement the {@link TypeElement} we want to check. - * @return a list of methods that will be documented. - */ - public SortedSet members(TypeElement typeElement) { - return visibleMemberMap.getMembersFor(typeElement); - } - - /** - * Returns the visible member map for the methods of this class. - * - * @return the visible member map for the methods of this class. - */ - public VisibleMemberMap getVisibleMemberMap() { - return visibleMemberMap; - } - /** * {@inheritDoc} */ @@ -163,18 +142,17 @@ public class MethodBuilder extends AbstractMemberBuilder { if (writer == null) { return; } - if (!methods.isEmpty()) { + if (hasMembersToDocument()) { Content methodDetailsTree = writer.getMethodDetailsTreeHeader(typeElement, memberDetailsTree); - Set methodDetailSet = ((ConfigurationImpl)configuration).sortedMethodDetails - ? methods - : visibleMemberMap.getLeafClassMembersSourceOrder(); - for (Element e : methodDetailSet) { - currentMethod = (ExecutableElement) e; + + Element lastElement = methods.get(methods.size() - 1); + for (Element method : methods) { + currentMethod = (ExecutableElement)method; Content methodDocTree = writer.getMethodDocTreeHeader(currentMethod, methodDetailsTree); buildChildren(node, methodDocTree); methodDetailsTree.addContent(writer.getMethodDoc( - methodDocTree, currentMethod == methods.last())); + methodDocTree, currentMethod == lastElement)); } memberDetailsTree.addContent(writer.getMethodDetails(methodDetailsTree)); } diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/PropertyBuilder.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/PropertyBuilder.java index 68af2e3447b..986924f61fb 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/PropertyBuilder.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/PropertyBuilder.java @@ -69,7 +69,7 @@ public class PropertyBuilder extends AbstractMemberBuilder { /** * The list of properties being documented. */ - private final SortedSet properties; + private final List properties; /** * The index of the current property that is being documented at this point @@ -95,7 +95,7 @@ public class PropertyBuilder extends AbstractMemberBuilder { typeElement, VisibleMemberMap.Kind.PROPERTIES, configuration); - properties = visibleMemberMap.getMembersFor(typeElement); + properties = visibleMemberMap.getMembers(typeElement); } /** @@ -120,27 +120,6 @@ public class PropertyBuilder extends AbstractMemberBuilder { return "PropertyDetails"; } - /** - * Returns a list of properties that will be documented for the given class. - * This information can be used for doclet specific documentation - * generation. - * - * @param typeElement the {@link TypeElement} we want to check. - * @return a list of properties that will be documented. - */ - public SortedSet members(TypeElement typeElement) { - return visibleMemberMap.getMembersFor(typeElement); - } - - /** - * Returns the visible member map for the properties of this class. - * - * @return the visible member map for the properties of this class. - */ - public VisibleMemberMap getVisibleMemberMap() { - return visibleMemberMap; - } - /** * Returns whether or not there are members to document. * @@ -162,17 +141,17 @@ public class PropertyBuilder extends AbstractMemberBuilder { if (writer == null) { return; } - int size = properties.size(); - if (size > 0) { + if (hasMembersToDocument()) { Content propertyDetailsTree = writer.getPropertyDetailsTreeHeader(typeElement, memberDetailsTree); - for (Element e : properties) { - currentProperty = (ExecutableElement) e; + Element lastElement = properties.get(properties.size() - 1); + for (Element property : properties) { + currentProperty = (ExecutableElement)property; Content propertyDocTree = writer.getPropertyDocTreeHeader(currentProperty, propertyDetailsTree); buildChildren(node, propertyDocTree); propertyDetailsTree.addContent(writer.getPropertyDoc( - propertyDocTree, currentProperty == properties.last())); + propertyDocTree, currentProperty == lastElement)); } memberDetailsTree.addContent( writer.getPropertyDetails(propertyDetailsTree)); diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java index e23cf65983a..7ba231bac15 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java @@ -25,7 +25,6 @@ package jdk.javadoc.internal.doclets.toolkit.util; -import java.io.IOException; import java.lang.annotation.Documented; import java.lang.ref.SoftReference; import java.text.CollationKey; @@ -77,9 +76,7 @@ import com.sun.source.util.DocTrees; import com.sun.source.util.TreePath; import jdk.javadoc.internal.doclets.toolkit.CommentUtils.DocCommentDuo; import jdk.javadoc.internal.doclets.toolkit.Configuration; -import jdk.javadoc.internal.doclets.toolkit.DocletException; import jdk.javadoc.internal.doclets.toolkit.Messages; -import jdk.javadoc.internal.doclets.toolkit.Resources; import jdk.javadoc.internal.doclets.toolkit.WorkArounds; import static javax.lang.model.element.ElementKind.*; @@ -258,14 +255,6 @@ public class Utils { return getEnclosingTypeElement(e) == null || isStatic(e); } - public boolean matches(Element e1, Element e2) { - if (isExecutableElement(e1) && isExecutableElement(e1)) { - return executableMembersEqual((ExecutableElement)e1, (ExecutableElement)e2); - } else { - return e1.getSimpleName().equals(e2.getSimpleName()); - } - } - /** * Copy doc-files directory and its contents from the source * package directory to the generated documentation directory. @@ -2161,6 +2150,13 @@ public class Utils { return convertToExecutableElement(getItems(e, false, METHOD)); } + public int getOrdinalValue(VariableElement member) { + if (member == null || member.getKind() != ENUM_CONSTANT) { + throw new IllegalArgumentException("must be an enum constant: " + member); + } + return member.getEnclosingElement().getEnclosedElements().indexOf(member); + } + public long getLineNumber(Element e) { TreePath path = getTreePath(e); if (path == null) { // maybe null if synthesized diff --git a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberMap.java b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberMap.java index 6fbae159bf1..08e07514964 100644 --- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberMap.java +++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberMap.java @@ -220,48 +220,36 @@ public class VisibleMemberMap { } /** - * Return the visible members of the class being mapped. Also append at the - * end of the list members that are inherited by inaccessible parents. We - * document these members in the child because the parent is not documented. + * Returns a list of visible enclosed members of the type being mapped. + * This list may also contain appended members, inherited by inaccessible + * super types. These members are documented in the subtype when the + * super type is not documented. * - * @param configuration the current configuration of the doclet. + * @return a list of visible enclosed members */ - public SortedSet getLeafClassMembers() { - SortedSet result = getMembersFor(typeElement); - result.addAll(getInheritedPackagePrivateMethods()); - return result; - } - public Set getLeafClassMembersSourceOrder() { - Set result = new LinkedHashSet<>(classMap.get(typeElement).members); + public List getLeafMembers() { + List result = new ArrayList<>(); + result.addAll(classMap.get(typeElement).members); result.addAll(getInheritedPackagePrivateMethods()); return result; } /** - * Retrn the list of members for the given class. + * Returns a list of enclosed members for the given type. * - * @param typeElement the class to retrieve the list of visible members for. + * @param typeElement the given type * - * @return the list of members for the given class. + * @return a list of enclosed members */ - public SortedSet getMembersFor(TypeElement typeElement) { - return asSortedSet(classMap.get(typeElement).members); + public List getMembers(TypeElement typeElement) { + return classMap.get(typeElement).members; } - public boolean hasMembersFor(TypeElement typeElement) { + public boolean hasMembers(TypeElement typeElement) { return !classMap.get(typeElement).members.isEmpty(); } - private SortedSet asSortedSet(Collection in) { - if (in == null) { - return Collections.emptySortedSet(); - } - TreeSet out = new TreeSet<>(comparator); - out.addAll(in); - return out; - } - private void fillMemberLevelMap(List list, String level) { for (Element element : list) { Object key = getMemberKey(element); @@ -318,9 +306,9 @@ public class VisibleMemberMap { private final TypeElement typeElement; /** - * List of inherited members from the mapping class. + * List of members from the mapping class. */ - private Set members = new LinkedHashSet<>(); + private List members = null; /** * Level/Depth of inheritance. @@ -379,23 +367,23 @@ public class VisibleMemberMap { * Adjust member-level-map, class-map. */ private void addMembers(TypeElement fromClass) { - List classMembers = getClassMembers(fromClass, true); - List incllist = new ArrayList<>(); - for (Element element : classMembers) { - if (!found(members, element)) { - if (memberIsVisible(element)) { - if (!isOverridden(element, level)) { - if (!utils.isHidden(element)) { - incllist.add(element); - } + List result = new ArrayList<>(); + for (Element element : getClassMembers(fromClass, true)) { + if (memberIsVisible(element)) { + if (!isOverridden(element, level)) { + if (!utils.isHidden(element)) { + result.add(element); } } } } - if (!incllist.isEmpty()) { + if (members != null) { + throw new AssertionError("members should not be null"); + } + members = Collections.unmodifiableList(result); + if (!members.isEmpty()) { noVisibleMembers = false; } - members.addAll(incllist); fillMemberLevelMap(getClassMembers(fromClass, false), level); } @@ -513,16 +501,6 @@ public class VisibleMemberMap { return targetMembers; } - private boolean found(Iterable list, Element elem) { - for (Element pgmelem : list) { - if (utils.matches(pgmelem, elem)) { - return true; - } - } - return false; - } - - /** * Is member overridden? The member is overridden if it is found in the * same level hierarchy e.g. member at level "11" overrides member at diff --git a/langtools/test/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java b/langtools/test/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java index cc8af164a63..bb9c951876b 100644 --- a/langtools/test/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java +++ b/langtools/test/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java @@ -23,7 +23,7 @@ /* * @test - * @bug 7112427 8012295 8025633 8026567 8061305 8081854 8150130 8162363 + * @bug 7112427 8012295 8025633 8026567 8061305 8081854 8150130 8162363 8167967 * @summary Test of the JavaFX doclet features. * @author jvalenta * @library ../lib @@ -163,10 +163,7 @@ public class TestJavaFX extends JavadocTester { "pkg2"); checkExit(Exit.OK); checkOutput("pkg2/Test.html", true, - "
  • \n" - + "\n" - + "\n" - + "

    Property Detail

    \n" + "

    Property Detail

    \n" + "\n" + "\n" + "\n" @@ -176,27 +173,27 @@ public class TestJavaFX extends JavadocTester { + "
    public java.lang.Object betaProperty
    \n" + "
  • \n" + "\n" - + "\n" + + "\n" + "\n" + "\n" + "
      \n" + "
    • \n" + + "

      gamma

      \n" + + "
      public final java.util.List<java.lang.String> gammaProperty
      \n" + + "
    • \n" + + "
    \n" + + "\n" + + "\n" + + "\n" + + "
      \n" + + "
    • \n" + "

      delta

      \n" + "
      public final java.util.List<"
                       + "java.util.Set<? super java.lang.Object>> deltaProperty
      \n" + "
    • \n" + "
    \n" - + "\n" - + "\n" - + "\n" - + "
      \n" - + "
    • \n" - + "

      gamma

      \n" - + "
      public final java.util.List<"
      -                + "java.lang.String> gammaProperty
      \n" + "
    • \n" - + "
    \n" - + ""); + + ""); } /* diff --git a/langtools/test/jdk/javadoc/doclet/testOrdering/TestOrdering.java b/langtools/test/jdk/javadoc/doclet/testOrdering/TestOrdering.java index 9ffac254c93..19626d84d10 100644 --- a/langtools/test/jdk/javadoc/doclet/testOrdering/TestOrdering.java +++ b/langtools/test/jdk/javadoc/doclet/testOrdering/TestOrdering.java @@ -23,9 +23,8 @@ /* * @test - * @bug 8039410 8042601 8042829 8049393 8050031 8155061 8155995 + * @bug 8039410 8042601 8042829 8049393 8050031 8155061 8155995 8167967 * @summary test to determine if members are ordered correctly - * @author ksrini * @library ../lib/ * @modules jdk.javadoc/jdk.javadoc.internal.tool * @build JavadocTester @@ -51,492 +50,640 @@ public class TestOrdering extends JavadocTester { @Test void testUnnamedPackagesForClassUse() { - javadoc("-d", "out", - "-sourcepath", testSrc, - "-use", - testSrc("C.java"), testSrc("UsedInC.java")); - checkExit(Exit.OK); - checkExecutableMemberOrdering("class-use/UsedInC.html"); + new UnnamedPackageForClassUseTest(this).run(); } @Test void testNamedPackagesForClassUse() { - javadoc("-d", "out-1", - "-sourcepath", testSrc, - "-use", - "pkg1"); - checkExit(Exit.OK); - checkClassUseOrdering("pkg1/class-use/UsedClass.html"); - checkOrder("pkg1/class-use/UsedClass.html", expectedClassUseMethodOrdering); - checkOrder("pkg1/class-use/UsedClass.html", expectedClassUseWithTypeParams); - checkOrder("pkg1/class-use/UsedClass.html", expectedInnerClassContructors); - checkOrder("pkg1/ImplementsOrdering.html", expectedImplementsOrdering); - checkOrder("pkg1/OverrideOrdering.html", expectedOverrideOrdering); - checkOrder("allclasses-noframe.html", expectedAllClasses); - checkOrder("allclasses-frame.html", expectedAllClasses); + new NamedPackagesForClassUseTest(this).run(); } - enum ListOrder { NONE, REVERSE, SHUFFLE }; - /* - * By default we do not shuffle the input list, in order to keep the list deterministic, - * and the test predictable. However, we can turn on the stress mode, by setting the following - * property if required. - */ - static final ListOrder STRESS_MODE = Boolean.getBoolean("TestOrder.STRESS") - ? ListOrder.SHUFFLE - : ListOrder.REVERSE; - - /* - * Controls the number of sibling packages, pkg0, pkg1, pkg2, ..... - */ - static final int MAX_PACKAGES = 4; - - /* - * Controls the number of children packages, pkg0, pkg0.pkg, pkg0.pkg.pkg, ..... - * Note: having too long a depth (> 256 chars on Windows), will likely lead to - * cause problems with automated build and test systems. - */ - static final int MAX_SUBPACKAGES_DEPTH = 4; @Test void testIndexOrdering() throws IOException { - final String clsname = "Add"; - List cmdArgs = new ArrayList(); - cmdArgs.add("-d"); - cmdArgs.add("out-2"); - cmdArgs.add("-sourcepath"); - cmdArgs.add("src"); - cmdArgs.add("-package"); - System.out.println("STRESS_MODE: " + STRESS_MODE); - emitFile(null, clsname, STRESS_MODE); - for (int width = 0 ; width < MAX_PACKAGES ; width++) { - String wpkgname = "add" + width; - String dpkgname = wpkgname; - emitFile(wpkgname, clsname, ListOrder.NONE); // list as-is - cmdArgs.add(wpkgname); - for (int depth = 1 ; depth < MAX_SUBPACKAGES_DEPTH ; depth++) { - dpkgname = dpkgname + ".add"; - emitFile(dpkgname, clsname, STRESS_MODE); - cmdArgs.add(dpkgname); - } - } - File srcDir = new File(new File("."), "src"); - cmdArgs.add(new File(srcDir, clsname + ".java").getPath()); - javadoc(cmdArgs.toArray(new String[cmdArgs.size()])); - checkExit(Exit.OK); - checkOrder("index-all.html", composeTestVectors()); - checkOrder("add0/add/package-tree.html", expectedPackageTreeOrdering); - checkOrder("overview-tree.html", expectedOverviewOrdering); - checkOrder("overview-frame.html", expectedOverviewFrameOrdering); + new IndexOrderingTest(this).run(); } @Test void testIndexTypeClustering() { - javadoc("-d", "out-3", - "-sourcepath", testSrc("src-2"), - "-use", - "a", - "b", - "e", - "something"); - checkOrder("index-all.html", typeTestVectors); - checkExit(Exit.OK); + new IndexTypeClusteringTest(this).run(); } @Test - void testMethodDetailOrdering() { - javadoc("-d", "out-4", - "-sourcepath", testSrc(new File(".").getPath()), - "order" - ); - checkOrder("order/MethodOrder.html", methodSourceOrderVectors); - checkExit(Exit.OK); + void testTypeElementMemberOrdering() { + new TypeElementMemberOrderingTest(this).run(); } - String[] methodSourceOrderVectors = { - "
    public void d()
    \n" + - "
    Method d.\n" + - " Second line.
    ", - "
    public void b()
    \n" + - "
    Method b.\n" + - " Second line.
    ", - "
    public void c()
    \n" + - "
    Method c.\n" + - " Second line.
    ", - "
    public void a()
    \n" + - "
    Method a.\n" + - " Second line.
    " - }; + static class UnnamedPackageForClassUseTest { + final JavadocTester tester; - String[] typeTestVectors = { - "something - package something", - "something - Class in", - "something - Enum in", - "something - Interface in", - "something - Annotation Type in", - "something - Variable in class", - "something() - Constructor", - "something() - Method in class a. - Method in class a. - Method in class something. testList = new ArrayList<>(); - - testList.addAll(Arrays.asList(expectedPackageOrdering)); - for (String x : expectedEnumOrdering) { - testList.add(x.replace("REPLACE_ME", "<Unnamed>")); - for (int i = 0; i < MAX_PACKAGES; i++) { - String wpkg = "add" + i; - testList.add(wpkg + "/" + x.replace("REPLACE_ME", - wpkg)); - String dpkg = wpkg; - for (int j = 1; j < MAX_SUBPACKAGES_DEPTH; j++) { - dpkg = dpkg + "/" + "add"; - testList.add(dpkg + "/" + x.replace("REPLACE_ME", - pathToPackage(dpkg))); - } - } + UnnamedPackageForClassUseTest(JavadocTester tester) { + this.tester = tester; } - testList.addAll(Arrays.asList(expectedFieldOrdering)); - - for (String x : expectedMethodOrdering) { - testList.add(x); - for (int i = 0; i < MAX_PACKAGES; i++) { - String wpkg = "add" + i; - testList.add(wpkg + "/" + x); - String dpkg = wpkg; - for (int j = 1; j < MAX_SUBPACKAGES_DEPTH; j++) { - dpkg = dpkg + "/" + "add"; - testList.add(dpkg + "/" + x); - } - } + void run() { + tester.javadoc("-d", "out", + "-sourcepath", testSrc, + "-use", + tester.testSrc("C.java"), tester.testSrc("UsedInC.java")); + tester.checkExit(Exit.OK); + checkExecutableMemberOrdering("class-use/UsedInC.html"); } - return testList.toArray(new String[testList.size()]); - } - - void checkExecutableMemberOrdering(String usePage) { - String contents = readFile(usePage); - // check constructors - checking("constructors"); - int idx1 = contents.indexOf("C.html#C-UsedInC"); - int idx2 = contents.indexOf("C.html#C-UsedInC-int"); - int idx3 = contents.indexOf("C.html#C-UsedInC-java.lang.String"); - if (idx1 == -1 || idx2 == -1 || idx3 == -1) { - failed("ctor strings not found"); - } else if (idx1 > idx2 || idx2 > idx3 || idx1 > idx3) { - failed("ctor strings are out of order"); - } else - passed("ctor strings are in order"); - - // check methods - checking("methods"); - idx1 = contents.indexOf("C.html#ymethod-int"); - idx2 = contents.indexOf("C.html#ymethod-java.lang.String"); - if (idx1 == -1 || idx2 == -1) { - failed("#ymethod strings not found"); - } else if (idx1 > idx2) { - failed("#ymethod strings are out of order"); - } else - passed("Executable Member Ordering: OK"); - } - - void checkClassUseOrdering(String usePage) { - checkClassUseOrdering(usePage, "pkg1/C#ITERATION#.html#zfield"); - checkClassUseOrdering(usePage, "pkg1/C#ITERATION#.html#fieldInC#ITERATION#"); - checkClassUseOrdering(usePage, "pkg1/C#ITERATION#.html#zmethod-pkg1.UsedClass"); - checkClassUseOrdering(usePage, "pkg1/C#ITERATION#.html#methodInC#ITERATION#"); - } - - void checkClassUseOrdering(String usePage, String searchString) { - String contents = readFile(usePage); - int lastidx = 0; - System.out.println("testing for " + searchString); - for (int i = 1; i < 5; i++) { - String s = searchString.replaceAll("#ITERATION#", Integer.toString(i)); - checking(s); - int idx = contents.indexOf(s); - if (idx < lastidx) { - failed(s + ", member ordering error, last:" + lastidx + ", got:" + idx); + void checkExecutableMemberOrdering(String usePage) { + String contents = tester.readFile(usePage); + // check constructors + tester.checking("constructors"); + int idx1 = contents.indexOf("C.html#C-UsedInC"); + int idx2 = contents.indexOf("C.html#C-UsedInC-int"); + int idx3 = contents.indexOf("C.html#C-UsedInC-java.lang.String"); + if (idx1 == -1 || idx2 == -1 || idx3 == -1) { + tester.failed("ctor strings not found"); + } else if (idx1 > idx2 || idx2 > idx3 || idx1 > idx3) { + tester.failed("ctor strings are out of order"); } else { - passed("\tlast: " + lastidx + " got:" + idx); + tester.passed("ctor strings are in order"); + } + + // check methods + tester.checking("methods"); + idx1 = contents.indexOf("C.html#ymethod-int"); + idx2 = contents.indexOf("C.html#ymethod-java.lang.String"); + if (idx1 == -1 || idx2 == -1) { + tester.failed("#ymethod strings not found"); + } else if (idx1 > idx2) { + tester.failed("#ymethod strings are out of order"); + } else { + tester.passed("Executable Member Ordering: OK"); } - lastidx = idx; } } - static String[] contents = { - "public add ADDADD;", - "public add AddAdd;", - "public add addadd;", - "public enum add {add, ADD, addd, ADDD};", - "public enum ADD {ADD, add, addd, ADDD};", - "public void add(){}", - "public void add(double d){}", - "public void add(int i, float f){}", - "public void add(float f, int i){}", - "public void add(double d, byte b){}", - "public Double add(Double d) {return (double) 22/7;}", - "public double add(double d1, double d2) {return d1 + d2;}", - "public double add(double d1, Double d2) {return d1 + d2;}", - "public Float add(float f) {return (float) 22/7;}", - "public void add(int i){}", - "public int add(Integer i) {return 0;}" - }; + static class NamedPackagesForClassUseTest { + final JavadocTester tester; - void emitFile(String pkgname, String clsname, ListOrder order) throws IOException { - File srcDir = new File("src"); - File outDir = pkgname == null - ? srcDir - : new File(srcDir, pkgname.replace(".", File.separator)); - File outFile = new File(outDir, clsname + ".java"); - outDir.mkdirs(); - List scratch = new ArrayList<>(Arrays.asList(contents)); - switch (order) { - case SHUFFLE: - Collections.shuffle(scratch); - break; - case REVERSE: - Collections.reverse(scratch); - break; - default: + NamedPackagesForClassUseTest(JavadocTester tester) { + this.tester = tester; + } + + public void run() { + tester.javadoc("-d", "out-1", + "-sourcepath", tester.testSrc, + "-use", + "pkg1"); + tester.checkExit(Exit.OK); + + checkClassUseOrdering("pkg1/class-use/UsedClass.html"); + + tester.checkOrder("pkg1/class-use/UsedClass.html", + "../../pkg1/MethodOrder.html#m--", + "../../pkg1/MethodOrder.html#m-byte:A-", + "../../pkg1/MethodOrder.html#m-double-", + "../../pkg1/MethodOrder.html#m-double-double-", + "../../pkg1/MethodOrder.html#m-double-java.lang.Double-", + "../../pkg1/MethodOrder.html#m-int-", + "../../pkg1/MethodOrder.html#m-int-int-", + "../../pkg1/MethodOrder.html#m-int-java.lang.Integer-", + "../../pkg1/MethodOrder.html#m-long-", + "../../pkg1/MethodOrder.html#m-long-long-", + "../../pkg1/MethodOrder.html#m-long-java.lang.Long-", + "../../pkg1/MethodOrder.html#m-long-java.lang.Long...-", + "../../pkg1/MethodOrder.html#m-java.lang.Double-", + "../../pkg1/MethodOrder.html#m-java.lang.Double-double-", + "../../pkg1/MethodOrder.html#m-java.lang.Double-java.lang.Double-", + "../../pkg1/MethodOrder.html#m-java.lang.Integer-", + "../../pkg1/MethodOrder.html#m-java.lang.Integer-int-", + "../../pkg1/MethodOrder.html#m-java.lang.Integer-java.lang.Integer-", + "../../pkg1/MethodOrder.html#m-java.lang.Object:A-", + "../../pkg1/MethodOrder.html#m-java.util.ArrayList-", + "../../pkg1/MethodOrder.html#m-java.util.Collection-", + "../../pkg1/MethodOrder.html#m-java.util.List-"); + + tester.checkOrder("pkg1/class-use/UsedClass.html", + "../../pkg1/MethodOrder.html#tpm-pkg1.UsedClass-", + "../../pkg1/MethodOrder.html#tpm-pkg1.UsedClass-pkg1.UsedClass-", + "../../pkg1/MethodOrder.html#tpm-pkg1.UsedClass-pkg1.UsedClass:A-", + "../../pkg1/MethodOrder.html#tpm-pkg1.UsedClass-java.lang.String-"); + + tester.checkOrder("pkg1/class-use/UsedClass.html", + "../../pkg1/A.html#A-pkg1.UsedClass-", + "../../pkg1/B.A.html#A-pkg1.UsedClass-", + "../../pkg1/B.html#B-pkg1.UsedClass-", + "../../pkg1/A.C.html#C-pkg1.UsedClass-java.lang.Object:A-", + "../../pkg1/A.C.html#C-pkg1.UsedClass-java.util.Collection-", + "../../pkg1/A.C.html#C-pkg1.UsedClass-java.util.List-"); + + tester.checkOrder("pkg1/ImplementsOrdering.html", + "
    close in interface java.lang.AutoCloseable
    ", + "
    close in interface java.nio.channels.Channel
    ", + "
    close in interface java.io.Closeable
    "); + + tester.checkOrder("pkg1/OverrideOrdering.html", + "
    iterator in interface java.util.Collection<", + "
    iterator in interface java.lang.Iterable<"); + + tester.checkOrder("allclasses-noframe.html", + "pkg1/A.html\" title=\"class in pkg1", + "pkg1/A.C.html\" title=\"class in pkg1", + "pkg1/B.html\" title=\"class in pkg1", + "pkg1/B.A.html\" title=\"class in pkg1", + "pkg1/C1.html\" title=\"class in pkg1", + "pkg1/C2.html\" title=\"class in pkg1", + "pkg1/C3.html\" title=\"class in pkg1", + "pkg1/C4.html\" title=\"class in pkg1", + "pkg1/ImplementsOrdering.html\" title=\"interface in pkg1", + "pkg1/MethodOrder.html\" title=\"class in pkg1", + "pkg1/OverrideOrdering.html\" title=\"class in pkg1", + "pkg1/UsedClass.html\" title=\"class in pkg1"); + + tester.checkOrder("allclasses-frame.html", + "pkg1/A.html\" title=\"class in pkg1", + "pkg1/A.C.html\" title=\"class in pkg1", + "pkg1/B.html\" title=\"class in pkg1", + "pkg1/B.A.html\" title=\"class in pkg1", + "pkg1/C1.html\" title=\"class in pkg1", + "pkg1/C2.html\" title=\"class in pkg1", + "pkg1/C3.html\" title=\"class in pkg1", + "pkg1/C4.html\" title=\"class in pkg1", + "pkg1/ImplementsOrdering.html\" title=\"interface in pkg1", + "pkg1/MethodOrder.html\" title=\"class in pkg1", + "pkg1/OverrideOrdering.html\" title=\"class in pkg1", + "pkg1/UsedClass.html\" title=\"class in pkg1"); + } + + void checkClassUseOrdering(String usePage) { + checkClassUseOrdering(usePage, "pkg1/C#ITERATION#.html#zfield"); + checkClassUseOrdering(usePage, "pkg1/C#ITERATION#.html#fieldInC#ITERATION#"); + checkClassUseOrdering(usePage, "pkg1/C#ITERATION#.html#zmethod-pkg1.UsedClass"); + checkClassUseOrdering(usePage, "pkg1/C#ITERATION#.html#methodInC#ITERATION#"); + } + + void checkClassUseOrdering(String usePage, String searchString) { + String contents = tester.readFile(usePage); + int lastidx = 0; + System.out.println("testing for " + searchString); + for (int i = 1; i < 5; i++) { + String s = searchString.replaceAll("#ITERATION#", Integer.toString(i)); + tester.checking(s); + int idx = contents.indexOf(s); + if (idx < lastidx) { + tester.failed(s + ", member ordering error, last:" + lastidx + ", got:" + idx); + } else { + tester.passed("\tlast: " + lastidx + " got:" + idx); + } + lastidx = idx; + } + } + } + + static class IndexOrderingTest { + private final JavadocTester tester; + + IndexOrderingTest(JavadocTester tester) { + this.tester = tester; + } + + enum ListOrder { + NONE, REVERSE, SHUFFLE + }; + + /* + * By default we do not shuffle the input list, in order to keep the list deterministic, + * and the test predictable. However, we can turn on the stress mode, by setting the following + * property if required. + */ + static final ListOrder STRESS_MODE = Boolean.getBoolean("TestOrder.STRESS") + ? ListOrder.SHUFFLE + : ListOrder.REVERSE; + + /* + * Controls the number of children packages, pkg0, pkg0.pkg, pkg0.pkg.pkg, ..... + * Note: having too long a depth (> 256 chars on Windows), will likely lead to + * cause problems with automated build and test systems. + */ + static final int MAX_SUBPACKAGES_DEPTH = 4; + + /* + * Controls the number of sibling packages, pkg0, pkg1, pkg2, ..... + */ + static final int MAX_PACKAGES = 4; + + static String[] contents = { + "public add ADDADD;", + "public add AddAdd;", + "public add addadd;", + "public enum add {add, ADD, addd, ADDD};", + "public enum ADD {ADD, add, addd, ADDD};", + "public void add(){}", + "public void add(double d){}", + "public void add(int i, float f){}", + "public void add(float f, int i){}", + "public void add(double d, byte b){}", + "public Double add(Double d) {return (double) 22/7;}", + "public double add(double d1, double d2) {return d1 + d2;}", + "public double add(double d1, Double d2) {return d1 + d2;}", + "public Float add(float f) {return (float) 22/7;}", + "public void add(int i){}", + "public int add(Integer i) {return 0;}" + }; + + static String expectedEnumOrdering[] = { + "Add.add.html\" title=\"enum in REPLACE_ME\"", + "Add.ADD.html\" title=\"enum in REPLACE_ME\"" + }; + + static String expectedFieldOrdering[] = { + "Add.html#addadd\"", + "add0/add/add/add/Add.html#addadd\"", + "add0/add/add/Add.html#addadd\"", + "add0/add/Add.html#addadd\"", + "add0/Add.html#addadd\"", + "add1/add/add/add/Add.html#addadd\"", + "add1/add/add/Add.html#addadd\"", + "add1/add/Add.html#addadd\"", + "add1/Add.html#addadd\"", + "add2/add/add/add/Add.html#addadd\"", + "add2/add/add/Add.html#addadd\"", + "add2/add/Add.html#addadd\"", + "add2/Add.html#addadd\"", + "add3/add/add/add/Add.html#addadd\"", + "add3/add/add/Add.html#addadd\"", + "add3/add/Add.html#addadd\"", + "add3/Add.html#addadd\"", + "Add.html#AddAdd\"", + "add0/add/add/add/Add.html#AddAdd\"", + "add0/add/add/Add.html#AddAdd\"", + "add0/add/Add.html#AddAdd\"", + "add0/Add.html#AddAdd\"", + "add1/add/add/add/Add.html#AddAdd\"", + "add1/add/add/Add.html#AddAdd\"", + "add1/add/Add.html#AddAdd\"", + "add1/Add.html#AddAdd\"", + "add2/add/add/add/Add.html#AddAdd\"", + "add2/add/add/Add.html#AddAdd\"", + "add2/add/Add.html#AddAdd\"", + "add2/Add.html#AddAdd\"", + "add3/add/add/add/Add.html#AddAdd\"", + "add3/add/add/Add.html#AddAdd\"", + "add3/add/Add.html#AddAdd\"", + "add3/Add.html#AddAdd\"", + "Add.html#ADDADD\"", + "add0/add/add/add/Add.html#ADDADD\"", + "add0/add/add/Add.html#ADDADD\"", + "add0/add/Add.html#ADDADD\"", + "add0/Add.html#ADDADD\"", + "add1/add/add/add/Add.html#ADDADD\"", + "add1/add/add/Add.html#ADDADD\"", + "add1/add/Add.html#ADDADD\"", + "add1/Add.html#ADDADD\"", + "add2/add/add/add/Add.html#ADDADD\"", + "add2/add/add/Add.html#ADDADD\"", + "add2/add/Add.html#ADDADD\"", + "add2/Add.html#ADDADD\"", + "add3/add/add/add/Add.html#ADDADD\"", + "add3/add/add/Add.html#ADDADD\"", + "add3/add/Add.html#ADDADD\"", + "add3/Add.html#ADDADD\"" + }; + + static String expectedMethodOrdering[] = { + "Add.html#add--", + "Add.html#add-double-", + "Add.html#add-double-byte-", + "Add.html#add-double-double-", + "Add.html#add-double-java.lang.Double-", + "Add.html#add-float-", + "Add.html#add-float-int-", + "Add.html#add-int-", + "Add.html#add-int-float-", + "Add.html#add-java.lang.Double-", + "Add.html#add-java.lang.Integer-" + }; + + static String expectedPackageOrdering[] = { + "\"add0/package-summary.html\">add0 - package add0", + "\"add0/add/package-summary.html\">add0.add - package add0.add", + "\"add0/add/add/package-summary.html\">add0.add.add - package add0.add.add", + "\"add0/add/add/add/package-summary.html\">add0.add.add.add - package add0.add.add.add", + "\"add1/package-summary.html\">add1 - package add1", + "\"add1/add/package-summary.html\">add1.add - package add1.add", + "\"add1/add/add/package-summary.html\">add1.add.add - package add1.add.add", + "\"add1/add/add/add/package-summary.html\">add1.add.add.add - package add1.add.add.add", + "\"add2/package-summary.html\">add2 - package add2", + "\"add2/add/package-summary.html\">add2.add - package add2.add", + "\"add2/add/add/package-summary.html\">add2.add.add - package add2.add.add", + "\"add2/add/add/add/package-summary.html\">add2.add.add.add - package add2.add.add.add", + "\"add3/package-summary.html\">add3 - package add3", + "\"add3/add/package-summary.html\">add3.add - package add3.add", + "\"add3/add/add/package-summary.html\">add3.add.add - package add3.add.add", + "\"add3/add/add/add/package-summary.html\">add3.add.add.add - package add3.add.add.add" + }; + + void run() throws IOException { + final String clsname = "Add"; + List cmdArgs = new ArrayList(); + cmdArgs.add("-d"); + cmdArgs.add("out-2"); + cmdArgs.add("-sourcepath"); + cmdArgs.add("src"); + cmdArgs.add("-package"); + System.out.println("STRESS_MODE: " + STRESS_MODE); + emitFile(null, clsname, STRESS_MODE); + for (int width = 0; width < MAX_PACKAGES; width++) { + String wpkgname = "add" + width; + String dpkgname = wpkgname; + emitFile(wpkgname, clsname, ListOrder.NONE); // list as-is + cmdArgs.add(wpkgname); + for (int depth = 1; depth < MAX_SUBPACKAGES_DEPTH; depth++) { + dpkgname = dpkgname + ".add"; + emitFile(dpkgname, clsname, STRESS_MODE); + cmdArgs.add(dpkgname); + } + } + File srcDir = new File(new File("."), "src"); + cmdArgs.add(new File(srcDir, clsname + ".java").getPath()); + tester.javadoc(cmdArgs.toArray(new String[cmdArgs.size()])); + tester.checkExit(Exit.OK); + tester.checkOrder("index-all.html", composeTestVectors()); + tester.checkOrder("add0/add/package-tree.html", + "", + ""); + tester.checkOrder("overview-tree.html", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + ""); + + tester.checkOrder("overview-frame.html", + "<unnamed package>", + "add0", + "add0.add", + "add0.add.add", + "add0.add.add.add", + "add1", + "add1.add", + "add1.add.add", + "add1.add.add.add", + "add2", + "add2.add", + "add2.add.add", + "add2.add.add.add", + "add3", + "add3.add", + "add3.add.add", + "add3.add.add.add"); + } + + void emitFile(String pkgname, String clsname, ListOrder order) throws IOException { + File srcDir = new File("src"); + File outDir = pkgname == null + ? srcDir + : new File(srcDir, pkgname.replace(".", File.separator)); + File outFile = new File(outDir, clsname + ".java"); + outDir.mkdirs(); + List scratch = new ArrayList<>(Arrays.asList(contents)); + switch (order) { + case SHUFFLE: + Collections.shuffle(scratch); + break; + case REVERSE: + Collections.reverse(scratch); + break; + default: // leave list as-is + } + // insert the header + scratch.add(0, "public class " + clsname + " {"); + if (pkgname != null) { + scratch.add(0, "package " + pkgname + ";"); + } + // append the footer + scratch.add("}"); + Files.write(outFile.toPath(), scratch, CREATE, TRUNCATE_EXISTING); } - // insert the header - scratch.add(0, "public class " + clsname + " {"); - if (pkgname != null) { - scratch.add(0, "package " + pkgname + ";"); + + String[] composeTestVectors() { + List testList = new ArrayList<>(); + + testList.addAll(Arrays.asList(expectedPackageOrdering)); + for (String x : expectedEnumOrdering) { + testList.add(x.replace("REPLACE_ME", "<Unnamed>")); + for (int i = 0; i < MAX_PACKAGES; i++) { + String wpkg = "add" + i; + testList.add(wpkg + "/" + x.replace("REPLACE_ME", + wpkg)); + String dpkg = wpkg; + for (int j = 1; j < MAX_SUBPACKAGES_DEPTH; j++) { + dpkg = dpkg + "/" + "add"; + testList.add(dpkg + "/" + x.replace("REPLACE_ME", pathToPackage(dpkg))); + } + } + } + + testList.addAll(Arrays.asList(expectedFieldOrdering)); + + for (String x : expectedMethodOrdering) { + testList.add(x); + for (int i = 0; i < MAX_PACKAGES; i++) { + String wpkg = "add" + i; + testList.add(wpkg + "/" + x); + String dpkg = wpkg; + for (int j = 1; j < MAX_SUBPACKAGES_DEPTH; j++) { + dpkg = dpkg + "/" + "add"; + testList.add(dpkg + "/" + x); + } + } + } + + return testList.toArray(new String[testList.size()]); + } + + String pathToPackage(String in) { + return in.replace("/", "."); } - // append the footer - scratch.add("}"); - Files.write(outFile.toPath(), scratch, CREATE, TRUNCATE_EXISTING); } - String pathToPackage(String in) { - return in.replace("/", "."); + static class IndexTypeClusteringTest { + + private final JavadocTester tester; + + IndexTypeClusteringTest(JavadocTester tester) { + this.tester = tester; + } + + void run() { + tester.javadoc("-d", "out-3", + "-sourcepath", tester.testSrc("src-2"), + "-use", + "a", + "b", + "e", + "something"); + + tester.checkExit(Exit.OK); + + tester.checkOrder("index-all.html", + "something - package something", + "something - Class in", + "something - Enum in", + "something - Interface in", + "something - Annotation Type in", + "something - Variable in class", + "something() - Constructor", + "something() - Method in class a. - Method in class a. - Method in class something.add0 - package add0", - "\"add0/add/package-summary.html\">add0.add - package add0.add", - "\"add0/add/add/package-summary.html\">add0.add.add - package add0.add.add", - "\"add0/add/add/add/package-summary.html\">add0.add.add.add - package add0.add.add.add", - "\"add1/package-summary.html\">add1 - package add1", - "\"add1/add/package-summary.html\">add1.add - package add1.add", - "\"add1/add/add/package-summary.html\">add1.add.add - package add1.add.add", - "\"add1/add/add/add/package-summary.html\">add1.add.add.add - package add1.add.add.add", - "\"add2/package-summary.html\">add2 - package add2", - "\"add2/add/package-summary.html\">add2.add - package add2.add", - "\"add2/add/add/package-summary.html\">add2.add.add - package add2.add.add", - "\"add2/add/add/add/package-summary.html\">add2.add.add.add - package add2.add.add.add", - "\"add3/package-summary.html\">add3 - package add3", - "\"add3/add/package-summary.html\">add3.add - package add3.add", - "\"add3/add/add/package-summary.html\">add3.add.add - package add3.add.add", - "\"add3/add/add/add/package-summary.html\">add3.add.add.add - package add3.add.add.add" - }; + tester.checkOrder("pkg5/AnnoFieldTest.html", + "

    Field Detail

    ", + "
    static final int one
    ", + "
    static final int two
    ", + "
    static final int three
    ", + "
    static final int four
    "); - final String expectedMethodOrdering[] = { - "Add.html#add--", - "Add.html#add-double-", - "Add.html#add-double-byte-", - "Add.html#add-double-double-", - "Add.html#add-double-java.lang.Double-", - "Add.html#add-float-", - "Add.html#add-float-int-", - "Add.html#add-int-", - "Add.html#add-int-float-", - "Add.html#add-java.lang.Double-", - "Add.html#add-java.lang.Integer-" - }; + tester.checkOrder("pkg5/AnnoOptionalTest.html", + "

    Optional Element Summary

    ", + "four", + "one", + "three", + "two", + "

    Element Detail

    ", + "

    one

    ", + "

    two

    ", + "

    three

    ", + "

    four

    "); - final String expectedEnumOrdering[] = { - "Add.add.html\" title=\"enum in REPLACE_ME\"", - "Add.ADD.html\" title=\"enum in REPLACE_ME\"" - }; + tester.checkOrder("pkg5/AnnoRequiredTest.html", + "

    Required Element Summary

    ", + "four", + "one", + "three", + "two", + "

    Element Detail

    ", + "

    one

    ", + "

    two

    ", + "

    three

    ", + "

    four

    "); - final String expectedFieldOrdering[] = { - "Add.html#addadd\"", - "add0/add/add/add/Add.html#addadd\"", - "add0/add/add/Add.html#addadd\"", - "add0/add/Add.html#addadd\"", - "add0/Add.html#addadd\"", - "add1/add/add/add/Add.html#addadd\"", - "add1/add/add/Add.html#addadd\"", - "add1/add/Add.html#addadd\"", - "add1/Add.html#addadd\"", - "add2/add/add/add/Add.html#addadd\"", - "add2/add/add/Add.html#addadd\"", - "add2/add/Add.html#addadd\"", - "add2/Add.html#addadd\"", - "add3/add/add/add/Add.html#addadd\"", - "add3/add/add/Add.html#addadd\"", - "add3/add/Add.html#addadd\"", - "add3/Add.html#addadd\"", - "Add.html#AddAdd\"", - "add0/add/add/add/Add.html#AddAdd\"", - "add0/add/add/Add.html#AddAdd\"", - "add0/add/Add.html#AddAdd\"", - "add0/Add.html#AddAdd\"", - "add1/add/add/add/Add.html#AddAdd\"", - "add1/add/add/Add.html#AddAdd\"", - "add1/add/Add.html#AddAdd\"", - "add1/Add.html#AddAdd\"", - "add2/add/add/add/Add.html#AddAdd\"", - "add2/add/add/Add.html#AddAdd\"", - "add2/add/Add.html#AddAdd\"", - "add2/Add.html#AddAdd\"", - "add3/add/add/add/Add.html#AddAdd\"", - "add3/add/add/Add.html#AddAdd\"", - "add3/add/Add.html#AddAdd\"", - "add3/Add.html#AddAdd\"", - "Add.html#ADDADD\"", - "add0/add/add/add/Add.html#ADDADD\"", - "add0/add/add/Add.html#ADDADD\"", - "add0/add/Add.html#ADDADD\"", - "add0/Add.html#ADDADD\"", - "add1/add/add/add/Add.html#ADDADD\"", - "add1/add/add/Add.html#ADDADD\"", - "add1/add/Add.html#ADDADD\"", - "add1/Add.html#ADDADD\"", - "add2/add/add/add/Add.html#ADDADD\"", - "add2/add/add/Add.html#ADDADD\"", - "add2/add/Add.html#ADDADD\"", - "add2/Add.html#ADDADD\"", - "add3/add/add/add/Add.html#ADDADD\"", - "add3/add/add/Add.html#ADDADD\"", - "add3/add/Add.html#ADDADD\"", - "add3/Add.html#ADDADD\"" - }; + tester.checkOrder("pkg5/CtorTest.html", + "

    Constructor Summary

    ", + "Constructor Detail", + "", + "", + "", + ""); - final String expectedPackageTreeOrdering[] = { - "", - "" - }; + tester.checkOrder("pkg5/EnumTest.html", + "

    Enum Constant Summary

    ", + "
    FOUR", + "ONE", + "THREE", + "TWO", + "

    Enum Constant Detail

    ", + "

    ONE

    ", + "

    TWO

    ", + "

    THREE

    ", + "

    FOUR

    "); - final String expectedOverviewOrdering[] = { - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - }; + tester.checkOrder("pkg5/FieldTest.html", + "

    Field Summary

    ", + "
    four", + "one", + "three", + "two", + "

    Field Detail

    ", + "

    one

    ", + "

    two

    ", + "

    three

    ", + "

    four

    "); - final static String expectedOverviewFrameOrdering[] = { - "<unnamed package>", - "add0", - "add0.add", - "add0.add.add", - "add0.add.add.add", - "add1", - "add1.add", - "add1.add.add", - "add1.add.add.add", - "add2", - "add2.add", - "add2.add.add", - "add2.add.add.add", - "add3", - "add3.add", - "add3.add.add", - "add3.add.add.add" - }; + tester.checkOrder("pkg5/IntfTest.html", + "

    Method Summary

    ", + "four", + "one", + "three", + "two", + "

    Method Detail

    ", + "

    one

    ", + "

    two

    ", + "

    three

    ", + "

    four

    "); - final static String expectedImplementsOrdering[] = { - "
    close in interface java.lang.AutoCloseable
    ", - "
    close in interface java.nio.channels.Channel
    ", - "
    close in interface java.io.Closeable
    " - }; + tester.checkOrder("pkg5/MethodTest.html", + "

    Method Summary

    ", + "four", + "one", + "three", + "two", + "

    Method Detail

    ", + "

    one

    ", + "

    two

    ", + "

    three

    ", + "

    four

    "); - final static String expectedOverrideOrdering[] = { - "
    iterator in interface java.util.Collection<", - "
    iterator in interface java.lang.Iterable<" - }; + tester.checkOrder("pkg5/PropertyTest.html", + "

    Property Summary

    ", + "four", + "one", + "three", + "two", + "

    Property Detail

    ", + "

    oneProperty

    ", + "

    twoProperty

    ", + "

    threeProperty

    ", + "

    fourProperty

    "); + } + } } diff --git a/langtools/test/jdk/javadoc/doclet/testOrdering/order/MethodOrder.java b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/AnnoFieldTest.java similarity index 63% rename from langtools/test/jdk/javadoc/doclet/testOrdering/order/MethodOrder.java rename to langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/AnnoFieldTest.java index d04ceb07c4a..53c0617f3ec 100644 --- a/langtools/test/jdk/javadoc/doclet/testOrdering/order/MethodOrder.java +++ b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/AnnoFieldTest.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 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 @@ -21,32 +21,11 @@ * questions. */ -package order; +package pkg5; -/** - * This class ensures the method detail section contains the methods - * in the order as it appears in the source. - * @author kumasrin - */ -public class MethodOrder { - /** - * Method d. - * Second line. - */ - public void d(){} - /** - * Method b. - * Second line. - */ - public void b() {} - /** - * Method c. - * Second line. - */ - public void c() {} - /** - * Method a. - * Second line. - */ - public void a() {} +public @interface AnnoFieldTest { + public int one = 1; + public int two = 2; + public int three = 3; + public int four = 4; } diff --git a/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/AnnoOptionalTest.java b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/AnnoOptionalTest.java new file mode 100644 index 00000000000..aba053a0476 --- /dev/null +++ b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/AnnoOptionalTest.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 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. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * 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 pkg5; + +public @interface AnnoOptionalTest { + int one() default 1; + int two() default 2; + int three() default 3; + int four() default 4; +} diff --git a/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/AnnoRequiredTest.java b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/AnnoRequiredTest.java new file mode 100644 index 00000000000..f54a0e4af14 --- /dev/null +++ b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/AnnoRequiredTest.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 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. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * 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 pkg5; + +public @interface AnnoRequiredTest { + int one(); + int two(); + int three(); + int four(); +} diff --git a/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/CtorTest.java b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/CtorTest.java new file mode 100644 index 00000000000..60bd64a49e8 --- /dev/null +++ b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/CtorTest.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 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. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * 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 pkg5; + +public class CtorTest { + public CtorTest(int one, int two, int three, int four) {} + public CtorTest(int one, int two, int three) {} + public CtorTest(int one, int two) {} + public CtorTest(int one) {} +} diff --git a/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/EnumTest.java b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/EnumTest.java new file mode 100644 index 00000000000..ef1267f00a5 --- /dev/null +++ b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/EnumTest.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 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. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * 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 pkg5; + +public enum EnumTest { + ONE, + TWO, + THREE, + FOUR +} diff --git a/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/FieldTest.java b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/FieldTest.java new file mode 100644 index 00000000000..66f876e0a85 --- /dev/null +++ b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/FieldTest.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 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. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * 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 pkg5; + +public class FieldTest { + public int one; + public int two; + public int three; + public int four; +} diff --git a/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/IntfTest.java b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/IntfTest.java new file mode 100644 index 00000000000..959034ed16b --- /dev/null +++ b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/IntfTest.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 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. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * 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 pkg5; + +public interface IntfTest { + void one(); + void two(); + void three(); + void four(); +} diff --git a/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/MethodTest.java b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/MethodTest.java new file mode 100644 index 00000000000..9333b30c00d --- /dev/null +++ b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/MethodTest.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 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. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * 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 pkg5; + +public class MethodTest { + public void one(){} + public void two(){} + public void three(){} + public void four(){} +} diff --git a/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/PropertyTest.java b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/PropertyTest.java new file mode 100644 index 00000000000..b53752a1e1a --- /dev/null +++ b/langtools/test/jdk/javadoc/doclet/testOrdering/pkg5/PropertyTest.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 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. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * 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 pkg5; + +public class PropertyTest { + public int oneProperty() { return 1; } + public int twoProperty() { return 2; } + public int threeProperty() { return 3; } + public int fourProperty() { return 4; } +}