io.fixprotocol.orchestra.docgen

Class DocGenerator

java.lang.Object

io.fixprotocol.orchestra.docgen.DocGenerator

public class DocGenerator
extends Object

Author:

Don Mendelson

Constructor Summary

Constructors

Constructor and Description
DocGenerator(InputStream inputStream, String outputRootDir, PrintStream errorStream) Constructs a DocGenerator

Method Summary

Modifier and Type	Method and Description
void	generate() Generates documentation
static void	main(String[] args) Generates documentation

Methods inherited from class java.lang.Object

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

Constructor Detail

DocGenerator

public DocGenerator(InputStream inputStream,
                    String outputRootDir,
                    PrintStream errorStream)

Constructs a DocGenerator

Parameters:

inputStream - input Orchestra file

outputRootDir - root of file system to write documentation files. If the path ends in .zip, then a zip archive is created. If the path contains temp, then a temporary file is created.

errorStream - output stream for errors

Method Detail

main

public static void main(String[] args)
                 throws Exception

Generates documentation

Parameters:

args - command line arguments

1. Name of an Orchestra input file.
2. URI of root output directory. It will be created if it does not exist. Defaults to file:./doc. If the URI path ends in .zip, then a zip archive is created. If the URI path contains temp, then a temporary file is created.
3. Path of error file. If not provided, outputs to System.err

Throws:

JAXBException - if XML file unmarshalling fails

IOException - if input file is not found or cannot be read

Exception

generate

public void generate()
              throws Exception

Generates documentation

Throws:

Exception - if input cannot be read or output cannot be written to a file