/** * Given a package, return it's name. * @param packageDoc the package to check. * @return the name of the given package. */ public static String getPackageName(PackageDoc packageDoc) { return packageDoc == null || packageDoc.name().length() == 0 ? DocletConstants.DEFAULT_PACKAGE_NAME : packageDoc.name(); }
/** * Given a package, return it's file name without the extension. * @param packageDoc the package to check. * @return the file name of the given package. */ public static String getPackageFileHeadName(PackageDoc packageDoc) { return packageDoc == null || packageDoc.name().length() == 0 ? DocletConstants.DEFAULT_PACKAGE_FILE_NAME : packageDoc.name(); }
/** * Return the path for a package. * For example, if the package is java.lang, * the path is java/lang. */ public static DocPath forPackage(PackageDoc pd) { return (pd == null) ? empty : DocPath.create(pd.name().replace('.', '/')); }
/** * Determine if a doc item is externally documented. * * @param doc A ProgramElementDoc. */ public boolean isExternal(ProgramElementDoc doc) { if (packageToItemMap == null) { return false; } return packageToItemMap.get(doc.containingPackage().name()) != null; }
protected void generatePackageListFile(RootDoc root) { PackageDoc[] packages = configuration.packages; String[] names = new String[packages.length]; for (int i = 0; i < packages.length; i++) { names[i] = packages[i].name(); } Arrays.sort(names); for (int i = 0; i < packages.length; i++) { println(names[i]); } } }
/** * Determine if a doc item is externally documented. * * @param doc A ProgramElementDoc. */ public boolean isExternal(ProgramElementDoc doc) { if (packageToItemMap == null) { return false; } return packageToItemMap.get(doc.containingPackage().name()) != null; }
private String getPackageName(String className) { if (this.rootClassdocs.get(className) == null) { int idx = className.lastIndexOf('.'); return idx > 0 ? className.substring(0, idx) : ""; } else { return this.rootClassdocs.get(className).containingPackage().name(); } }
/** * Given a PackageDoc, return its URL path string. * * @param pd PackageDoc * @see #getPath(String) */ public static String createPathString(PackageDoc pd) { if (pd == null) { return ""; } return getPath(pd.name()); }
/** * Build the header for the given class. */ public void buildPackageHeader() { String parsedPackageName = parsePackageName(currentPackage.name()); if (! printedPackageHeaders.contains(parsedPackageName)) { writer.writePackageName(currentPackage, parsePackageName(currentPackage.name())); printedPackageHeaders.add(parsedPackageName); } }
public PackageView(String outputFolder, PackageDoc pd, RootDoc root, OptionProvider parent) { this.parent = parent; this.pd = pd; this.matcher = new PackageMatcher(pd); this.opt = parent.getGlobalOptions(); this.opt.setOptions(pd); this.outputPath = pd.name().replace('.', '/') + "/" + pd.name() + ".dot"; }
/** * @return "com.acme.pkg.Outer$Inner$Inner2" */ public static String className(ClassDoc classDoc) { // "Outer.Inner.Inner2" => "Outer$Inner$Inner2" String name = classDoc.name().replace('.', '$'); String packageName = classDoc.containingPackage().name(); return packageName.isEmpty() ? name : packageName + '.' + name; } }
/** * @return "com.acme.pkg.Outer$Inner$Inner2" */ public static String className(ClassDoc classDoc) { // "Outer.Inner.Inner2" => "Outer$Inner$Inner2" String name = classDoc.name().replace('.', '$'); String packageName = classDoc.containingPackage().name(); return packageName.isEmpty() ? name : packageName + '.' + name; } }
public void setContextCenter(ClassDoc contextCenter) { this.cd = contextCenter; String outputPath = cd.containingPackage().name().replace('.', '/') + "/" + cd.name() + ".dot"; this.myGlobalOptions.setOption(new String[] { "output", outputPath }); matcher.setContextCenter(Pattern.compile(Pattern.quote(cd.toString()))); }
private static void generatePackageSummaries(RootDoc root, ClassDocGraph graph, File outputDirectory) throws IOException { for (PackageDoc p: getPackages(root).values()) { instrumentDiagram( root, outputDirectory, p.name().replace('.', File.separatorChar) + File.separatorChar + "package-summary", graph.getPackageSummaryDiagram(p)); } }
public void setContextCenter(ClassDoc contextCenter) { this.cd = contextCenter; String outputPath = cd.containingPackage().name().replace('.', '/') + "/" + cd.name() + ".dot"; this.myGlobalOptions.setOption(new String[] { "-output", outputPath }); matcher.setContextCenter(Pattern.compile(cd.toString())); }
protected Package parsePackage(PackageDoc packageDoc) { Package packageNode = objectFactory.createPackage(); packageNode.setName(packageDoc.name()); String comment = packageDoc.commentText(); if (comment.length() > 0) { packageNode.setComment(comment); } for (Tag tag : packageDoc.tags()) { packageNode.getTag().add(parseTag(tag)); } return packageNode; }
/** Convert the class name into a corresponding URL */ public String classToUrl(ClassDoc cd, boolean rootClass) { // building relative path for context and package diagrams if(contextPackageName != null && rootClass) return buildRelativePathFromClassNames(contextPackageName, cd.containingPackage().name()) + cd.name() + ".html"; return classToUrl(cd.qualifiedName()); }