Java PackageDoc類代碼示例

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
/**
 * Renders a package documentation to an AsciiDoc file.
 *
 * @param doc the package documentation object
 */
private void renderPackage(PackageDoc doc){
    try {
        PrintWriter writer = getWriter(doc, "package-info");
        writer.println(doc.name());
        if (doc.position() != null) {
            outputText(doc.name(), doc.getRawCommentText(), writer);
        }
        if (doc instanceof AnnotationTypeDoc) {
            for (MemberDoc member : ((AnnotationTypeDoc) doc).elements()) {
                outputText(member.name(), member.getRawCommentText(), writer);
            }
        }
        writer.flush();
    } catch (FileNotFoundException e) {
        e.printStackTrace();
    }
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
/**
 *  @param usedClassToPackagesMap  ClassDoc to (PackageDoc to (UsageType to (Set of Doc)))
 */
private void addUsedBy(Map usedClassToPackagesMap,
                       ClassDoc usedClass, UsageType usageType, Doc user, PackageDoc userPackage)
{
   Map packageToUsageTypeMap = (Map)usedClassToPackagesMap.get(usedClass);
   if (null == packageToUsageTypeMap) {
      packageToUsageTypeMap = new HashMap();
      usedClassToPackagesMap.put(usedClass, packageToUsageTypeMap);
   }

   Map usageTypeToUsersMap = (Map)packageToUsageTypeMap.get(userPackage);
   if (null == usageTypeToUsersMap) {
      usageTypeToUsersMap = new TreeMap();
      packageToUsageTypeMap.put(userPackage, usageTypeToUsersMap);
   }

   Set userSet = (Set)usageTypeToUsersMap.get(usageType);
   if (null == userSet) {
      userSet = new TreeSet(); // FIXME: we need the collator from Main here
      usageTypeToUsersMap.put(usageType, userSet);
   }
   userSet.add(user);
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
/**
 * Returns the XML node corresponding to the specified ClassDoc.
 *
 * @param doc The package to transform.
 */
private static XMLNode toPackageNode(PackageDoc doc) {
  XMLNode node = new XMLNode("package", doc);

  // Core attributes
  node.attribute("name", doc.name());

  // Comment
  node.child(toComment(doc));

  // Child nodes
  node.child(toAnnotationsNode(doc.annotations()));
  node.child(toStandardTags(doc));
  node.child(toTags(doc));
  node.child(toSeeNodes(doc.seeTags()));

  return node;
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
private String getExportedPackage(ClassDoc clz) {
  if (clz == null) {
    return "";
  }

  PackageDoc cpkg = clz.containingPackage();
  String pkg = cpkg == null ? "" : (cpkg.name());

  for (AnnotationDesc a : clz.annotations()) {
    if (a.annotationType().name().equals("ExportPackage")) {
      for (AnnotationDesc.ElementValuePair p : a.elementValues()) {
        pkg = p.value().toString();
        break;
      }
    }
  }
  pkg = pkg.replaceAll("\"", "");
  return pkg;
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
private PackageDoc[] getPackages(PackageDoc[] orig, String... types) {
    List<PackageDoc> wrapped = new ArrayList<PackageDoc>();

    for (PackageDoc p : orig) {
        // wrap the package
        ClassLoader loader = WonderlandDoclet.class.getClassLoader();
        Class<?>[] interfaces = new Class<?>[] { PackageDoc.class };
        InvocationHandler handler = new PackageDocWrapper(p, "ExperimentalAPI");
        PackageDoc pkg =
                (PackageDoc) Proxy.newProxyInstance(loader, interfaces, handler);
        if (pkg.allClasses().length > 0) {
            wrapped.add(pkg);
        }
    }
    
    return wrapped.toArray(new PackageDoc[0]);
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
/**
 * Appends to the current document a valid markdown link
 * that aims to be the shortest one, by using the
 * {@link #getPath(String, String)} method. The
 * built URL will start from the given ``source``
 * package to the given ``target`` class.
 *  
 * @param source Source package to start URL from.
 * @param target Target class to reach from this package.
 */
public void classLink(final PackageDoc source, final ClassDoc target) {
	if (target.isIncluded()) {
		final String path = getPath(source.name(), target.containingPackage().name());
		final StringBuffer urlBuilder = new StringBuffer();
		urlBuilder
			.append(path)
			.append(target.simpleTypeName())
			.append(MarkdownDocumentBuilder.LINK_EXTENSION);
		link(target.simpleTypeName(), urlBuilder.toString());
	}
	else {
		// TODO : Process external link here.
		// TODO : Use marklet-directory project when done.
		italic(target.qualifiedName());
	}
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
/**
 * Appends to the current document the list of parameters
 * from the given ``type`` if any.
 * 
 * @param source Source package to start URL from.
 * @param type Target type to append parameters from.
 */
private void parameterLinks(final PackageDoc source, final Type type) {
	final ParameterizedType invocation = type.asParameterizedType();
	if (invocation != null) {
		final Type [] types = invocation.typeArguments();
		if (types.length > 0) {
			character('<');
			for (int i = 0; i < types.length; i++) {
				parameterLink(source, types[i]);
				if (i < types.length - 1) {
					text(", ");
				}
			}
			character('>');
		}
	}
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
/**
 * Appends to the current document the given type parameter
 * as a valid markdown link.
 * 
 * @param source Source package to start URL from.
 * @param type Target type parameter to reach from this package.
 */
private void parameterLink(final PackageDoc source, final Type type) {
	final WildcardType wildcard = type.asWildcardType();
	if (wildcard != null) {
		character('?');
	}
	else {
		final TypeVariable variableType = type.asTypeVariable();
		if (variableType != null) {
			final Type [] bounds = variableType.bounds();
			if (bounds.length > 0) {
				text("? extends ");
				for (int i = 0; i < bounds.length; i++) {
					typeLink(source, bounds[i]);
					if (i < bounds.length - 1) {
						text(" & ");
					}
				}
			}
		}
		else {
			typeLink(source, type);
		}
	}
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
/**
 * Appends to the current document the class
 * header. Consists in the class name with a
 * level 1 header, the class hierarchy, and
 * the comment text.
 */
private void header() {
	title();
	newLine();
	newLine();

	final PackageDoc packageDoc = classDoc.containingPackage();
	final String packageName = packageDoc.name();
	item();
	text(MarkletConstant.PACKAGE);
	character(' ');
	link(packageName, MarkletConstant.README_LINK);
	newLine();
	item();
	classHierarchy();
	interfaceHierarchy();
	newLine();
	newLine();
	description(classDoc);
	newLine();
	newLine();
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
/**
 * @return the full JSON for the given PackageDoc
 */
protected JSONObject processPackageDoc(PackageDoc packageDoc) {

    if (packageDoc == null) {
        return null;
    }

    JSONObject retMe = processDoc(packageDoc);

    retMe.put("annotations", processAnnotationDescs(packageDoc.annotations()));
    retMe.put("annotationTypes", processAnnotationTypeDocStubs(packageDoc.annotationTypes()));
    retMe.put("enums", processClassDocStubs(packageDoc.enums()));
    retMe.put("errors", processClassDocStubs(packageDoc.errors()));
    retMe.put("exceptions", processClassDocStubs(packageDoc.exceptions()));
    retMe.put("interfaces", processClassDocStubs(packageDoc.interfaces()));
    retMe.put("ordinaryClasses", processClassDocStubs(packageDoc.ordinaryClasses()));

    return retMe;
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
@Override
protected void doRenderOn(HtmlCanvas html) throws IOException {
    PackagePage page = PageRenderer.getPage(html);
    PackageDoc packageDoc = page.getPackageDoc();

    html.div(class_("api_header")).p().content("package").h1().content(packageDoc.name())._div();
    if (packageDoc.inlineTags() != null && packageDoc.inlineTags().length > 0) {
        html.h2().content("Overview");
        html.p().render(new InlineTagsRenderer(generator, packageDoc.inlineTags(), packageDoc.position()))._p();
    }
    renderTypes(packageDoc.interfaces(), "Interfaces", page, html);
    renderTypes(packageDoc.ordinaryClasses(), "Classes", page, html);
    renderTypes(packageDoc.errors(), "Exceptions", page, html);
    renderTypes(packageDoc.enums(), "Enums", page, html);
    renderTypes(packageDoc.annotationTypes(), "Annotation Types", page, html);
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
public PackageDoc containingPackage()
{
   Class outerClass = clazz;
   while (null != outerClass.getDeclaringClass()) {
      outerClass = outerClass.getDeclaringClass();
   }

   String packageName = outerClass.getName();
   int ndx = packageName.lastIndexOf('.');
   if (ndx > 0) {
      packageName = packageName.substring(0, ndx);
   }
   else {
      packageName = "";
   }
   PackageDoc result =  Main.getRootDoc().findOrCreatePackageDoc(packageName);
   return result;
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
public boolean set(String[] optionArr)
{
   try {
      PackageMatcher packageMatcher = new PackageMatcher();

      StringTokenizer tokenizer = new StringTokenizer(optionArr[2], ":");
      while (tokenizer.hasMoreTokens()) {
         String packageWildcard = tokenizer.nextToken();
         packageMatcher.addWildcard(packageWildcard);
      }

      SortedSet<PackageDoc> groupPackages = packageMatcher.filter(rootDoc.specifiedPackages());

      packageGroups.add(new PackageGroup(optionArr[1], groupPackages));

      return true;
   }
   catch (InvalidPackageWildcardException e) {
      return false;
   }
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
/**
 *  @param usedClassToPackagesMap  ClassDoc to (PackageDoc to (UsageType to (Set of Doc)))
 */
private void addUsedBy(Map<ClassDoc,Map<PackageDoc,Map<UsageType,Set<Doc>>>> usedClassToPackagesMap,
                       ClassDoc usedClass, UsageType usageType, Doc user, PackageDoc userPackage)
{
   Map<PackageDoc,Map<UsageType,Set<Doc>>> packageToUsageTypeMap = usedClassToPackagesMap.get(usedClass);
   if (null == packageToUsageTypeMap) {
      packageToUsageTypeMap = new HashMap<PackageDoc,Map<UsageType,Set<Doc>>>();
      usedClassToPackagesMap.put(usedClass, packageToUsageTypeMap);
   }

   Map<UsageType,Set<Doc>> usageTypeToUsersMap = packageToUsageTypeMap.get(userPackage);
   if (null == usageTypeToUsersMap) {
     usageTypeToUsersMap = new TreeMap<UsageType,Set<Doc>>();
      packageToUsageTypeMap.put(userPackage, usageTypeToUsersMap);
   }

   Set<Doc> userSet = usageTypeToUsersMap.get(usageType);
   if (null == userSet) {
      userSet = new TreeSet<Doc>(); // FIXME: we need the collator from Main here
      usageTypeToUsersMap.put(usageType, userSet);
   }
   userSet.add(user);
}
 

import com.sun.javadoc.PackageDoc; //導入依賴的package包/類
/**
 * Returns the XML node corresponding to the specified ClassDoc.
 *
 * @param doc The package to transform.
 */
private static XMLNode toPackageNode(PackageDoc doc) {
  XMLNode node = new XMLNode("package", doc);

  // Core attributes
  node.attribute("name", doc.name());

  // Comments
  node.child(toShortComment(doc));
  node.child(toComment(doc));

  // Child nodes
  node.child(toAnnotationsNode(doc.annotations()));
  node.child(toStandardTags(doc));
  node.child(toTags(doc));
  node.child(toSeeNodes(doc.seeTags()));

  return node;
}