org.apache.juneau.uon.annotation

Annotation Type UonConfig

@Documented
 @Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
 @Inherited
 @PropertyStoreApply(value=UonConfigApply.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.

Optional Element Summary

Optional Elements

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

Element Detail

rank

public abstract int rank

Optional rank for this config.

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

Default:

0

decoding

public abstract String decoding

Configuration property: 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.

• Possible values:
  • "true"
  • "false"
• The default is "false" for UonParser, "true" for UrlEncodingParser.
• Supports Default SVL Variables (e.g. "$C{myConfigVar}").
• A default global value can be set via the system property "UonParser.decoding.b".

• UonParser.UON_decoding

Default:

""

validateEnd

public abstract String validateEnd

Configuration property: 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.

• Possible values:
  • "true"
  • "false" (default)
• Supports Default SVL Variables (e.g. "$C{myConfigVar}").
• A default global value can be set via the system property "UonParser.validateEnd.b".

• UonParser.UON_validateEnd

Default:

""

addBeanTypes

public abstract String addBeanTypes

Configuration property: 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.SERIALIZER_addBeanTypes setting and is provided to customize the behavior of specific serializers in a SerializerGroup.

• Possible values:
  • "true"
  • "false" (default)
• Supports Default SVL Variables (e.g. "$C{myConfigVar}").
• A default global value can be set via the system property "UonSerializer.addBeanTypes.b".

• UonSerializer.UON_addBeanTypes

Default:

""

encoding

public abstract String encoding

Configuration property: 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.

Possible values:

• "true"
• "false"

• Possible values:
  • "true"
  • "false"
• The default is "false" for UonSerializer, "true" for UrlEncodingSerializer.
• Supports Default SVL Variables (e.g. "$C{myConfigVar}").
• A default global value can be set via the system property "UonSerializer.encoding.b".

• UonSerializer.UON_encoding

Default:

""

paramFormat

public abstract String paramFormat

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

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

• Possible values:
  • "UON" (default) - Use UON notation for parameters.
  • "PLAINTEXT" - Use plain text for parameters.
• Supports Default SVL Variables (e.g. "$C{myConfigVar}").
• A default global value can be set via the system property "UonSerializer.paramFormat.s".

• UonSerializer.UON_paramFormat

Default:

""