AurigaDoclet API Author: Khurshidali Shaikh Organization: Auriga Logic © Copyright Auirga Logic Pvt. Ltd. All Rights Reserved Generated with AurigaDoclet <http://aurigadoclet.sourceforge.net> Table Of Contentcom.aurigalogic.doclet.coreDocletXMLGeneratorcom.aurigalogic.doclet.utilUtilcom.aurigalogic.doclet.writerAbstractDocWriterCssTreeBuilderDocWriterFODocWriterMIFDocWriterPCLDocWriterPDFDocWriterPSDocWriterSVGDocWriterIndexcom.aurigalogic.doclet.coreDocletFieldsBOTTOM_MARGINCOVER_FILECOVER_TEXTCSS_FILEFOOTER_FILEFOOTER_HEIGHTFOOTER_TEXTFORMATHEADER_FILEHEADER_HEIGHTHEADER_TEXTLEFT_MARGINNO_INDEXNO_LINKSNO_NAVIGATIONNO_TOCOUTPUTRIGHT_MARGINTOP_MARGINXSL_FILEConstructorsDoclet(java.lang.String[][])MethodsoptionLength(java.lang.String)start(RootDoc)validOptions(java.lang.String[][], DocErrorReporter)XMLGeneratorConstructorsXMLGenerator(java.lang.String[][])MethodsgenerateXML(RootDoc)getXMLStream()getXMLString()com.aurigalogic.doclet.utilUtilMethodsreadFile(java.lang.String)tidy(java.lang.String)writeFile(java.lang.String, java.lang.String)com.aurigalogic.doclet.writerAbstractDocWriterFieldsOUTPUT_HTMLOUTPUT_XMLcssStreamlogoutputFileparametersxmlStreamxslStreamConstructorsAbstractDocWriter()MethodsdoTransform(java.io.InputStream, java.io.InputStream, java.io.OutputStream, java.lang.String, java.util.Properties)setCssStream(java.io.InputStream)setOutputFile(java.lang.String)setParameters(java.util.Properties)setXmlStream(java.io.InputStream)setXslStream(java.io.InputStream)writeDoc()CssTreeBuilderConstructorsCssTreeBuilder(java.io.InputStream, java.lang.String)MethodsgetCssTreeFileUrl()DocWriterMethodssetCssStream(java.io.InputStream)setOutputFile(java.lang.String)setParameters(java.util.Properties)setXmlStream(java.io.InputStream)setXslStream(java.io.InputStream)writeDoc()FODocWriterConstructorsFODocWriter()MethodscreateFO(java.io.InputStream, java.io.OutputStream)writeDoc()MIFDocWriterConstructorsMIFDocWriter()MethodswriteDoc()PCLDocWriterConstructorsPCLDocWriter()MethodswriteDoc()PDFDocWriterConstructorsPDFDocWriter()MethodswriteDoc()writeDocUsingFOP(int)PSDocWriterConstructorsPSDocWriter()MethodswriteDoc()SVGDocWriterConstructorsSVGDocWriter()MethodswriteDoc()Index AurigaDoclet API Document Pg - Package com.aurigalogic.doclet.core Class SummaryDoclet Doclet class for AurigaDoclet XMLGenerator Class which generates an xml tree from the RootDoc. com.aurigalogic.doclet.coreClass 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 $ FieldsBOTTOM_MARGINprotected static final java.lang.String BOTTOM_MARGIN COVER_FILEprotected static final java.lang.String COVER_FILE 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 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_MARGINprotected static final java.lang.String TOP_MARGIN XSL_FILEprotected static final java.lang.String XSL_FILE ConstructorsDocletpublic Doclet(java.lang.String[][] options) Default constructor. MethodsoptionLengthpublic 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. com.aurigalogic.doclet.coreClass 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. Author: Khurshidali Shaikh Version: $Revision: 1.1 $ $Date: 2003/12/24 12:41:39 $ ConstructorsXMLGeneratorpublic XMLGenerator(java.lang.String[][] options) Default constructor. MethodsgenerateXMLpublic void generateXML(RootDoc rootDoc) Generates the xml tree. Parameters:rootDoc - the javadoc root. getXMLStreampublic java.io.InputStream getXMLStream() getXMLStringpublic java.lang.String getXMLString() Package com.aurigalogic.doclet.util Class SummaryUtil Utility class com.aurigalogic.doclet.utilClass Utiljava.lang.Object | +--com.aurigalogic.doclet.util.Util < Methods > public class Utilextends java.lang.Object Utility class Author: Khurshidali Shaikh Version: $Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $ MethodsreadFilepublic 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. writeFilepublic static void writeFile(java.lang.String path, java.lang.String content) Writes the given given text to the specified file. Package com.aurigalogic.doclet.writer Interface Summary DocWriter DocWriter interface. Class SummaryAbstractDocWriter Abstract doc writer. CssTreeBuilder This class parses the given css stream and builds a xml tree. FODocWriter This class is used for generating javadoc in FO format. MIFDocWriter MIF document writer. PCLDocWriter PCL document writer. PDFDocWriter PDF document generator. PSDocWriter Postscript document write. SVGDocWriter SVG document writer. com.aurigalogic.doclet.writerClass AbstractDocWriterjava.lang.Object | +--com.aurigalogic.doclet.writer.AbstractDocWriterAll Implemented Interfaces:DocWriterDirect Known Subclasses:FODocWriter < Fields > < Constructors > < Methods > public abstract class AbstractDocWriterextends java.lang.Objectimplements DocWriter Abstract doc writer. Author: Khurshidali Shaikh Version: $Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $ FieldsOUTPUT_HTMLprotected static final java.lang.String OUTPUT_HTML OUTPUT_XMLprotected static final java.lang.String OUTPUT_XML cssStreamprotected java.io.InputStream cssStream 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 ConstructorsAbstractDocWriterpublic AbstractDocWriter() MethodsdoTransformpublic 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 stream xslStream - the xsl stream outputStream - the output stream outputMethod - 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. 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() com.aurigalogic.doclet.writerClass CssTreeBuilderjava.lang.Object | +--com.aurigalogic.doclet.writer.CssTreeBuilder < Constructors > < Methods > public class CssTreeBuilderextends java.lang.Object This class parses the given css stream and builds a xml tree. Author: Khurshidali Shaikh Version: $Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $ ConstructorsCssTreeBuilderpublic 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 MethodsgetCssTreeFileUrlpublic java.lang.String getCssTreeFileUrl() Returns the path of the cssTree file Returns: the css tree file path com.aurigalogic.doclet.writerInterface DocWriter < Methods > public interface DocWriter DocWriter interface. Author: Khurshidali Shaikh Version: $Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $ MethodssetCssStreampublic 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. setXslStreampublic void setXslStream(java.io.InputStream xslStream) Sets the xsl stream. Parameters:xslStream - the xsl stream. writeDocpublic void writeDoc() Write the output document. com.aurigalogic.doclet.writerClass FODocWriterjava.lang.Object | +--AbstractDocWriter | +--com.aurigalogic.doclet.writer.FODocWriterAll Implemented Interfaces:DocWriterDirect Known Subclasses:PDFDocWriter < Constructors > < Methods > public class FODocWriterextends AbstractDocWriter This class is used for generating javadoc in FO format. Author: Khurshidali Shaikh Version: $Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $ ConstructorsFODocWriterpublic FODocWriter() MethodscreateFOprotected void createFO(java.io.InputStream xmlStream, java.io.OutputStream outputStream) throws java.lang.Exception Generates the fo document Parameters:in - the xml stream out - the fo output stream Throws:java.lang.Exception - in case of an error. writeDocpublic void writeDoc() throws java.lang.Exception Converts the given xml stream to fo and writes it to the output file. Overrides:writeDoc in class AbstractDocWriterThrows:java.lang.Exception - in case of an error. com.aurigalogic.doclet.writerClass MIFDocWriterjava.lang.Object | +--AbstractDocWriter | +--FODocWriter | +--PDFDocWriter | +--com.aurigalogic.doclet.writer.MIFDocWriterAll Implemented Interfaces:DocWriter < Constructors > < Methods > public class MIFDocWriterextends PDFDocWriter MIF document writer. Author: Khurshidali Shaikh Version: $Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $ ConstructorsMIFDocWriterpublic MIFDocWriter() MethodswriteDocpublic void writeDoc() throws java.lang.Exception Writes the javadoc output to the specified file. Overrides:writeDoc in class PDFDocWriterThrows:java.lang.Exception - in case of an error. com.aurigalogic.doclet.writerClass PCLDocWriterjava.lang.Object | +--AbstractDocWriter | +--FODocWriter | +--PDFDocWriter | +--com.aurigalogic.doclet.writer.PCLDocWriterAll Implemented Interfaces:DocWriter < Constructors > < Methods > public class PCLDocWriterextends PDFDocWriter PCL document writer. Author: Khurshidali Shaikh Version: $Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $ ConstructorsPCLDocWriterpublic PCLDocWriter() MethodswriteDocpublic void writeDoc() throws java.lang.Exception Writes the javadoc output to the specified file. Overrides:writeDoc in class PDFDocWriterThrows:java.lang.Exception - in case of an error. com.aurigalogic.doclet.writerClass PDFDocWriterjava.lang.Object | +--AbstractDocWriter | +--FODocWriter | +--com.aurigalogic.doclet.writer.PDFDocWriterAll Implemented Interfaces:DocWriterDirect Known Subclasses:MIFDocWriter, PCLDocWriter, PSDocWriter, SVGDocWriter < Constructors > < Methods > public class PDFDocWriterextends FODocWriter PDF document generator. Author: Khurshidali Shaikh Version: $Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $ ConstructorsPDFDocWriterpublic PDFDocWriter() MethodswriteDocpublic void writeDoc() throws java.lang.Exception Writes the javadoc output to the specified file. Overrides:writeDoc in class FODocWriterThrows:java.lang.Exception - in case of an error. 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 com.aurigalogic.doclet.writerClass PSDocWriterjava.lang.Object | +--AbstractDocWriter | +--FODocWriter | +--PDFDocWriter | +--com.aurigalogic.doclet.writer.PSDocWriterAll Implemented Interfaces:DocWriter < Constructors > < Methods > public class PSDocWriterextends PDFDocWriter Postscript document write. Author: Khurshidali Shaikh Version: $Revision: 1.1.1.1 $ $Date: 2003/12/24 12:38:12 $ ConstructorsPSDocWriterpublic PSDocWriter()