forked from aeron-io/simple-binary-encoding
-
Notifications
You must be signed in to change notification settings - Fork 1
Sbe Tool Guide
Martin Thompson edited this page Jan 26, 2014
·
8 revisions
The SBE tool is a command line utility that can be used to generate codecs and validate message declaration schemas. The tool is written in Java and can run as an executable JAR file, e.g:
java -jar sbe.jar <message-declarations-file.xml>
The tool will accept options using the system property option format as follows:
java -Doption=value -jar sbe.jar <message-declarations-file.xml>
The tool supports the following options:
-
sbe.validation.xsd
: Use XSD to validate or not. XSD filename should be the provided option. -
sbe.validation.stop.on.error
: Should the parser stop on first error encountered? Defaults to false. -
sbe.validation.warnings.fatal
: Are warnings in parsing considered fatal? Defaults to false. -
sbe.validation.suppress.output
: Should the parser suppress output during validation? Defaults to false. -
sbe.generate.stubs
: Generate stubs or not. Defaults to true. -
sbe.generate.ir
: Generate IR or not. Defaults to false. -
sbe.target.language
: Target language for code generation, defaults to Java(also supports). -
sbe.output.dir
: Target directory for output generation, defaults to current directory. -
sbe.target.namespace
: Namespace to be used for generated code. Equates package for Java. If not provided then thepackage
attribute from the schema will be used.