com.github.therapi.runtimejavadoc

Class RuntimeJavadoc

java.lang.Object

com.github.therapi.runtimejavadoc.RuntimeJavadoc

public class RuntimeJavadoc
extends java.lang.Object

Allows access to Javadoc elements at runtime for code that was compiled using the therapi-runtime-javadoc-scribe annotation processor.

Method Summary

Modifier and Type	Method and Description
static ClassJavadoc	getJavadoc(java.lang.Class<?> clazz) Gets the Javadoc of the given class.
static MethodJavadoc	getJavadoc(java.lang.reflect.Constructor<?> method) Gets the Javadoc of the given constructor.
static FieldJavadoc	getJavadoc(java.lang.Enum<?> enumValue) Gets the Javadoc of the given enum constant.
static FieldJavadoc	getJavadoc(java.lang.reflect.Field field) Gets the Javadoc of the given field.
static MethodJavadoc	getJavadoc(java.lang.reflect.Method method) Gets the Javadoc of the given method.
static ClassJavadoc	getJavadoc(java.lang.String qualifiedClassName) Gets the Javadoc of the given class.
static ClassJavadoc	getJavadoc(java.lang.String qualifiedClassName, java.lang.Class<?> loader) Gets the Javadoc of the given class, using the given Class object to load the Javadoc resource.
static ClassJavadoc	getJavadoc(java.lang.String qualifiedClassName, java.lang.ClassLoader loader) Gets the Javadoc of the given class, using the given ClassLoader to find the Javadoc resource.

Methods inherited from class java.lang.Object

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

Method Detail

getJavadoc

public static ClassJavadoc getJavadoc(java.lang.Class<?> clazz)

Gets the Javadoc of the given class.

The return value is always non-null. If no Javadoc is available, the returned object's isEmpty() method will return true.

Parameters:

clazz - the class whose Javadoc you want to retrieve

Returns:

the Javadoc of the given class

getJavadoc

public static ClassJavadoc getJavadoc(java.lang.String qualifiedClassName)

Gets the Javadoc of the given class.

The return value is always non-null. If no Javadoc is available, the returned object's isEmpty() method will return true.

Parameters:

qualifiedClassName - the fully qualified name of the class whose Javadoc you want to retrieve

Returns:

the Javadoc of the given class

getJavadoc

public static ClassJavadoc getJavadoc(java.lang.String qualifiedClassName,
                                      java.lang.ClassLoader loader)

Gets the Javadoc of the given class, using the given ClassLoader to find the Javadoc resource.

The return value is always non-null. If no Javadoc is available, the returned object's isEmpty() method will return true.

Parameters:

qualifiedClassName - the fully qualified name of the class whose Javadoc you want to retrieve

loader - the class loader to use to find the Javadoc resource file

Returns:

the Javadoc of the given class

getJavadoc

public static ClassJavadoc getJavadoc(java.lang.String qualifiedClassName,
                                      java.lang.Class<?> loader)

Gets the Javadoc of the given class, using the given Class object to load the Javadoc resource.

The return value is always non-null. If no Javadoc is available, the returned object's isEmpty() method will return true.

Parameters:

qualifiedClassName - the fully qualified name of the class whose Javadoc you want to retrieve

loader - the class object to use to find the Javadoc resource file

Returns:

the Javadoc of the given class

getJavadoc

public static MethodJavadoc getJavadoc(java.lang.reflect.Method method)

Gets the Javadoc of the given method.

The return value is always non-null. If no Javadoc is available, the returned object's isEmpty() method will return true.

Implementation note: this method first retrieves the Javadoc of the class, and then matches the method signature with the correct documentation. If the client code's purpose is to loop through all methods doc, prefer using getJavadoc(Class) (or one of its overloads), and calling ClassJavadoc.getMethods() on the returned class doc to retrieve method docs.

Parameters:

method - the method whose Javadoc you want to retrieve

Returns:

the given method's Javadoc

getJavadoc

public static MethodJavadoc getJavadoc(java.lang.reflect.Constructor<?> method)

Gets the Javadoc of the given constructor.

The return value is always non-null. If no Javadoc is available, the returned object's isEmpty() method will return true.

Implementation note: this method first retrieves the Javadoc of the class, and then matches the method signature with the correct documentation. If the client code's purpose is to loop through all methods doc, prefer using getJavadoc(Class) (or one of its overloads), and calling ClassJavadoc.getMethods() on the returned class doc to retrieve method docs.

Parameters:

method - the constructor whose Javadoc you want to retrieve

Returns:

the given constructor's Javadoc

getJavadoc

public static FieldJavadoc getJavadoc(java.lang.reflect.Field field)

Gets the Javadoc of the given field.

The return value is always non-null. If no Javadoc is available, the returned object's isEmpty() method will return true.

Implementation note: this method first retrieves the Javadoc of the class, and then matches the field name with the correct documentation. If the client code's purpose is to loop through all fields doc, prefer using getJavadoc(Class) (or one of its overloads), and calling ClassJavadoc.getFields() on the returned class doc to retrieve field docs.

Parameters:

field - the field whose Javadoc you want to retrieve

Returns:

the given field's Javadoc

getJavadoc

public static FieldJavadoc getJavadoc(java.lang.Enum<?> enumValue)

Gets the Javadoc of the given enum constant.

The return value is always non-null. If no Javadoc is available, the returned object's isEmpty() method will return true.

Implementation note: this method first retrieves the Javadoc of the class, and then matches the enum constant's name with the correct documentation. If the client code's purpose is to loop through all enum constants docs, prefer using getJavadoc(Class) (or one of its overloads), and calling ClassJavadoc.getEnumConstants() on the returned class doc to retrieve enum constant docs.

Parameters:

enumValue - the enum constant whose Javadoc you want to retrieve

Returns:

the given enum constant's Javadoc