uk.co.real_logic.artio.dictionary.generation

Class SharedCodecConfiguration

java.lang.Object

uk.co.real_logic.artio.dictionary.generation.SharedCodecConfiguration

public final class SharedCodecConfiguration
extends java.lang.Object

Configuration object for setting shared dictionary generation configuration on.

Method Summary

Modifier and Type	Method and Description
SharedCodecConfiguration	splitDirectories(boolean splitDirectories) Sets whether to split the directory structure or not.
SharedCodecConfiguration	withDictionary(java.lang.String dictionaryName, boolean allowDuplicateFields, java.io.InputStream... fileStreams) Add a dictionary, using input streams, to the shared dictionaries.
SharedCodecConfiguration	withDictionary(java.lang.String dictionaryName, boolean allowDuplicateFields, java.lang.String... fileNames) Add a dictionary, using file names, to the shared dictionaries.
SharedCodecConfiguration	withDictionary(java.lang.String dictionaryName, java.io.InputStream... fileStreams) Add a dictionary, using input streams, to the shared dictionaries.
SharedCodecConfiguration	withDictionary(java.lang.String dictionaryName, java.lang.String... fileNames) Add a dictionary, using file names, to the shared dictionaries.

Methods inherited from class java.lang.Object

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

Method Detail

splitDirectories

public SharedCodecConfiguration splitDirectories(boolean splitDirectories)

Sets whether to split the directory structure or not. If true then each dictionary's Java source code will be generated into a separate directory, using the name of the dictionary as a suffix to the CodecConfiguration.outputPath(String). If false they will all be generated in CodecConfiguration.outputPath(String). Defaults to true.

Parameters:

splitDirectories - true to split the structure, false otherwise.

Returns:

this

withDictionary

public SharedCodecConfiguration withDictionary(java.lang.String dictionaryName,
                                               java.lang.String... fileNames)

Add a dictionary, using file names, to the shared dictionaries.

Parameters:

dictionaryName - the name to use for this dictionary.

fileNames - see CodecConfiguration.fileNames(String...) for details.

Returns:

this

withDictionary

public SharedCodecConfiguration withDictionary(java.lang.String dictionaryName,
                                               boolean allowDuplicateFields,
                                               java.lang.String... fileNames)

Add a dictionary, using file names, to the shared dictionaries.

Parameters:

dictionaryName - the name to use for this dictionary.

allowDuplicateFields - see CodecConfiguration.allowDuplicateFields(boolean) for details.

fileNames - see CodecConfiguration.fileNames(String...) for details.

Returns:

this

withDictionary

public SharedCodecConfiguration withDictionary(java.lang.String dictionaryName,
                                               java.io.InputStream... fileStreams)

Add a dictionary, using input streams, to the shared dictionaries.

Parameters:

dictionaryName - the name to use for this dictionary.

fileStreams - see CodecConfiguration.fileStreams(InputStream...) for details.

Returns:

this

withDictionary

public SharedCodecConfiguration withDictionary(java.lang.String dictionaryName,
                                               boolean allowDuplicateFields,
                                               java.io.InputStream... fileStreams)

Add a dictionary, using input streams, to the shared dictionaries.

Parameters:

dictionaryName - the name to use for this dictionary.

allowDuplicateFields - see CodecConfiguration.allowDuplicateFields(boolean) for details.

fileStreams - see CodecConfiguration.fileStreams(InputStream...) for details.

Returns:

this