Package org.apache.juneau.urlencoding.annotation

Annotation Interface UrlEncodingConfig

@Target({TYPE,METHOD}) @Retention(RUNTIME) @Inherited @ContextApply({SerializerApply.class,ParserApply.class}) public @interface UrlEncodingConfig
Annotation for specifying config properties defined in UrlEncodingSerializer and UrlEncodingParser.

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

See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    expandedParams
    Parser bean property collections/arrays as separate key/value pairs.
    int
    rank
    Optional rank for this config.

  • 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

    • expandedParams

      String expandedParams
      Parser bean property collections/arrays as separate key/value pairs.

      This is the parser-side equivalent of the UrlEncodingSerializer.Builder.expandedParams() setting.

      If "false", serializing the array [1,2,3] results in ?key=$a(1,2,3).
      If "true", serializing the same array results in ?key=1&key=2&key=3.

      • "true"
      • "false" (default)
      Notes:
      • If parsing multi-part parameters, it's highly recommended to use Collections or Lists as bean property types instead of arrays since arrays have to be recreated from scratch every time a value is added to it.
      • This option only applies to beans.
      • Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").
      See Also:
      Returns:
      The annotation value.
      Default:
      ""