private static void addPackageDependency( Set<Edge> edgesToRender, PackageDoc source, PackageDoc target) { if (source != target && source.isIncluded() && target.isIncluded()) { edgesToRender.add( new Edge(EdgeType.DEPENDENCY, source, target)); } }
/** * Add the given class to the given map. * @param classdoc the ClassDoc to add to the catelog. * @param map the Map to add the ClassDoc to. */ private void addClass(ClassDoc classdoc, Map<String,Set<ClassDoc>> map) { PackageDoc pkg = classdoc.containingPackage(); if (pkg.isIncluded()) { //No need to catalog this class since it's package is //included on the command line return; } String key = Util.getPackageName(pkg); Set<ClassDoc> s = map.get(key); if (s == null) { packageSet.add(key); s = new HashSet<ClassDoc>(); } s.add(classdoc); map.put(key, s); }
/** * Add the given class to the given map. * @param classdoc the ClassDoc to add to the catelog. * @param map the Map to add the ClassDoc to. */ private void addClass(ClassDoc classdoc, Map<String,Set<ClassDoc>> map) { PackageDoc pkg = classdoc.containingPackage(); if (pkg.isIncluded() || (configuration.nodeprecated && Util.isDeprecated(pkg))) { //No need to catalog this class if it's package is //included on the command line or if -nodeprecated option is set // and the containing package is marked as deprecated. return; } String key = Util.getPackageName(pkg); Set<ClassDoc> s = map.get(key); if (s == null) { packageSet.add(key); s = new HashSet<ClassDoc>(); } s.add(classdoc); map.put(key, s); }
/** * Return all of the classes specified on the command-line that * belong to the given package. * @param packageDoc the package to return the classes for. */ public ClassDoc[] allClasses(PackageDoc pkgDoc) { return pkgDoc.isIncluded() ? pkgDoc.allClasses() : getArray(allClasses, Util.getPackageName(pkgDoc)); }
/** * Return all of the classes specified on the command-line that * belong to the given package. * @param pkgDoc the package to return the classes for. */ public ClassDoc[] allClasses(PackageDoc pkgDoc) { return pkgDoc.isIncluded() ? pkgDoc.allClasses() : getArray(allClasses, Util.getPackageName(pkgDoc)); }
/** * Return true if this class is included in the active set. * A ClassDoc is included iff either it is specified on the * commandline, or if it's containing package is specified * on the command line, or if it is a member class of an * included class. */ public boolean isIncluded() { if (isIncluded) { return true; } if (env.shouldDocument(tsym)) { // Class is nameable from top-level and // the class and all enclosing classes // pass the modifier filter. if (containingPackage().isIncluded()) { return isIncluded=true; } ClassDoc outer = containingClass(); if (outer != null && outer.isIncluded()) { return isIncluded=true; } } return false; }
/** * Get the tree link. * * @return a content tree for the tree link */ protected Content getNavLinkTree() { Content linkContent = classdoc.containingPackage().isIncluded() ? getHyperLink(DocPath.parent.resolve(DocPaths.PACKAGE_TREE), treeLabel) : getHyperLink(pathToRoot.resolve(DocPaths.OVERVIEW_TREE), treeLabel); Content li = HtmlTree.LI(linkContent); return li; } }
protected void navLinkTree() { navCellStart(); if( classdoc.containingPackage().isIncluded() ) { printHyperLink( "../package-tree.html", "", configuration.getText( "doclet.Tree" ), true, null ); } else { printHyperLink( relativePath + "overview-tree.html", "", configuration.getText( "doclet.Tree" ), true, null ); } navCellEnd(); } }
/** * Build the summary for the enums in this package. */ public void buildAnnotationTypeSummary() { String annotationtypeTableSummary = configuration.getText("doclet.Member_Table_Summary", configuration.getText("doclet.Annotation_Types_Summary"), configuration.getText("doclet.annotationtypes")); String[] annotationtypeTableHeader = new String[] { configuration.getText("doclet.AnnotationType"), configuration.getText("doclet.Description") }; ClassDoc[] annotationTypes = packageDoc.isIncluded() ? packageDoc.annotationTypes() : configuration.classDocCatalog.annotationTypes( Util.getPackageName(packageDoc)); if (annotationTypes.length > 0) { packageWriter.writeClassesSummary( annotationTypes, configuration.getText("doclet.Annotation_Types_Summary"), annotationtypeTableSummary, annotationtypeTableHeader); } }
/** * Build the summary for the interfaces in this package. */ public void buildInterfaceSummary() { String interfaceTableSummary = configuration.getText("doclet.Member_Table_Summary", configuration.getText("doclet.Interface_Summary"), configuration.getText("doclet.interfaces")); String[] interfaceTableHeader = new String[] { configuration.getText("doclet.Interface"), configuration.getText("doclet.Description") }; ClassDoc[] interfaces = packageDoc.isIncluded() ? packageDoc.interfaces() : configuration.classDocCatalog.interfaces( Util.getPackageName(packageDoc)); if (interfaces.length > 0) { packageWriter.writeClassesSummary( interfaces, configuration.getText("doclet.Interface_Summary"), interfaceTableSummary, interfaceTableHeader); } }
/** * Build the summary for the enums in this package. */ public void buildEnumSummary() { String enumTableSummary = configuration.getText("doclet.Member_Table_Summary", configuration.getText("doclet.Enum_Summary"), configuration.getText("doclet.enums")); String[] enumTableHeader = new String[] { configuration.getText("doclet.Enum"), configuration.getText("doclet.Description") }; ClassDoc[] enums = packageDoc.isIncluded() ? packageDoc.enums() : configuration.classDocCatalog.enums( Util.getPackageName(packageDoc)); if (enums.length > 0) { packageWriter.writeClassesSummary( enums, configuration.getText("doclet.Enum_Summary"), enumTableSummary, enumTableHeader); } }
/** * Build the summary for the exceptions in this package. */ public void buildExceptionSummary() { String exceptionTableSummary = configuration.getText("doclet.Member_Table_Summary", configuration.getText("doclet.Exception_Summary"), configuration.getText("doclet.exceptions")); String[] exceptionTableHeader = new String[] { configuration.getText("doclet.Exception"), configuration.getText("doclet.Description") }; ClassDoc[] exceptions = packageDoc.isIncluded() ? packageDoc.exceptions() : configuration.classDocCatalog.exceptions( Util.getPackageName(packageDoc)); if (exceptions.length > 0) { packageWriter.writeClassesSummary( exceptions, configuration.getText("doclet.Exception_Summary"), exceptionTableSummary, exceptionTableHeader); } }
/** * Build the summary for the classes in this package. */ public void buildClassSummary() { String classTableSummary = configuration.getText("doclet.Member_Table_Summary", configuration.getText("doclet.Class_Summary"), configuration.getText("doclet.classes")); String[] classTableHeader = new String[] { configuration.getText("doclet.Class"), configuration.getText("doclet.Description") }; ClassDoc[] classes = packageDoc.isIncluded() ? packageDoc.ordinaryClasses() : configuration.classDocCatalog.ordinaryClasses( Util.getPackageName(packageDoc)); if (classes.length > 0) { packageWriter.writeClassesSummary( classes, configuration.getText("doclet.Class_Summary"), classTableSummary, classTableHeader); } }
/** * Build the summary for the errors in this package. */ public void buildErrorSummary() { String errorTableSummary = configuration.getText("doclet.Member_Table_Summary", configuration.getText("doclet.Error_Summary"), configuration.getText("doclet.errors")); String[] errorTableHeader = new String[] { configuration.getText("doclet.Error"), configuration.getText("doclet.Description") }; ClassDoc[] errors = packageDoc.isIncluded() ? packageDoc.errors() : configuration.classDocCatalog.errors( Util.getPackageName(packageDoc)); if (errors.length > 0) { packageWriter.writeClassesSummary( errors, configuration.getText("doclet.Error_Summary"), errorTableSummary, errorTableHeader); } }
/** * Build the summary for the errors in this package. * * @param node the XML element that specifies which components to document * @param summaryContentTree the summary tree to which the error summary will * be added */ public void buildErrorSummary(XMLNode node, Content summaryContentTree) { String errorTableSummary = configuration.getText("doclet.Member_Table_Summary", configuration.getText("doclet.Error_Summary"), configuration.getText("doclet.errors")); String[] errorTableHeader = new String[] { configuration.getText("doclet.Error"), configuration.getText("doclet.Description") }; ClassDoc[] errors = packageDoc.isIncluded() ? packageDoc.errors() : configuration.classDocCatalog.errors( Util.getPackageName(packageDoc)); if (errors.length > 0) { profilePackageWriter.addClassesSummary( errors, configuration.getText("doclet.Error_Summary"), errorTableSummary, errorTableHeader, summaryContentTree); } }
/** * Build the summary for the interfaces in this package. * * @param node the XML element that specifies which components to document * @param summaryContentTree the summary tree to which the interface summary * will be added */ public void buildInterfaceSummary(XMLNode node, Content summaryContentTree) { String interfaceTableSummary = configuration.getText("doclet.Member_Table_Summary", configuration.getText("doclet.Interface_Summary"), configuration.getText("doclet.interfaces")); String[] interfaceTableHeader = new String[] { configuration.getText("doclet.Interface"), configuration.getText("doclet.Description") }; ClassDoc[] interfaces = packageDoc.isIncluded() ? packageDoc.interfaces() : configuration.classDocCatalog.interfaces( Util.getPackageName(packageDoc)); if (interfaces.length > 0) { profilePackageWriter.addClassesSummary( interfaces, configuration.getText("doclet.Interface_Summary"), interfaceTableSummary, interfaceTableHeader, summaryContentTree); } }
/** * Build the summary for the enums in this package. * * @param node the XML element that specifies which components to document * @param summaryContentTree the summary tree to which the enum summary will * be added */ public void buildEnumSummary(XMLNode node, Content summaryContentTree) { String enumTableSummary = configuration.getText("doclet.Member_Table_Summary", configuration.getText("doclet.Enum_Summary"), configuration.getText("doclet.enums")); String[] enumTableHeader = new String[] { configuration.getText("doclet.Enum"), configuration.getText("doclet.Description") }; ClassDoc[] enums = packageDoc.isIncluded() ? packageDoc.enums() : configuration.classDocCatalog.enums( Util.getPackageName(packageDoc)); if (enums.length > 0) { profilePackageWriter.addClassesSummary( enums, configuration.getText("doclet.Enum_Summary"), enumTableSummary, enumTableHeader, summaryContentTree); } }
/** * Build the summary for the exceptions in this package. * * @param node the XML element that specifies which components to document * @param summaryContentTree the summary tree to which the exception summary will * be added */ public void buildExceptionSummary(XMLNode node, Content summaryContentTree) { String exceptionTableSummary = configuration.getText("doclet.Member_Table_Summary", configuration.getText("doclet.Exception_Summary"), configuration.getText("doclet.exceptions")); String[] exceptionTableHeader = new String[] { configuration.getText("doclet.Exception"), configuration.getText("doclet.Description") }; ClassDoc[] exceptions = packageDoc.isIncluded() ? packageDoc.exceptions() : configuration.classDocCatalog.exceptions( Util.getPackageName(packageDoc)); if (exceptions.length > 0) { profilePackageWriter.addClassesSummary( exceptions, configuration.getText("doclet.Exception_Summary"), exceptionTableSummary, exceptionTableHeader, summaryContentTree); } }
/** * Build the summary for the classes in this package. * * @param node the XML element that specifies which components to document * @param summaryContentTree the summary tree to which the class summary will * be added */ public void buildClassSummary(XMLNode node, Content summaryContentTree) { String classTableSummary = configuration.getText("doclet.Member_Table_Summary", configuration.getText("doclet.Class_Summary"), configuration.getText("doclet.classes")); String[] classTableHeader = new String[] { configuration.getText("doclet.Class"), configuration.getText("doclet.Description") }; ClassDoc[] classes = packageDoc.isIncluded() ? packageDoc.ordinaryClasses() : configuration.classDocCatalog.ordinaryClasses( Util.getPackageName(packageDoc)); classes = Util.filterOutPrivateClasses(classes, configuration.javafx); if (classes.length > 0) { packageWriter.addClassesSummary( classes, configuration.getText("doclet.Class_Summary"), classTableSummary, classTableHeader, summaryContentTree); } }
/** * Add class listing for all the classes in this package. Divide class * listing as per the class kind and generate separate listing for * Classes, Interfaces, Exceptions and Errors. * * @param contentTree the content tree to which the listing will be added * @param profileValue the value of the profile being documented */ protected void addClassListing(Content contentTree, int profileValue) { if (packageDoc.isIncluded()) { addClassKindListing(packageDoc.interfaces(), getResource("doclet.Interfaces"), contentTree, profileValue); addClassKindListing(packageDoc.ordinaryClasses(), getResource("doclet.Classes"), contentTree, profileValue); addClassKindListing(packageDoc.enums(), getResource("doclet.Enums"), contentTree, profileValue); addClassKindListing(packageDoc.exceptions(), getResource("doclet.Exceptions"), contentTree, profileValue); addClassKindListing(packageDoc.errors(), getResource("doclet.Errors"), contentTree, profileValue); addClassKindListing(packageDoc.annotationTypes(), getResource("doclet.AnnotationTypes"), contentTree, profileValue); } }