Package org.apache.juneau.marshall.toml

Annotation Interface TomlConfig

@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Inherited
@ContextApply({SerializerApply.class,ParserApply.class})
public @interface TomlConfig

Annotation for specifying config properties defined in TomlSerializer and TomlParser.

Used primarily for specifying bean configuration properties on REST classes and methods.

Example:

@TomlConfig(sortKeys="true", inlineTableThreshold="5", nullValue="~") public class MyRestClass {}

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	inlineTableThreshold	Maximum number of properties for a table to be written in inline-table format.
String	nullValue	String written for null values; the parser treats values matching this string as null.
int	rank	Optional rank for this config.
String	sortKeys	Sort keys alphabetically in output.
String	useInlineTables	Use inline tables when possible.

Element Details

nullValue

String nullValue

String written for null values; the parser treats values matching this string as null.

An empty value (the default) leaves the builder default of "<NULL>" in place. Applied to both TomlSerializer and TomlParser.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• TomlSerializer.Builder.nullValue(String)
• TomlParser.Builder.nullValue(String)

Returns:

The annotation value.

Default:

""

inlineTableThreshold

String inlineTableThreshold

Maximum number of properties for a table to be written in inline-table format.

An empty value (the default) leaves the builder default in place.

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• TomlSerializer.Builder.inlineTableThreshold(int)

Returns:

The annotation value.

Default:

""

useInlineTables

String useInlineTables

Use inline tables when possible.

• "true"
• "false"

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• TomlSerializer.Builder.useInlineTables(boolean)

Returns:

The annotation value.

Default:

""

sortKeys

String sortKeys

Sort keys alphabetically in output.

• "true"
• "false"

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• TomlSerializer.Builder.sortKeys(boolean)

Returns:

The annotation value.

Default:

""

rank

int rank

Optional rank for this config.

Can be used to override default ordering and application of config annotations.

Returns:

The annotation value.

Default:

0