uk.co.real_logic.artio.dictionary.generation

Class Generator

java.lang.Object

uk.co.real_logic.artio.dictionary.generation.Generator

public abstract class Generator
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Deque<Aggregate>	aggregateStack
static java.lang.String	BEGIN_STRING
static java.lang.String	BODY_LENGTH
static java.lang.String	CODEC_REJECT_UNKNOWN_FIELD_ENABLED
static java.lang.String	CODEC_VALIDATION_ENABLED
protected java.lang.String	codecRejectUnknownEnumValueEnabled
protected Dictionary	dictionary
protected boolean	fixTagsInJavadoc
protected boolean	flyweightsEnabled
static java.lang.String	MESSAGE_FIELDS
static java.lang.String	MSG_TYPE
static java.util.regex.Pattern	NEWLINE
protected org.agrona.generation.OutputManager	outputManager
protected java.lang.Class<?>	rejectUnknownFieldClass
static java.lang.String	RUNTIME_REJECT_UNKNOWN_ENUM_VALUE_PROPERTY
protected java.lang.String	scope
protected java.lang.String	thisPackage
protected java.lang.Class<?>	validationClass

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Generator(Dictionary dictionary, java.lang.String thisPackage, java.lang.String commonPackage, org.agrona.generation.OutputManager outputManager, java.lang.Class<?> validationClass, java.lang.Class<?> rejectUnknownFieldClass, java.lang.Class<?> rejectUnknownEnumValueClass, boolean flyweightsEnabled, java.lang.String codecRejectUnknownEnumValueEnabled, boolean fixTagsInJavadoc)

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	appendToChecksHasGetter(Entry entry, Field field)
protected java.lang.String	commonCompoundImports(java.lang.String form, boolean headerWrapsTrailer, java.lang.String messageFieldsSet)
protected java.lang.String	completeResetMethod(boolean isMessage, java.util.List<Entry> entries, java.lang.String additionalReset, boolean isInParent)
protected abstract java.lang.String	componentAppendTo(Component component)
protected abstract java.lang.String	dataAppendTo(Field field, java.lang.String fieldName)
protected java.lang.String	fieldAppendTo(Field field)
void	generate()
protected java.lang.String	generateAccessorJavadoc(Field field)
protected abstract void	generateAggregateFile(Aggregate aggregate, uk.co.real_logic.artio.dictionary.generation.AggregateType type)
protected java.lang.String	generateAppendTo(Aggregate aggregate, boolean hasCommonCompounds)
protected java.lang.String	generateEntryAppendTo(Entry entry)
protected void	generateImports(java.lang.String compoundSuffix, uk.co.real_logic.artio.dictionary.generation.AggregateType type, java.io.Writer out, java.lang.Class<?>... extraImports)
protected abstract java.lang.String	groupEntryAppendTo(Group element, java.lang.String name)
protected java.lang.String	hasField(Entry entry)
protected abstract boolean	hasFlag(Entry entry, Field field)
protected java.lang.String	hasGetter(java.lang.String name)
protected java.lang.String	indent(int times, java.lang.String suffix)
protected boolean	isBeginString(Entry entry)
protected boolean	isBodyLength(Entry entry)
protected boolean	isBodyLength(java.lang.String name)
protected boolean	isCheckSum(Entry entry)
protected java.lang.String	nameOfResetMethod(java.lang.String name)
protected abstract java.lang.String	optionalReset(Field field, java.lang.String name)
protected java.lang.String	resetAllBy(java.util.List<Entry> entries, java.lang.StringBuilder methods, java.util.function.Predicate<Entry> predicate, java.util.function.Function<Entry,java.lang.String> methodFactory, java.util.function.Function<Entry,java.lang.String> callFactory)
protected java.lang.String	resetByFlag(java.lang.String name)
protected abstract java.lang.String	resetComponents(java.util.List<Entry> entries, java.lang.StringBuilder methods)
protected java.lang.String	resetEntries(java.util.List<Entry> entries, java.lang.StringBuilder methods)
protected java.lang.String	resetFieldValue(Field field, java.lang.String resetValue)
protected abstract java.lang.String	resetGroup(Entry entry)
protected java.lang.String	resetLength(java.lang.String name)
protected java.lang.String	resetNothing(java.lang.String name)
protected abstract java.lang.String	resetRequiredFloat(java.lang.String name)
protected abstract java.lang.String	resetRequiredInt(Field field)
protected abstract java.lang.String	resetRequiredLong(Field field)
protected abstract java.lang.String	resetStringBasedData(java.lang.String name)
protected abstract java.lang.String	resetTemporalValue(java.lang.String name)
protected abstract java.lang.String	stringAppendTo(java.lang.String fieldName)
protected abstract java.lang.String	timeAppendTo(java.lang.String fieldName)
protected abstract java.lang.Class<?>	topType(uk.co.real_logic.artio.dictionary.generation.AggregateType aggregateType)

Methods inherited from class java.lang.Object

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

Field Detail

MSG_TYPE

public static final java.lang.String MSG_TYPE

See Also:

Constant Field Values

BEGIN_STRING

public static final java.lang.String BEGIN_STRING

See Also:

Constant Field Values

BODY_LENGTH

public static final java.lang.String BODY_LENGTH

See Also:

Constant Field Values

CODEC_VALIDATION_ENABLED

public static final java.lang.String CODEC_VALIDATION_ENABLED

See Also:

Constant Field Values

CODEC_REJECT_UNKNOWN_FIELD_ENABLED

public static final java.lang.String CODEC_REJECT_UNKNOWN_FIELD_ENABLED

See Also:

Constant Field Values

RUNTIME_REJECT_UNKNOWN_ENUM_VALUE_PROPERTY

public static final java.lang.String RUNTIME_REJECT_UNKNOWN_ENUM_VALUE_PROPERTY

See Also:

Constant Field Values

NEWLINE

public static final java.util.regex.Pattern NEWLINE

MESSAGE_FIELDS

public static final java.lang.String MESSAGE_FIELDS

See Also:

Constant Field Values

dictionary

protected final Dictionary dictionary

thisPackage

protected final java.lang.String thisPackage

outputManager

protected final org.agrona.generation.OutputManager outputManager

validationClass

protected final java.lang.Class<?> validationClass

rejectUnknownFieldClass

protected final java.lang.Class<?> rejectUnknownFieldClass

flyweightsEnabled

protected final boolean flyweightsEnabled

codecRejectUnknownEnumValueEnabled

protected final java.lang.String codecRejectUnknownEnumValueEnabled

scope

protected final java.lang.String scope

fixTagsInJavadoc

protected final boolean fixTagsInJavadoc

aggregateStack

protected final java.util.Deque<Aggregate> aggregateStack

Constructor Detail

Generator

protected Generator(Dictionary dictionary,
                    java.lang.String thisPackage,
                    java.lang.String commonPackage,
                    org.agrona.generation.OutputManager outputManager,
                    java.lang.Class<?> validationClass,
                    java.lang.Class<?> rejectUnknownFieldClass,
                    java.lang.Class<?> rejectUnknownEnumValueClass,
                    boolean flyweightsEnabled,
                    java.lang.String codecRejectUnknownEnumValueEnabled,
                    boolean fixTagsInJavadoc)

Method Detail

commonCompoundImports

protected java.lang.String commonCompoundImports(java.lang.String form,
                                                 boolean headerWrapsTrailer,
                                                 java.lang.String messageFieldsSet)

generate

public void generate()

generateAggregateFile

protected abstract void generateAggregateFile(Aggregate aggregate,
                                              uk.co.real_logic.artio.dictionary.generation.AggregateType type)

topType

protected abstract java.lang.Class<?> topType(uk.co.real_logic.artio.dictionary.generation.AggregateType aggregateType)

generateImports

protected void generateImports(java.lang.String compoundSuffix,
                               uk.co.real_logic.artio.dictionary.generation.AggregateType type,
                               java.io.Writer out,
                               java.lang.Class<?>... extraImports)
                        throws java.io.IOException

Throws:

java.io.IOException

completeResetMethod

protected java.lang.String completeResetMethod(boolean isMessage,
                                               java.util.List<Entry> entries,
                                               java.lang.String additionalReset,
                                               boolean isInParent)

resetEntries

protected java.lang.String resetEntries(java.util.List<Entry> entries,
                                        java.lang.StringBuilder methods)

resetAllBy

protected java.lang.String resetAllBy(java.util.List<Entry> entries,
                                      java.lang.StringBuilder methods,
                                      java.util.function.Predicate<Entry> predicate,
                                      java.util.function.Function<Entry,java.lang.String> methodFactory,
                                      java.util.function.Function<Entry,java.lang.String> callFactory)

resetGroup

protected abstract java.lang.String resetGroup(Entry entry)

resetRequiredInt

protected abstract java.lang.String resetRequiredInt(Field field)

resetRequiredLong

protected abstract java.lang.String resetRequiredLong(Field field)

optionalReset

protected abstract java.lang.String optionalReset(Field field,
                                                  java.lang.String name)

resetTemporalValue

protected abstract java.lang.String resetTemporalValue(java.lang.String name)

resetComponents

protected abstract java.lang.String resetComponents(java.util.List<Entry> entries,
                                                    java.lang.StringBuilder methods)

resetStringBasedData

protected abstract java.lang.String resetStringBasedData(java.lang.String name)

nameOfResetMethod

protected java.lang.String nameOfResetMethod(java.lang.String name)

hasField

protected java.lang.String hasField(Entry entry)

resetNothing

protected java.lang.String resetNothing(java.lang.String name)

resetRequiredFloat

protected abstract java.lang.String resetRequiredFloat(java.lang.String name)

resetLength

protected java.lang.String resetLength(java.lang.String name)

resetByFlag

protected java.lang.String resetByFlag(java.lang.String name)

resetFieldValue

protected java.lang.String resetFieldValue(Field field,
                                           java.lang.String resetValue)

generateAppendTo

protected java.lang.String generateAppendTo(Aggregate aggregate,
                                            boolean hasCommonCompounds)

generateEntryAppendTo

protected java.lang.String generateEntryAppendTo(Entry entry)

appendToChecksHasGetter

protected abstract boolean appendToChecksHasGetter(Entry entry,
                                                   Field field)

groupEntryAppendTo

protected abstract java.lang.String groupEntryAppendTo(Group element,
                                                       java.lang.String name)

hasFlag

protected abstract boolean hasFlag(Entry entry,
                                   Field field)

hasGetter

protected java.lang.String hasGetter(java.lang.String name)

componentAppendTo

protected abstract java.lang.String componentAppendTo(Component component)

fieldAppendTo

protected java.lang.String fieldAppendTo(Field field)

timeAppendTo

protected abstract java.lang.String timeAppendTo(java.lang.String fieldName)

dataAppendTo

protected abstract java.lang.String dataAppendTo(Field field,
                                                 java.lang.String fieldName)

isCheckSum

protected boolean isCheckSum(Entry entry)

isBodyLength

protected boolean isBodyLength(Entry entry)

isBeginString

protected boolean isBeginString(Entry entry)

isBodyLength

protected boolean isBodyLength(java.lang.String name)

stringAppendTo

protected abstract java.lang.String stringAppendTo(java.lang.String fieldName)

indent

protected java.lang.String indent(int times,
                                  java.lang.String suffix)

generateAccessorJavadoc

protected java.lang.String generateAccessorJavadoc(Field field)