org.fourthline.lemma.reader.javacode

Class JavacodeReader

java.lang.Object

org.fourthline.lemma.reader.AbstractReader

org.fourthline.lemma.reader.javadoc.AbstractJavadocReader

org.fourthline.lemma.reader.javacode.JavacodeReader

All Implemented Interfaces:

Reader

Direct Known Subclasses:

JavacodeRawReader

public class JavacodeReader
extends AbstractJavadocReader

Reads raw lines of Java code, handles javacode:// scheme.

This class will discover the source of the citation reference by using the Javadoc index and LineRangeParsers.

Author:

Christian Bauer

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentFilter[]	filters
protected ContentFileHandler	handler
static Pattern	PATTERN_FRAGMENT_LABEL
protected ContentPrinter	printer

Fields inherited from class org.fourthline.lemma.reader.javadoc.AbstractJavadocReader

CONTEXT_ROOT_DOC

Constructor Summary

Constructors

Constructor and Description
JavacodeReader()

Method Summary

Modifier and Type	Method and Description
protected void	appendContent(org.seamless.xhtml.XHTMLElement parent, com.sun.javadoc.Doc doc, CitationAnchor citation)
protected LineRangeParser	getLineRangeParser(File file)
LineRange	getMethodLineRange(File file, com.sun.javadoc.MethodDoc methodDoc)
protected String	getSignature(com.sun.javadoc.MethodDoc methodDoc)
protected LineRangeParser	instantiateLineRangeParser(File file)
protected org.seamless.xhtml.XHTML	read(CitationAnchor citation, Context context, com.sun.javadoc.RootDoc rootDoc)
protected org.seamless.xhtml.XHTML	read(com.sun.javadoc.Doc doc, CitationAnchor citation, boolean uniqueId)
String[]	readSource(com.sun.javadoc.Doc doc)
protected String	toString(com.sun.javadoc.Type type, boolean qualified)

Methods inherited from class org.fourthline.lemma.reader.javadoc.AbstractJavadocReader

findTargetDoc, read, resolveThisReferences

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

PATTERN_FRAGMENT_LABEL

public static final Pattern PATTERN_FRAGMENT_LABEL

handler

protected final ContentFileHandler handler

printer

protected final ContentPrinter printer

filters

protected final ContentFilter[] filters

Constructor Detail

JavacodeReader

public JavacodeReader()

Method Detail

read

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

Specified by:

read in class AbstractJavadocReader

read

protected org.seamless.xhtml.XHTML read(com.sun.javadoc.Doc doc,
                                        CitationAnchor citation,
                                        boolean uniqueId)

appendContent

protected void appendContent(org.seamless.xhtml.XHTMLElement parent,
                             com.sun.javadoc.Doc doc,
                             CitationAnchor citation)

readSource

public String[] readSource(com.sun.javadoc.Doc doc)

getMethodLineRange

public LineRange getMethodLineRange(File file,
                                    com.sun.javadoc.MethodDoc methodDoc)

getLineRangeParser

protected LineRangeParser getLineRangeParser(File file)

instantiateLineRangeParser

protected LineRangeParser instantiateLineRangeParser(File file)
                                              throws Exception

Throws:

Exception

getSignature

protected String getSignature(com.sun.javadoc.MethodDoc methodDoc)

toString

protected String toString(com.sun.javadoc.Type type,
                          boolean qualified)