uk.co.real_logic.artio.dictionary.generation

Class CodecConfiguration

java.lang.Object

uk.co.real_logic.artio.dictionary.generation.CodecConfiguration

public final class CodecConfiguration
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FIX_TAGS_IN_JAVADOC
static java.lang.String	DEFAULT_PARENT_PACKAGE
static java.lang.String	FIX_CODECS_ALLOW_DUPLICATE_FIELDS_PROPERTY Boolean system property to turn on or off duplicated fields validation.
static java.lang.String	FIX_TAGS_IN_JAVADOC
static java.lang.String	FLYWEIGHTS_ENABLED_PROPERTY
static java.lang.String	PARENT_PACKAGE_PROPERTY
static java.lang.String	REJECT_UNKNOWN_ENUM_VALUE_PROPERTY
static java.lang.String	WRAP_EMPTY_BUFFER Boolean system property to avoid throwing when an optional string field is unset.

Constructor Summary

Constructors

Constructor and Description
CodecConfiguration()

Method Summary

Modifier and Type	Method and Description
CodecConfiguration	allowDuplicateFields(boolean allowDuplicateFields) Allow duplicate fields.
CodecConfiguration	codecRejectUnknownEnumValueEnabled(java.lang.String codecRejectUnknownEnumValueEnabled) String representing a Java expressions that evaluates to a boolean within the codec that states whether an unknown enum value within a codec should be rejected or not.
CodecConfiguration	fileNames(java.lang.String... fileNames) Provide the XML file, or files, that are used to generate the Dictionaries.
CodecConfiguration	fileStreams(java.io.InputStream... fileStreams) Provide the XML document, or documents, that are used to generate the Dictionaries as instance of InputStream.
boolean	fixTagsInJavadoc()
CodecConfiguration	fixTagsInJavadoc(boolean fixTagsInJavadoc) Sets whether to generate javadoc tags with the FIX tags in.
CodecConfiguration	flyweightsEnabled(boolean flyweightsEnabled)
uk.co.real_logic.artio.dictionary.generation.GeneratorDictionaryConfiguration	nonSharedDictionary()
CodecConfiguration	outputPath(java.lang.String outputPath) Sets the output path where codecs are generated.
CodecConfiguration	parentPackage(java.lang.String parentPackage) Sets the parent package where classes are generated.
SharedCodecConfiguration	sharedCodecsEnabled() Enable the generation of shared codecs.
CodecConfiguration	wrapEmptyBuffer(boolean wrapEmptyBuffer) Suppresses checks for the presence of optional string fields (i.e.

Methods inherited from class java.lang.Object

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

Field Detail

FIX_CODECS_ALLOW_DUPLICATE_FIELDS_PROPERTY

public static final java.lang.String FIX_CODECS_ALLOW_DUPLICATE_FIELDS_PROPERTY

Boolean system property to turn on or off duplicated fields validation. Defaults to false.

Fix specification vol 1: A tag number (field) should only appear in a message once. If it appears more than once in the message it should be considered an error with the specification document.

Turning this option on may break parsing: this option should be used for support fix specification with error only. It is recommended, where possible, to correct your FIX XML file instead of using this option in order to support an invalid XML file.
The duplicated fields is allowed in the following case:

 message body:
 field;
 repeating group:
 the_other_field+
 field;
 

See Also:

Constant Field Values

WRAP_EMPTY_BUFFER

public static final java.lang.String WRAP_EMPTY_BUFFER

Boolean system property to avoid throwing when an optional string field is unset.

This is useful to call getters accepting an AsciiSequenceView without checking whether the field is set.

See Also:

Constant Field Values

PARENT_PACKAGE_PROPERTY

public static final java.lang.String PARENT_PACKAGE_PROPERTY

See Also:

Constant Field Values

FLYWEIGHTS_ENABLED_PROPERTY

public static final java.lang.String FLYWEIGHTS_ENABLED_PROPERTY

See Also:

Constant Field Values

REJECT_UNKNOWN_ENUM_VALUE_PROPERTY

public static final java.lang.String REJECT_UNKNOWN_ENUM_VALUE_PROPERTY

See Also:

Constant Field Values

FIX_TAGS_IN_JAVADOC

public static final java.lang.String FIX_TAGS_IN_JAVADOC

See Also:

Constant Field Values

DEFAULT_PARENT_PACKAGE

public static final java.lang.String DEFAULT_PARENT_PACKAGE

See Also:

Constant Field Values

DEFAULT_FIX_TAGS_IN_JAVADOC

public static final java.lang.String DEFAULT_FIX_TAGS_IN_JAVADOC

See Also:

Constant Field Values

Constructor Detail

CodecConfiguration

public CodecConfiguration()

Method Detail

outputPath

public CodecConfiguration outputPath(java.lang.String outputPath)

Sets the output path where codecs are generated. This should be a valid path on your local filesystem where the codec generator has the ability to write files. Required. If this doesn't already exist it will be created.

Parameters:

outputPath - the output path where codecs are generated

Returns:

this

parentPackage

public CodecConfiguration parentPackage(java.lang.String parentPackage)

Sets the parent package where classes are generated. Optional, defaults to DEFAULT_PARENT_PACKAGE. Different parent packages can be used to use multiple different fix dictionary versions, see the wiki for details.

Parameters:

parentPackage - the parent package where classes are generated.

Returns:

this

flyweightsEnabled

public CodecConfiguration flyweightsEnabled(boolean flyweightsEnabled)

wrapEmptyBuffer

public CodecConfiguration wrapEmptyBuffer(boolean wrapEmptyBuffer)

Suppresses checks for the presence of optional string fields (i.e. no exception is thrown when unset, instead the AsciiSequenceView wraps an empty buffer). Defaults to the value of WRAP_EMPTY_BUFFER system property.

Parameters:

wrapEmptyBuffer - true to suppress check of optional strings, false to keep checking (default)

Returns:

this

allowDuplicateFields

public CodecConfiguration allowDuplicateFields(boolean allowDuplicateFields)

Allow duplicate fields. Executable documentation can be found in the test "DuplicateFieldsTest". Defaults to the value of FIX_CODECS_ALLOW_DUPLICATE_FIELDS_PROPERTY if set. Can be overridden for individual dictionaries in shared codec mode using SharedCodecConfiguration.withDictionary(String, boolean, String...) and SharedCodecConfiguration.withDictionary(String, boolean, InputStream...). If not overridden then shared codecs default to this value.

Parameters:

allowDuplicateFields - true to enable, false to disable

Returns:

this

fileNames

public CodecConfiguration fileNames(java.lang.String... fileNames)

Provide the XML file, or files, that are used to generate the Dictionaries. Multiple dictionary files can be used to provide split data and transport XML files as used by FIX 5.0 / FIXT. If you want to generate a shared dictionary then please use SharedCodecConfiguration.withDictionary(String, boolean, String...) method and not this one. fileStreams(InputStream...) is an alternative configuration option that lets you provide inputstreams as the source of your XML files.

Parameters:

fileNames - the file names to use as sources of XML documents

Returns:

this

fileStreams

public CodecConfiguration fileStreams(java.io.InputStream... fileStreams)

Provide the XML document, or documents, that are used to generate the Dictionaries as instance of InputStream. Multiple dictionary files can be used to provide split data and transport XML files as used by FIX 5.0 / FIXT. If you want to generate a shared dictionary then please use SharedCodecConfiguration.withDictionary(String, boolean, InputStream...) method and not this one. fileNames(String...) is an alternative configuration option that lets you provide file names as the source of your XML files.

Parameters:

fileStreams - the file streams to use as sources of XML documents

Returns:

this

codecRejectUnknownEnumValueEnabled

public CodecConfiguration codecRejectUnknownEnumValueEnabled(java.lang.String codecRejectUnknownEnumValueEnabled)

String representing a Java expressions that evaluates to a boolean within the codec that states whether an unknown enum value within a codec should be rejected or not. Evaluation to true rejects. This could be a constant value or a reference to some other Java code that evaluates to a boolean. For example "true" or "ExternalConfigClass.REJECT_UNKNOWN_ENUM".

Parameters:

codecRejectUnknownEnumValueEnabled - the String

Returns:

this

sharedCodecsEnabled

public SharedCodecConfiguration sharedCodecsEnabled()

Enable the generation of shared codecs. This returns an object upon which configuration options can be set.

Returns:

the shared codec configuration object

fixTagsInJavadoc

public CodecConfiguration fixTagsInJavadoc(boolean fixTagsInJavadoc)

Sets whether to generate javadoc tags with the FIX tags in. Defaults to true. Can be configured via properties using -Dfix.codecs.tags_in_javadoc=false.

Parameters:

fixTagsInJavadoc - true to generate javadoc tags with the FIX tags in.

Returns:

this

nonSharedDictionary

public uk.co.real_logic.artio.dictionary.generation.GeneratorDictionaryConfiguration nonSharedDictionary()

fixTagsInJavadoc

public boolean fixTagsInJavadoc()