uk.co.real_logic.sbe

Class SbeTool

java.lang.Object

uk.co.real_logic.sbe.SbeTool

public class SbeTool
extends Object

A tool for running the SBE parser, validator, and code generator. Usage:

     $ java -jar sbe.jar <filename.xml>
     $ java -Doption=value -jar sbe.jar <filename.xml>
     $ java -Doption=value -jar sbe.jar <filename.sbeir>
 

Properties

• sbe.validation.xsd: Use XSD to validate or not.
• 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.
• sbe.output.dir: Target directory for code generation, defaults to current directory.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GENERATE_IR Boolean system property to turn on or off generation of IR.
static String	GENERATE_STUBS Boolean system property to turn on or off generation of stubs.
static String	OUTPUT_DIR Output directory for generated code
static String	TARGET_LANGUAGE Target language for generated code.
static String	TARGET_NAMESPACE String system property of the namespace for generated code.
static String	VALIDATION_STOP_ON_ERROR Boolean system property to control throwing exceptions on all errors
static String	VALIDATION_SUPPRESS_OUTPUT Boolean system property to control suppressing output on all errors and warnings
static String	VALIDATION_WARNINGS_FATAL Boolean system property to control whether to consider warnings fatal and treat them as errors
static String	VALIDATION_XSD System property to hold XSD to validate message specification against

Constructor Summary

Constructors

Constructor and Description
SbeTool()

Method Summary

Modifier and Type	Method and Description
static void	generate(Ir ir, String outputDirName, String targetLanguage) Generate SBE encoding and decoding stubs for a target language.
static void	main(String[] args) Main entry point for the SBE Tool.
static MessageSchema	parseSchema(String sbeSchemaFilename) Parse the message schema specification.
static void	validateAgainstSchema(String sbeSchemaFilename, String xsdFilename) Validate the SBE Schema against the XSD.

Methods inherited from class java.lang.Object

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

Field Detail

VALIDATION_STOP_ON_ERROR

public static final String VALIDATION_STOP_ON_ERROR

Boolean system property to control throwing exceptions on all errors

See Also:

Constant Field Values

VALIDATION_WARNINGS_FATAL

public static final String VALIDATION_WARNINGS_FATAL

Boolean system property to control whether to consider warnings fatal and treat them as errors

See Also:

Constant Field Values

VALIDATION_XSD

public static final String VALIDATION_XSD

System property to hold XSD to validate message specification against

See Also:

Constant Field Values

VALIDATION_SUPPRESS_OUTPUT

public static final String VALIDATION_SUPPRESS_OUTPUT

Boolean system property to control suppressing output on all errors and warnings

See Also:

Constant Field Values

GENERATE_STUBS

public static final String GENERATE_STUBS

Boolean system property to turn on or off generation of stubs. Defaults to true.

See Also:

Constant Field Values

GENERATE_IR

public static final String GENERATE_IR

Boolean system property to turn on or off generation of IR. Defaults to false.

See Also:

Constant Field Values

TARGET_LANGUAGE

public static final String TARGET_LANGUAGE

Target language for generated code.

See Also:

Constant Field Values

OUTPUT_DIR

public static final String OUTPUT_DIR

Output directory for generated code

See Also:

Constant Field Values

TARGET_NAMESPACE

public static final String TARGET_NAMESPACE

String system property of the namespace for generated code.

See Also:

Constant Field Values

Constructor Detail

SbeTool

public SbeTool()

Method Detail

main

public static void main(String[] args)
                 throws Exception

Main entry point for the SBE Tool.

Parameters:

args - command line arguments. A single filename is expected.

Throws:

Exception - if an error occurs during process of the message schema.

validateAgainstSchema

public static void validateAgainstSchema(String sbeSchemaFilename,
                                         String xsdFilename)
                                  throws Exception

Validate the SBE Schema against the XSD.

Parameters:

sbeSchemaFilename - to be validated

xsdFilename - XSD against which to validate

Throws:

Exception - if an error occurs while validating

parseSchema

public static MessageSchema parseSchema(String sbeSchemaFilename)
                                 throws Exception

Parse the message schema specification.

Parameters:

sbeSchemaFilename - file containing the SBE specification for the

Returns:

the parsed MessageSchema for the specification found in the file.

Throws:

Exception - if an error occurs when parsing the specification.

generate

public static void generate(Ir ir,
                            String outputDirName,
                            String targetLanguage)
                     throws Exception

Generate SBE encoding and decoding stubs for a target language.

Parameters:

ir - for the parsed specification.

outputDirName - directory into which code will be generated.

targetLanguage - for the generated code.

Throws:

Exception - if an error occurs while generating the code.