Overview

jbirth has below five tools and Apache Ant interface.

Extractor
Extracting birthmarks from Java class files.
Comparator
Comparing birthmarks extracted by Extractor.
Configurator
Making config file of above two tools.
Counter
Counting the number of birthmark element.
Printer
Counting the number of birthmark element.
GUI
GUI interface of Extractor, Comparator, Configurator, Counter, and Printer.

Default interface is GUI.

Extractor

This tool extracts birthmarks from given arguments (class files included in given jar file, directory, or classpath) and store them to a bir file.

Usage: extractor [Options...] (directory|jarfile|classfile|classname|birfile)...

Options:
    --configure <CONFIG_FILE>   Config file of this tool.
 -b,--birthmark <BIRTHMARK>     Set birthmark extraction methods. default is ``all.''
                                Available extraction methods are: smc, emsmc, cvfv, is, uc, lvmp, all.
 -h,--help                      Print this message.
 -o,--output <FILE>             Set output file. Default is ``birthmarks.bir''
 -v,--verbose                   verbose mode Arguments:

Arguments:
  directory:  extract birthmarks from classes in this directory.
  jarfile:    extract birthmarks from classes which are included in this archive.
  classfile:  extract birthmark from this class.
  classname:  extract birthmark from this class search from CLASSPATH.
  birfile:    extract birthmarks from this bir file.

Comparator

This tool compares birthmarks each other after extracting by ``Extractor.''

usage: comparator [Options...] (directory|jarfile|classfile|classname|birfile)...

Options
    --configure <CONFIG_FILE>   Config file of this tool.
 -b,--birthmark <BIRTHMARK>     Set birthmark extraction methods. default is ``all.''
                                Available extraction methods are: smc, emsmc, cvfv, is, uc, lvmp, all.
 -h,--help                      Print this message.
 -o,--output <FILE>             Set output file. Default is ``<stdout>''.
 -v,--verbose                   verbose mode.

Arguments:
  directory:  extract birthmarks from classes in this directory.
  jarfile:    extract birthmarks from classes which are included in this archive.
  classfile:  extract birthmark from this class.
  classname:  extract birthmark from this class search from CLASSPATH.
  birfile:    extract birthmarks from this bir file.

Configurator

A tool of editing config file with GUI.

This tool has no options.

Screen shot

Big Image

GUI interface

GUI interface of above three tool.

This tool has no command line options.

screen shot

Big Image

Counter

This tool counts the number of elements of extracted birthmark.

usage: counter [Options...] (dir|jarfile|classfile|classname|birfile)...

Options:
    --configure <CONFIG_FILE>   Config file of this tool.
 -b,--birthmark <BIRTHMARK>     Set birthmark extraction methods. default is ``all.''
                                Available extraction methods are: smc, emsmc, cvfv, is, uc, lvmp, all.
 -h,--help                      Print this message.
 -o,--output <FILE>             Set output file. Default is ``<stdout>''.

 -h,--help                      print this message.
 -l,--license                   print the license of jbirth.
 -v,--verbose                   verbose mode.

Arguments:
  directory:  extract birthmarks from classes in this directory.
  jarfile:    extract birthmarks from classes which are included in this archive.
  classfile:  extract birthmark from this class.
  classname:  extract birthmark from this class search from CLASSPATH.
  birfile:    extract birthmarks from this bir file.

Printer

This tool prints elements of extracted birthmark.

usage: printer [Options...] (dir|jarfile|classfile|classname|birfile)...

Options:
    --configure <CONFIG_FILE>   Specified the basic configuration file.
 -b,--birthmark <BIRTHMARK>     Specified birthmark
 -h,--help                      Print this message
 -l,--license                   Print the license of jbirth
 -m,--mode <MODE>               Specified the running mode of jbirth.  The
                                value is available in memory, file, database.  Default is memory mod
e.
 -o,--output <FILE>             Specified the destination of result.
                                Default is ``<stdout>''.
 -v,--verbose                   verbose mode

Arguments:
  directory:  extract birthmarks from classes in this directory.
  jarfile:    extract birthmarks from classes which are included in this archive.
  classfile:  extract birthmark from this class.
  classname:  extract birthmark from this class search from CLASSPATH.
  birfile:    extract birthmarks from this bir file.

jbirth

Wrapper interface of above three tools.

Command line options of jbirth are following.

Usage: jbirth [Options...] (directory|jarfile|classfile|classname|birfile)...
Options:
    --gui:                      Run GUI interface.
                                Do not parse arguments and other options.
    --comparator:               Run birthmark extractor and comparator.
    --extractor:                Run birthmark extractor.
    --counter:                  Run birthmark elements counter.
    --edit-config:              Run configuration editing interface in GUI.
                                Do not parse arguments and other options.
    --help:                     Show this message.  If this option and 
                                comparator, extractor, or counter option are
                                specified together, you can see the detail 
                                help of specified tool.
    --license:                  Show the license of jbirth.

Other options depends each tools.
Each option are not specified, then gui option is applied.