Package org.apache.juneau.uon.annotation

Annotation Interface UonConfig

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

Annotation for specifying config properties defined in UonSerializer and UonParser.

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

See Also:

• UON Basics

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	addBeanTypes	Add "_type" properties when needed.
String	decoding	Decode "%xx" sequences.
String	encoding	Encode non-valid URI characters.
String	paramFormat	Format to use for query/form-data/header values.
int	rank	Optional rank for this config.
String	validateEnd	Validate end.

Element Details

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

decoding

String decoding

Decode "%xx" sequences.

Specify "true" if URI encoded characters should be decoded, "false" if they've already been decoded before being passed to this parser.

• "true" (default for UrlEncodingParser)
• "false" (default for UonParser)

Notes:

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

See Also:

• UonParser.Builder.decoding()

Returns:

The annotation value.

Default:

""

validateEnd

String validateEnd

Validate end.

If "true", after parsing a POJO from the input, verifies that the remaining input in the stream consists of only comments or whitespace.

• "true"
• "false" (default)

Notes:

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

See Also:

• UonParser.Builder.validateEnd()

Returns:

The annotation value.

Default:

""

addBeanTypes

String addBeanTypes

Add "_type" properties when needed.

If "true", then "_type" properties will be added to beans if their type cannot be inferred through reflection.

When present, this value overrides the Serializer.Builder.addBeanTypes() setting and is provided to customize the behavior of specific serializers in a SerializerSet.

• "true"
• "false" (default)

Notes:

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

See Also:

• UonSerializer.Builder.addBeanTypesUon()

Returns:

The annotation value.

Default:

""

encoding

String encoding

Encode non-valid URI characters.

Encode non-valid URI characters with "%xx" constructs.

If "true", non-valid URI characters will be converted to "%xx" sequences.
Set to "false" if parameter value is being passed to some other code that will already perform URL-encoding of non-valid URI characters.

• "true" (default for UrlEncodingSerializer)
• "false" (default for UonSerializer)

Notes:

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

See Also:

• UonSerializer.Builder.encoding()

Returns:

The annotation value.

Default:

""

paramFormat

String paramFormat

Format to use for query/form-data/header values.

Specifies the format to use for URL GET parameter keys and values.

• "UON" (default) - Use UON notation for parameters.
• "PLAINTEXT" - Use plain text for parameters.

Notes:

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

See Also:

• UonSerializer.Builder.paramFormat(ParamFormat)

Returns:

The annotation value.

Default:

""