Package org.apache.juneau.marshall.urlencoding

Annotation Interface UrlEncoding

@Documented
@Target({TYPE,FIELD,METHOD})
@Retention(RUNTIME)
@Inherited
public @interface UrlEncoding

Annotation that can be applied to classes, fields, and methods to tweak how they are handled by UrlEncodingSerializer and UrlEncodingParser.

Can be used in the following locations:

• Marshalled classes/methods/fields.
• @Rest-annotated classes and @RestOp-annotated methods when used with @UrlEncodingApply.

See Also:

• URL-Encoding

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	description	Optional description for the exposed API.
boolean	expandedParams	When true, bean properties of type array or Collection will be expanded into multiple key/value pairings.

Element Details

description

String[] description

Optional description for the exposed API.

Returns:

The annotation value.

Since:

9.2.0

Default:

{}

expandedParams

boolean expandedParams

When true, bean properties of type array or Collection will be expanded into multiple key/value pairings.

This annotation is identical in behavior to using the UrlEncodingSerializer.Builder.expandedParams() and UrlEncodingParser.Builder.expandedParams() properties, but applies to only instances of this bean.

Returns:

The annotation value.

Default:

false