org.springframework.beandoc.client
Class BeanDocClient

java.lang.Object
  extended by org.springframework.beandoc.client.BeanDocClient

public class BeanDocClient
extends Object

Command line client for the beandoc tool. Loads and runs a ContextProcessor with a default configuration. Accepts various command line arguments which must contain values for input resources and an output directory and can optionally contain other properties to further configure the default behaviour.

For total control and power consider supplying a context file location as this offers the ability to select which Decorators and Transformers are used in generating beandoc output. Alternatively, use the DefaultContextProcessor directly in code.

Since:
1.0
Author:
Darren Davison, Michael Schuerig,

Constructor Summary
BeanDocClient()
           
 
Method Summary
static void main(String[] args)
          Default boot strapper for the beandoc client.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BeanDocClient

public BeanDocClient()
Method Detail

main

public static void main(String[] args)
Default boot strapper for the beandoc client. Command line parameter should be the location of a properties file, either as a file pointer or as a classpath location. Any default Spring Resource strategy should work.

The properties file must contain values shown below in bold and can optionally contain any or none of the others.

input.filesone or more (comma or space separated) resources that will be used as input files for the beandoc tool. All input files are assumed to make a single application context or bean factory.

Possible values are:
classpath:/com/foo/bar/*.xml
file:///home/jdoe/file1.xml,file:///home/jdoe/file2.xml
output.dirthe directory (which must be writable for the current user) that output will be written to.
compiler.dotExe/usr/bin/dot
processor.validateFilesset to 'true' or 'false' to have the XML parser validate input files during parsing. True by default.
graphs.outputTypedefault is png (strongly recommended) but can be switched to gif, jpg or svg as desired

Parameters:
args - command line parameters using GNU style options..
  • --output [dir] - output directory
  • --properties [file] - the location of a properties file containing all mandatory and optional configuration properties for the beandoc tool.
  • --prefix [string] - the string that BeanDocClient should expect to find prefixing all beandoc properties.
  • --context [file] - a custom context file describing how to configure BeanDoc's dependencies. Power users only.
  • --help - print usage to stdout and quit.
  • [file1] [file2] [fileN] - input files


Copyright © 2004-2008 Spring BeanDoc. All Rights Reserved.