org.fourthline.lemma.reader.javadoc

Class AbstractJavadocReader

java.lang.Object

org.fourthline.lemma.reader.AbstractReader

org.fourthline.lemma.reader.javadoc.AbstractJavadocReader

All Implemented Interfaces:

Reader

Direct Known Subclasses:

JavacodeReader, JavadocReader

public abstract class AbstractJavadocReader
extends AbstractReader

Looks up the Javadoc RootDoc from the context.

Author:

Christian Bauer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_ROOT_DOC

Constructor Summary

Constructors

Constructor and Description
AbstractJavadocReader()

Method Summary

Modifier and Type	Method and Description
protected com.sun.javadoc.Doc	findTargetDoc(CitationAnchor citation, com.sun.javadoc.RootDoc rootDoc)
org.seamless.xhtml.XHTML	read(CitationAnchor citation, Context context)
protected abstract org.seamless.xhtml.XHTML	read(CitationAnchor citation, Context context, com.sun.javadoc.RootDoc rootDoc)
protected org.seamless.xhtml.XHTML	resolveThisReferences(Context context, com.sun.javadoc.Doc targetDoc, org.seamless.xhtml.XHTML input)

Methods inherited from class org.fourthline.lemma.reader.AbstractReader

addFilePath, appendTitle, getParser, getXPath, isGenerateId, resolveFile

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_ROOT_DOC

public static final String CONTEXT_ROOT_DOC

See Also:

Constant Field Values

Constructor Detail

AbstractJavadocReader

public AbstractJavadocReader()

Method Detail

read

public org.seamless.xhtml.XHTML read(CitationAnchor citation,
                                     Context context)

read

protected abstract org.seamless.xhtml.XHTML read(CitationAnchor citation,
                                                 Context context,
                                                 com.sun.javadoc.RootDoc rootDoc)

findTargetDoc

protected com.sun.javadoc.Doc findTargetDoc(CitationAnchor citation,
                                            com.sun.javadoc.RootDoc rootDoc)

resolveThisReferences

protected org.seamless.xhtml.XHTML resolveThisReferences(Context context,
                                                         com.sun.javadoc.Doc targetDoc,
                                                         org.seamless.xhtml.XHTML input)