openbook.tools.converter

Class SourceRenderer

java.lang.Object

openbook.tools.converter.SourceRenderer

Direct Known Subclasses:

Java2HTMLConverter, Java2TextConverter

public abstract class SourceRenderer
extends Object

Renders Java Source Code.

Author:

Pinaki Poddar

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_DIRECTORY
static String	DOT
static char	FORWARD_SLASH

Constructor Summary

Constructors

Constructor and Description
SourceRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
abstract TokenRenderer	createRenderer(CommandProcessor options, File outFile)
File	getDestinationDirectory()
protected InputStream	getInputStream(File srcDir, String path) Gets the input stream.
File	getSourceDirectory()
abstract void	registerOptions(CommandProcessor options)
protected void	run(String[] args) Renders the given source files.
protected void	verbose(String s)
protected void	warn(String s)

Methods inherited from class java.lang.Object

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

Field Detail

FORWARD_SLASH

public static final char FORWARD_SLASH

See Also:

Constant Field Values

DOT

public static final String DOT

See Also:

Constant Field Values

CURRENT_DIRECTORY

public static final String CURRENT_DIRECTORY

See Also:

Constant Field Values

Constructor Detail

SourceRenderer

public SourceRenderer()

Method Detail

run

protected final void run(String[] args)
                  throws Exception

Renders the given source files. The syntax of the command is

  $ java SourceRenderer [options] files 

For example,

 $ java SourceRenderer -stylesheet mystyle.css -sourcepath test
  -d generated/html acme/foo/SomeClass.java

Recognized options are

-format	the format of the converted output. Recognized monikers are html and text. A fully qualified class name that implements TokenRenderer is allowed. Default is html
-sourcepath	the root of the source files. Default is the current directory
-d	the root of the generated files. Default is the current directory

Besides these options, a renderer can accept more options. Any option -someProperty will configure the renderer if a bean-style setter method setSomeProperty(String|boolean|int) is available. See available documentation on the specific renderer.
Stylesheet file must be under destination directory.

-stylesheet

is relative to destination directory.

Parameters:

args - command-line arguments.

Throws:

Exception

getDestinationDirectory

public File getDestinationDirectory()

getSourceDirectory

public File getSourceDirectory()

registerOptions

public abstract void registerOptions(CommandProcessor options)

createRenderer

public abstract TokenRenderer createRenderer(CommandProcessor options,
                           File outFile)

getInputStream

protected InputStream getInputStream(File srcDir,
                         String path)

Gets the input stream.

Parameters:

srcDir - the root source directory.

path - the path to input file.

verbose

protected void verbose(String s)

warn

protected void warn(String s)