uk.co.real_logic.sbe.generation.java

Class JavaUtil

java.lang.Object

uk.co.real_logic.sbe.generation.java.JavaUtil

public class JavaUtil
extends java.lang.Object

Utilities for mapping between IR and the Java language.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaUtil.Separators

Constructor Summary

Constructors

Constructor and Description
JavaUtil()

Method Summary

Modifier and Type	Method and Description
static void	append(java.lang.StringBuilder builder, java.lang.String indent, java.lang.String line) Shortcut to append a line of generated code
static java.lang.String	charset(java.lang.String encoding) Code to fetch an instance of Charset corresponding to the given encoding.
static java.lang.String	formatClassName(java.lang.String value) Format a class name for the generated code.
static java.lang.String	formatPropertyName(java.lang.String value) Format a property name for generated code.
static java.lang.String	generateFlyweightPropertyJavadoc(java.lang.String indent, Token propertyToken, java.lang.String typeName) Generate the Javadoc comment header for flyweight property.
static java.lang.String	generateGroupEncodePropertyJavadoc(java.lang.String indent, Token propertyToken, java.lang.String typeName) Generate the Javadoc comment header for group encode property.
static java.lang.String	generateLiteral(PrimitiveType type, java.lang.String value) Generate a literal value to be used in code generation.
static java.lang.String	generateOptionDecodeJavadoc(java.lang.String indent, Token optionToken) Generate the Javadoc comment header for a bitset choice option decode method.
static java.lang.String	generateOptionEncodeJavadoc(java.lang.String indent, Token optionToken) Generate the Javadoc comment header for a bitset choice option encode method.
static java.lang.String	generateTypeJavadoc(java.lang.String indent, Token typeToken) Generate the Javadoc comment header for a type.
static java.lang.String	javaTypeName(PrimitiveType primitiveType) Map the name of a PrimitiveType to a Java primitive type name.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaUtil

public JavaUtil()

Method Detail

javaTypeName

public static java.lang.String javaTypeName(PrimitiveType primitiveType)

Map the name of a PrimitiveType to a Java primitive type name.

Parameters:

primitiveType - to map.

Returns:

the name of the Java primitive that most closely maps.

formatPropertyName

public static java.lang.String formatPropertyName(java.lang.String value)

Format a property name for generated code.

If the formatted property name is a keyword then SbeTool.KEYWORD_APPEND_TOKEN is appended if set.

Parameters:

value - to be formatted.

Returns:

the string formatted as a property name.

Throws:

java.lang.IllegalStateException - if a keyword and SbeTool.KEYWORD_APPEND_TOKEN is not set.

formatClassName

public static java.lang.String formatClassName(java.lang.String value)

Format a class name for the generated code.

Parameters:

value - to be formatted.

Returns:

the string formatted as a class name.

append

public static void append(java.lang.StringBuilder builder,
                          java.lang.String indent,
                          java.lang.String line)

Shortcut to append a line of generated code

Parameters:

builder - string builder to which to append the line

indent - current text indentation

line - line to be appended

charset

public static java.lang.String charset(java.lang.String encoding)

Code to fetch an instance of Charset corresponding to the given encoding.

Parameters:

encoding - as a string name (eg. UTF-8).

Returns:

the code to fetch the associated Charset.

generateLiteral

public static java.lang.String generateLiteral(PrimitiveType type,
                                               java.lang.String value)

Generate a literal value to be used in code generation.

Parameters:

type - of the lateral value.

value - of the lateral.

Returns:

a String representation of the Java literal.

generateTypeJavadoc

public static java.lang.String generateTypeJavadoc(java.lang.String indent,
                                                   Token typeToken)

Generate the Javadoc comment header for a type.

Parameters:

indent - level for the comment.

typeToken - for the type.

Returns:

a string representation of the Javadoc comment.

generateOptionDecodeJavadoc

public static java.lang.String generateOptionDecodeJavadoc(java.lang.String indent,
                                                           Token optionToken)

Generate the Javadoc comment header for a bitset choice option decode method.

Parameters:

indent - level for the comment.

optionToken - for the type.

Returns:

a string representation of the Javadoc comment.

generateOptionEncodeJavadoc

public static java.lang.String generateOptionEncodeJavadoc(java.lang.String indent,
                                                           Token optionToken)

Generate the Javadoc comment header for a bitset choice option encode method.

Parameters:

indent - level for the comment.

optionToken - for the type.

Returns:

a string representation of the Javadoc comment.

generateFlyweightPropertyJavadoc

public static java.lang.String generateFlyweightPropertyJavadoc(java.lang.String indent,
                                                                Token propertyToken,
                                                                java.lang.String typeName)

Generate the Javadoc comment header for flyweight property.

Parameters:

indent - level for the comment.

propertyToken - for the property name.

typeName - for the property type.

Returns:

a string representation of the Javadoc comment.

generateGroupEncodePropertyJavadoc

public static java.lang.String generateGroupEncodePropertyJavadoc(java.lang.String indent,
                                                                  Token propertyToken,
                                                                  java.lang.String typeName)

Generate the Javadoc comment header for group encode property.

Parameters:

indent - level for the comment.

propertyToken - for the property name.

typeName - for the property type.

Returns:

a string representation of the Javadoc comment.