aurigadoclet api - sourceforgeaurigadoclet.sourceforge.net/docs/javadoc/aurigadoclet-api.pdf ·...

AurigaDoclet APIAuthor: Khurshidali Shaikh

Organization: Auriga Logic

© Copyright Auirga Logic Pvt. Ltd. All Rights Reserved

Generated with AurigaDoclet <http://aurigadoclet.sourceforge.net>

Table Of Content

com.aurigalogic.doclet.core........................................................................................................... 3

Doclet.................................................................................................................................. 3

XMLGenerator .................................................................................................................... 7

com.aurigalogic.doclet.util ............................................................................................................. 9

Util....................................................................................................................................... 9

com.aurigalogic.doclet.writer ....................................................................................................... 11

AbstractDocWriter............................................................................................................. 12

CssTreeBuilder ................................................................................................................. 15

DocWriter.......................................................................................................................... 16

FODocWriter..................................................................................................................... 18

MIFDocWriter.................................................................................................................... 20

PCLDocWriter................................................................................................................... 21

PDFDocWriter................................................................................................................... 22

PSDocWriter ..................................................................................................................... 24

SVGDocWriter .................................................................................................................. 25

Index............................................................................................................................................ 27

Package com.aurigalogic.doclet.core

Class SummaryDoclet

Doclet class for AurigaDoclet

XMLGeneratorClass which generates an xml tree from the RootDoc.

com.aurigalogic.doclet.core

Class Docletjava.lang.Object

|+--com.sun.javadoc.Doclet

|+--com.aurigalogic.doclet.core.Doclet

< Fields > < Constructors > < Methods >

public class Docletextends com.sun.javadoc.Doclet

Doclet class for AurigaDoclet

Author:Khurshidali Shaikh

Version:$Revision: 1.1 $ $Date: 2003/12/24 12:41:39 $

Fields

BOTTOM_MARGINprotected static final java.lang.String BOTTOM_MARGIN

COVER_FILEprotected static final java.lang.String COVER_FILE

AurigaDoclet API Document

Pg - 3

mailto:[email protected]

COVER_TEXTprotected static final java.lang.String COVER_TEXT

CSS_FILEprotected static final java.lang.String CSS_FILE

FOOTER_FILEprotected static final java.lang.String FOOTER_FILE

FOOTER_HEIGHTprotected static final java.lang.String FOOTER_HEIGHT

FOOTER_TEXTprotected static final java.lang.String FOOTER_TEXT

FORMATprotected static final java.lang.String FORMAT

HEADER_FILEprotected static final java.lang.String HEADER_FILE

HEADER_HEIGHTprotected static final java.lang.String HEADER_HEIGHT


Pg - 4

HEADER_TEXTprotected static final java.lang.String HEADER_TEXT

LEFT_MARGINprotected static final java.lang.String LEFT_MARGIN

NO_INDEXprotected static final java.lang.String NO_INDEX

NO_LINKSprotected static final java.lang.String NO_LINKS

NO_NAVIGATIONprotected static final java.lang.String NO_NAVIGATION

NO_TOCprotected static final java.lang.String NO_TOC

OUTPUTprotected static final java.lang.String OUTPUT

RIGHT_MARGINprotected static final java.lang.String RIGHT_MARGIN

TOP_MARGIN


Pg - 5

protected static final java.lang.String TOP_MARGIN

XSL_FILEprotected static final java.lang.String XSL_FILE

Constructors

Docletpublic Doclet(java.lang.String[][] options)

Default constructor.

Methods

optionLengthpublic static int optionLength(java.lang.String option)

Returns the option length for supported command line options.

startpublic static boolean start(RootDoc rootDoc)

Entry point for this doclet.

validOptionspublic static boolean validOptions(java.lang.String[][] options,

DocErrorReporter reporter)

Validates the options.


Pg - 6

com.aurigalogic.doclet.core

Class XMLGeneratorjava.lang.Object

|+--com.aurigalogic.doclet.core.XMLGenerator

< Constructors > < Methods >

public class XMLGeneratorextends java.lang.Object

Class which generates an xml tree from the RootDoc. This xml is then transformed to various formats.


Version:$Revision: 1.1 $ $Date: 2003/12/24 12:41:39 $

Constructors

XMLGeneratorpublic XMLGenerator(java.lang.String[][] options)

Default constructor.

Methods

generateXMLpublic void generateXML(RootDoc rootDoc)

Generates the xml tree.

Parameters:

rootDoc - the javadoc root.


Pg - 7


getXMLStreampublic java.io.InputStream getXMLStream()

getXMLStringpublic java.lang.String getXMLString()


Pg - 8

Package com.aurigalogic.doclet.util

Class SummaryUtil

Utility class

com.aurigalogic.doclet.util

Class Utiljava.lang.Object

|+--com.aurigalogic.doclet.util.Util

< Methods >

public class Utilextends java.lang.Object

Utility class


Version:$Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $

Methods

readFilepublic static java.lang.String readFile(java.lang.String path)

Reads a file and returns the content as string.

tidypublic static java.lang.String tidy(java.lang.String html)

Cleans the given html using Tidy.


Pg - 9


writeFilepublic static void writeFile(java.lang.String path,

java.lang.String content)

Writes the given given text to the specified file.


Pg - 10

Package com.aurigalogic.doclet.writer

Interface SummaryDocWriter

DocWriter interface.

Class SummaryAbstractDocWriter

Abstract doc writer.

CssTreeBuilderThis class parses the given css stream and builds a xml tree.

FODocWriterThis class is used for generating javadoc in FO format.

MIFDocWriterMIF document writer.

PCLDocWriterPCL document writer.

PDFDocWriterPDF document generator.

PSDocWriterPostscript document write.

SVGDocWriterSVG document writer.


Pg - 11

com.aurigalogic.doclet.writer

Class AbstractDocWriterjava.lang.Object

|+--com.aurigalogic.doclet.writer.AbstractDocWriter

All Implemented Interfaces:DocWriter

Direct Known Subclasses:FODocWriter

< Fields > < Constructors > < Methods >

public abstract class AbstractDocWriterextends java.lang.Objectimplements DocWriter

Abstract doc writer.



Fields

OUTPUT_HTMLprotected static final java.lang.String OUTPUT_HTML

OUTPUT_XMLprotected static final java.lang.String OUTPUT_XML

cssStreamprotected java.io.InputStream cssStream


Pg - 12


logprotected org.apache.avalon.framework.logger.ConsoleLogger log

outputFileprotected java.lang.String outputFile

parametersprotected java.util.Properties parameters

xmlStreamprotected java.io.InputStream xmlStream

xslStreamprotected java.io.InputStream xslStream

Constructors

AbstractDocWriterpublic AbstractDocWriter()

Methods


Pg - 13

doTransformpublic void doTransform(java.io.InputStream xmlStream,

java.io.InputStream xslStream,java.io.OutputStream outputStream,java.lang.String outputMethod,java.util.Properties parameters)

throws java.lang.Exception

Takes the xml source and write the output to the given stream by doing an xsl transformation.

Parameters:

xmlStream - the xml streamxslStream - the xsl streamoutputStream - the output streamoutputMethod - the output method(text,html,xml)parameters - additonal xsl parameters

Throws:

java.lang.Exception - in case of an error.

setCssStreampublic void setCssStream(java.io.InputStream cssStream)

Sets the css stream.

Parameters:

cssStream - the css stream.

setOutputFilepublic void setOutputFile(java.lang.String outputFile)

Sets the output file.

Parameters:

outputFile - the output file.

setParameterspublic void setParameters(java.util.Properties params)

Sets the parameters.


Pg - 14

setXmlStreampublic void setXmlStream(java.io.InputStream xmlStream)

Sets the xml stream.

Parameters:

xmlStream - the xml stream.

setXslStreampublic void setXslStream(java.io.InputStream xslStream)

Sets the xsl stream.

Parameters:

xslStream - the xsl stream.

writeDocpublic abstract void writeDoc()


Class CssTreeBuilderjava.lang.Object

|+--com.aurigalogic.doclet.writer.CssTreeBuilder


public class CssTreeBuilderextends java.lang.Object

This class parses the given css stream and builds a xml tree.


Version:


Pg - 15


$Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $

Constructors

CssTreeBuilderpublic CssTreeBuilder(java.io.InputStream cssStream,

java.lang.String output)throws java.lang.Exception

Constructor.

Parameters:

output - the output document

Throws:

java.lang.Exception - is an error occurs

Methods

getCssTreeFileUrlpublic java.lang.String getCssTreeFileUrl()

Returns the path of the cssTree file

Returns:

the css tree file path


Interface DocWriter

< Methods >

public interface DocWriter

DocWriter interface.


Version:


Pg - 16


$Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $

Methods

setCssStreampublic void setCssStream(java.io.InputStream cssStream)

Sets the css stream.

Parameters:

cssStream - the css stream.

setOutputFilepublic void setOutputFile(java.lang.String outputFile)

Sets the output file.

Parameters:

outputFile - the output file.

setParameterspublic void setParameters(java.util.Properties params)

Sets the parameters.

setXmlStreampublic void setXmlStream(java.io.InputStream xmlStream)

Sets the xml stream.

Parameters:

xmlStream - the xml stream.


Pg - 17

setXslStreampublic void setXslStream(java.io.InputStream xslStream)

Sets the xsl stream.

Parameters:

xslStream - the xsl stream.

writeDocpublic void writeDoc()

Write the output document.


Class FODocWriterjava.lang.Object

|+--AbstractDocWriter

|+--com.aurigalogic.doclet.writer.FODocWriter


Direct Known Subclasses:PDFDocWriter


public class FODocWriterextends AbstractDocWriter

This class is used for generating javadoc in FO format.



Constructors


Pg - 18


FODocWriterpublic FODocWriter()

Methods

createFOprotected void createFO(java.io.InputStream xmlStream,

java.io.OutputStream outputStream)throws java.lang.Exception

Generates the fo document

Parameters:

in - the xml streamout - the fo output stream

Throws:




Converts the given xml stream to fo and writes it to the output file.

Overrides:

writeDoc in class AbstractDocWriter

Throws:



Pg - 19


Class MIFDocWriterjava.lang.Object


|+--FODocWriter

|+--PDFDocWriter

|+--com.aurigalogic.doclet.writer.MIFDocWriter



public class MIFDocWriterextends PDFDocWriter

MIF document writer.



Constructors

MIFDocWriterpublic MIFDocWriter()

Methods


Pg - 20




Writes the javadoc output to the specified file.

Overrides:

writeDoc in class PDFDocWriter

Throws:



Class PCLDocWriterjava.lang.Object


|+--FODocWriter

|+--PDFDocWriter

|+--com.aurigalogic.doclet.writer.PCLDocWriter



public class PCLDocWriterextends PDFDocWriter

PCL document writer.



Constructors


Pg - 21


PCLDocWriterpublic PCLDocWriter()

Methods




Overrides:


Throws:



Class PDFDocWriterjava.lang.Object


|+--FODocWriter

|+--com.aurigalogic.doclet.writer.PDFDocWriter


Direct Known Subclasses:MIFDocWriter, PCLDocWriter, PSDocWriter, SVGDocWriter


public class PDFDocWriterextends FODocWriter

PDF document generator.



Pg - 22



Constructors

PDFDocWriterpublic PDFDocWriter()

Methods




Overrides:

writeDoc in class FODocWriter

Throws:


writeDocUsingFOPprotected void writeDocUsingFOP(int renderer)

Convert the input stream to output stream using the given xsl stream and the renderer.

Parameters:

renderer - the fop renderer to use


Pg - 23


Class PSDocWriterjava.lang.Object


|+--FODocWriter

|+--PDFDocWriter

|+--com.aurigalogic.doclet.writer.PSDocWriter



public class PSDocWriterextends PDFDocWriter

Postscript document write.



Constructors

PSDocWriterpublic PSDocWriter()

Methods


Pg - 24





Overrides:


Throws:



Class SVGDocWriterjava.lang.Object


|+--FODocWriter

|+--PDFDocWriter

|+--com.aurigalogic.doclet.writer.SVGDocWriter



public class SVGDocWriterextends PDFDocWriter

SVG document writer.



Constructors


Pg - 25


SVGDocWriterpublic SVGDocWriter()

Methods




Overrides:


Throws:



Pg - 26

INDEX

AAbstractDocWriter ... 12AbstractDocWriter ... 13

BBOTTOM_MARGIN ... 3

CcreateFO ... 19cssStream ... 12COVER_FILE ... 3COVER_TEXT ... 4CSS_FILE ... 4CssTreeBuilder ... 15CssTreeBuilder ... 16

DdoTransform ... 14Doclet ... 3Doclet ... 6DocWriter ... 16

FFODocWriter ... 18FODocWriter ... 19FOOTER_FILE ... 4FOOTER_HEIGHT ... 4FOOTER_TEXT ... 4FORMAT ... 4

GgenerateXML ... 7getCssTreeFileUrl ... 16getXMLStream ... 8getXMLString ... 8

HHEADER_FILE ... 4HEADER_HEIGHT ... 4HEADER_TEXT ... 5

Llog ... 13LEFT_MARGIN ... 5

MMIFDocWriter ... 20MIFDocWriter ... 20

NNO_INDEX ... 5NO_LINKS ... 5NO_NAVIGATION ... 5NO_TOC ... 5

OoptionLength ... 6outputFile ... 13OUTPUT ... 5OUTPUT_HTML ... 12OUTPUT_XML ... 12

Pparameters ... 13PCLDocWriter ... 21PCLDocWriter ... 22PDFDocWriter ... 22PDFDocWriter ... 23PSDocWriter ... 24PSDocWriter ... 24

RreadFile ... 9RIGHT_MARGIN ... 5

SsetCssStream ... 14setCssStream ... 17setOutputFile ... 14setOutputFile ... 17setParameters ... 14setParameters ... 17setXmlStream ... 15setXmlStream ... 17setXslStream ... 15setXslStream ... 18start ... 6SVGDocWriter ... 25SVGDocWriter ... 26

Ttidy ... 9TOP_MARGIN ... 5

UUtil ... 9

VvalidOptions ... 6

WwriteDoc ... 15writeDoc ... 18writeDoc ... 19writeDoc ... 21writeDoc ... 22writeDoc ... 23writeDoc ... 25writeDoc ... 26writeDocUsingFOP ... 23writeFile ... 10

XxmlStream ... 13xslStream ... 13XMLGenerator ... 7XMLGenerator ... 7XSL_FILE ... 6

aurigadoclet api - sourceforgeaurigadoclet.sourceforge.net/docs/javadoc/aurigadoclet-api.pdf ·...

Documents