de.unkrig.commons.doclet

Class Docs

java.lang.Object

de.unkrig.commons.doclet.Docs

public final class Docs
extends Object

Utility methods related to doclet tags.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<com.sun.javadoc.Doc>	DOCS_BY_NAME_COMPARATOR Compares Docs by their name.
static Comparator<com.sun.javadoc.Type>	TYPE_COMPARATOR Compares two Types.

Method Summary

Modifier and Type	Method and Description
static com.sun.javadoc.ClassDoc	classNamed(com.sun.javadoc.RootDoc rootDoc, String className) A drop-in replacement for RootDoc.classNamed(String), but instead of returning null it prints an error and throws a Longjump.
static com.sun.javadoc.ClassDoc	classScope(com.sun.javadoc.Doc doc)
static com.sun.javadoc.Doc	findDoc(com.sun.javadoc.Doc from, String to, com.sun.javadoc.RootDoc rootDoc)
static boolean	isSubclassOf(com.sun.javadoc.ClassDoc a, com.sun.javadoc.ClassDoc b)
static com.sun.javadoc.MethodDoc[]	methods(com.sun.javadoc.ClassDoc classDoc, boolean filter, boolean includeInherited) An enhanced version of ClassDoc.methods(boolean) which optionally also includes inherited methods.
static com.sun.javadoc.PackageDoc	packageScope(com.sun.javadoc.Doc doc)
static void	readExternalJavadocs(URL targetUrl, URL packageListUrl, Map<String,URL> externalJavadocs, com.sun.javadoc.RootDoc rootDoc) Reads package names from "packageListUrl/package-list" and puts them into the externalJavadocs map.
static com.sun.javadoc.ClassDoc[]	withSuperclasses(com.sun.javadoc.ClassDoc clasS)
static com.sun.javadoc.ClassDoc[]	withSuperclassesAndInterfaces(com.sun.javadoc.ClassDoc clasS)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_COMPARATOR

public static final Comparator<com.sun.javadoc.Type> TYPE_COMPARATOR

Compares two Types.

DOCS_BY_NAME_COMPARATOR

public static final Comparator<com.sun.javadoc.Doc> DOCS_BY_NAME_COMPARATOR

Compares Docs by their name.

Method Detail

findDoc

@Nullable
public static com.sun.javadoc.Doc findDoc(com.sun.javadoc.Doc from,
                                                     String to,
                                                     com.sun.javadoc.RootDoc rootDoc)
                                              throws Longjump

Parameters:

from - The 'reference' for to, e.g. the MethodDoc if this is a method doc comment

to - E.g. "pkg.MyClass" or "MyClass#meth" or "MyClass#meth(String)"

Returns:

The Doc specified by to, relative to from, or null iff a doc cannot be found

Throws:

Longjump

withSuperclasses

public static com.sun.javadoc.ClassDoc[] withSuperclasses(com.sun.javadoc.ClassDoc clasS)

Returns:

The clasS, and all superclasses (including Object) it extends

withSuperclassesAndInterfaces

public static com.sun.javadoc.ClassDoc[] withSuperclassesAndInterfaces(com.sun.javadoc.ClassDoc clasS)

Returns:

The clasS, all superclasses (including Object) it extends, and all interfaces that it and its superclasses implement

classScope

@Nullable
public static com.sun.javadoc.ClassDoc classScope(com.sun.javadoc.Doc doc)

Returns:

The ClassDoc containing the given doc, or null iff doc is a PackageDoc or a RootDoc

packageScope

@Nullable
public static com.sun.javadoc.PackageDoc packageScope(com.sun.javadoc.Doc doc)

Returns:

The PackageDoc containing the given doc, or null iff doc is a RootDoc

methods

public static com.sun.javadoc.MethodDoc[] methods(com.sun.javadoc.ClassDoc classDoc,
                                                  boolean filter,
                                                  boolean includeInherited)

An enhanced version of ClassDoc.methods(boolean) which optionally also includes inherited methods.

Parameters:

filter - Specify true to filter according to the specified access modifier option; see ClassDoc.methods(boolean)

includeInherited - Whether to add the superclasses' and the implemented interfaces' methods after the class's methods

classNamed

public static com.sun.javadoc.ClassDoc classNamed(com.sun.javadoc.RootDoc rootDoc,
                                                  String className)
                                           throws Longjump

A drop-in replacement for RootDoc.classNamed(String), but instead of returning null it prints an error and throws a Longjump.

Throws:

Longjump

isSubclassOf

public static boolean isSubclassOf(com.sun.javadoc.ClassDoc a,
                                   com.sun.javadoc.ClassDoc b)

Returns:

Whether b is a, or an interface or superclass of a

readExternalJavadocs

public static void readExternalJavadocs(URL targetUrl,
                                        URL packageListUrl,
                                        Map<String,URL> externalJavadocs,
                                        com.sun.javadoc.RootDoc rootDoc)
                                 throws IOException

Reads package names from "packageListUrl/package-list" and puts them into the externalJavadocs map.

Parameters:

targetUrl - Designates the root folder of the external API documentation; must end in "/"

packageListUrl - Designates the folder where the "package-list" file exists; must end in "/"

Throws:

IOException