org.x4o.xml.eld.doc.api

Class ApiDocWriter

java.lang.Object

org.x4o.xml.eld.doc.api.ApiDocWriter

public class ApiDocWriter
extends Object

ApiDocWriter creates all output files for the ApiDoc.

Version:

1.0 May 1, 2013

Author:

Willem Cazander

Constructor Summary

Constructors

Constructor and Description
ApiDocWriter()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.x4o.xml.eld.doc.api.ApiDocContentWriter.NavBarConfig	createNavBarConfig(String pathPrefix, File frame, ApiDocContentWriter writer)
protected org.x4o.xml.eld.doc.api.ApiDocContentWriter.NavBarConfig	createNavBarConfig(String pathPrefix, String prev, String next, File frame, ApiDocContentWriter writer)
void	defaultWriteSummary(ApiDocNode node, ApiDocContentWriter writer)
void	defaultWriteTreePath(ApiDocNode node, ApiDocContentWriter writer)
void	write(ApiDoc doc, File basePath) Writes full api doc tree files to the base path.
void	writeAllFrameNav(boolean isFrame)
void	writeIndex()
void	writeOverviewFrame()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDocWriter

public ApiDocWriter()

Method Detail

write

public void write(ApiDoc doc,
         File basePath)
           throws IOException,
                  SAXException

Writes full api doc tree files to the base path.

Parameters:

doc - The ApiDoc to writer.

basePath - The bath path to write into.

Throws:

IOException - When file exception happens.

SAXException - when xml exception happens.

defaultWriteSummary

public void defaultWriteSummary(ApiDocNode node,
                       ApiDocContentWriter writer)
                         throws SAXException

Throws:

SAXException

defaultWriteTreePath

public void defaultWriteTreePath(ApiDocNode node,
                        ApiDocContentWriter writer)
                          throws SAXException

Throws:

SAXException

createNavBarConfig

protected org.x4o.xml.eld.doc.api.ApiDocContentWriter.NavBarConfig createNavBarConfig(String pathPrefix,
                                                                          File frame,
                                                                          ApiDocContentWriter writer)
                                                                               throws SAXException

Throws:

SAXException

createNavBarConfig

protected org.x4o.xml.eld.doc.api.ApiDocContentWriter.NavBarConfig createNavBarConfig(String pathPrefix,
                                                                          String prev,
                                                                          String next,
                                                                          File frame,
                                                                          ApiDocContentWriter writer)
                                                                               throws SAXException

Throws:

SAXException

writeIndex

public void writeIndex()
                throws SAXException

Throws:

SAXException

writeOverviewFrame

public void writeOverviewFrame()
                        throws SAXException

Throws:

SAXException

writeAllFrameNav

public void writeAllFrameNav(boolean isFrame)
                      throws SAXException

Throws:

SAXException