org.codehaus.backport175.compiler.javadoc

Class JavaDocParser

java.lang.Object

org.codehaus.backport175.compiler.javadoc.JavaDocParser

public class JavaDocParser
extends java.lang.Object

Parses and retrieves annotations from the JavaDoc in Java source files.

Author:

Jonas Bonér , Alexandre Vasseur

Constructor Summary

Constructors

Constructor and Description
JavaDocParser()

Method Summary

Methods

Modifier and Type	Method and Description
void	addClassLoaderToSearchPath(java.lang.ClassLoader loader) Adds the given ClassLoader to the search path
void	addSource(java.lang.String srcFile) Adds a source file.
void	addSourceTrees(java.lang.String[] srcDirs) Adds a source tree to the builder.
JavaClass[]	getJavaClasses() Returns all classes.
static RawAnnotation	getRawAnnotation(java.lang.Class annotationClass, java.lang.String annotationName, DocletTag tag, java.lang.String enclosingClassName, java.lang.String enclosingClassFileName) Extract the raw information of the annotation, the "content" inside the parenthesis).

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaDocParser

public JavaDocParser()

Method Detail

addClassLoaderToSearchPath

public void addClassLoaderToSearchPath(java.lang.ClassLoader loader)

Adds the given ClassLoader to the search path

Parameters:

loader -

addSourceTrees

public void addSourceTrees(java.lang.String[] srcDirs)

Adds a source tree to the builder.

Parameters:

srcDirs - the source trees

addSource

public void addSource(java.lang.String srcFile)

Adds a source file.

Parameters:

srcFile - the source file

getJavaClasses

public JavaClass[] getJavaClasses()

Returns all classes.

Returns:

an array with all classes

getRawAnnotation

public static RawAnnotation getRawAnnotation(java.lang.Class annotationClass,
                             java.lang.String annotationName,
                             DocletTag tag,
                             java.lang.String enclosingClassName,
                             java.lang.String enclosingClassFileName)

Extract the raw information of the annotation, the "content" inside the parenthesis).

Parameters:

annotationClass -

annotationName -

tag -

enclosingClassName -

enclosingClassFileName -

Returns:

RawAnnotation or null if not found