de.smartics.exceptions.cli
Class Main

java.lang.Object
  de.smartics.exceptions.cli.Main

public class Main
     
     

      
      extends 
      
      Object
     
     

Runs the report generator.

Author:

Robert Reiner

Field Summary

static String	CSS_FILE The link reference to the CSS file to add to the head element of the generated HTML document.
static String	JAVA_CLASS_PATH The semicolon separated class root directories.
static String	JAVA_SOURCE_ENCODING The encoding of the Java source files.
static String	JAVA_SOURCE_PATH The semicolon separated source root directories.
static String	PROJECT_NAME The name of the project to collect information for.
static String	REPORT_ENCODING The encoding of the report documentation.
static String	REPORT_EXCLUDES The semicolon separated excluded directories.
static String	REPORT_FILE The name of the report file to write.
static String	REPORT_GENERATOR The class name of the report generator instance to use.
static String	REPORT_INCLUDES The semicolon separated included directories.

Constructor Summary

Main()
Default constructor.

Method Summary

static void	main(String... args) Launches the program.
void	run(de.smartics.report.conf.ProjectConfiguration<XMLStreamWriter> config) Delegates call to run(ProjectConfiguration,XMLStreamWriter) .
void	run(de.smartics.report.conf.ProjectConfiguration<XMLStreamWriter> configuration, XMLStreamWriter output) Runs the reporting with the given configuration and writer.
int	run(String... args) Runs with system properties.

Methods inherited from class java.lang.Object

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

Field Detail

PROJECT_NAME

public static final String PROJECT_NAME

The name of the project to collect information for.

The value of this constant is "project-name".

Constant Field Value:

"project-name"

REPORT_FILE

public static final String REPORT_FILE

The name of the report file to write.

The value of this constant is "report-file".

Constant Field Value:

"report-file"

REPORT_GENERATOR

public static final String REPORT_GENERATOR

The class name of the report generator instance to use.

The value of this constant is "report-generator".

Constant Field Value:

"report-generator"

REPORT_ENCODING

public static final String REPORT_ENCODING

The encoding of the report documentation.

The value of this constant is "report-encoding".

Constant Field Value:

"report-encoding"

REPORT_EXCLUDES

public static final String REPORT_EXCLUDES

The semicolon separated excluded directories. Use Ant syntax.

The value of this constant is "report-excludes".

Constant Field Value:

"report-excludes"

REPORT_INCLUDES

public static final String REPORT_INCLUDES

The semicolon separated included directories. Use Ant syntax.

The value of this constant is "report-includes".

Constant Field Value:

"report-includes"

JAVA_SOURCE_ENCODING

public static final String JAVA_SOURCE_ENCODING

The encoding of the Java source files.

The value of this constant is "java-source-encoding".

Constant Field Value:

"java-source-encoding"

JAVA_SOURCE_PATH

public static final String JAVA_SOURCE_PATH

The semicolon separated source root directories.

The value of this constant is "java-source-path".

Constant Field Value:

"java-source-path"

JAVA_CLASS_PATH

public static final String JAVA_CLASS_PATH

The semicolon separated class root directories. If this is set, the default class path specified by java.class.path will not be used. The default class path is used if this property is not specified.

The value of this constant is "java-class-path".

Constant Field Value:

"java-class-path"

CSS_FILE

public static final String CSS_FILE

The link reference to the CSS file to add to the head element of the generated HTML document.

The value of this constant is "css-file".

Constant Field Value:

"css-file"

Constructor Detail

Main

public Main()

Default constructor.

Method Detail

run

public int run(String... args)
        throws de.smartics.report.ReportException

Runs with system properties. See constants in this class for options.

Throws:

de.smartics.report.ReportException - ReportException on any problem generating the report.

org.apache.commons.cli.ParseException

See Also:

de.smartics.exceptions.report.Main#run(de.smartics.exceptions.report.core.ExceptionCodeProjectConfiguration)

run

public void run(de.smartics.report.conf.ProjectConfiguration<XMLStreamWriter> config)
         throws de.smartics.report.ReportException

Delegates call to run(ProjectConfiguration,XMLStreamWriter) .

Parameters:

config - the configuration to control the discovery process.

Throws:

de.smartics.report.ReportException - on any problem generating the report.

See Also:

run(ProjectConfiguration,XMLStreamWriter)

run

public void run(de.smartics.report.conf.ProjectConfiguration<XMLStreamWriter> configuration,
                XMLStreamWriter output)
         throws de.smartics.report.ReportException

Runs the reporting with the given configuration and writer.

Parameters:

configuration - the configuration to control the discovery process.

output - the writer to write to. This overrules the report file in the configuration. If the writer is null the report file is required to be set.

Throws:

de.smartics.report.ReportException - on any problem generating the report.

main

public static void main(String... args)
                 throws Exception,
                        de.smartics.report.ReportException

Launches the program.

Parameters:

args - the program arguments.

Throws:

IOException - on any problem reading from or writing to streams.

de.smartics.report.ReportException - on any problem generating the report.

Exception