Package org.apache.juneau.marshall.urlencoding

Class UrlEncodingParser.Builder

java.lang.Object
org.apache.juneau.marshall.Context.Builder<SELF>
org.apache.juneau.marshall.MarshallingContextable.Builder<SELF>
org.apache.juneau.marshall.parser.Parser.Builder<SELF>
org.apache.juneau.marshall.parser.ReaderParser.Builder<SELF>
org.apache.juneau.marshall.uon.UonParser.Builder<UrlEncodingParser.Builder>
org.apache.juneau.marshall.urlencoding.UrlEncodingParser.Builder
Enclosing class:
UrlEncodingParser
public static class UrlEncodingParser.Builder extends UonParser.Builder<UrlEncodingParser.Builder>
Builder class.

  • Constructor Details

    • Builder

      protected Builder()
      Constructor, default settings.

    • Builder

      protected Builder(UrlEncodingParser.Builder copyFrom)
      Copy constructor.
      Parameters:
      copyFrom - The builder to copy from.
      Cannot be null.

    • Builder

      protected Builder(UrlEncodingParser copyFrom)
      Copy constructor.
      Parameters:
      copyFrom - The bean to copy from.
      Cannot be null.

  • Method Details

    • build

      public UrlEncodingParser build()
      Description copied from class: Context.Builder
      Build the object.
      Overrides:
      build in class UonParser.Builder<UrlEncodingParser.Builder>
      Returns:
      The built object.

    • copy

      public UrlEncodingParser.Builder copy()
      Description copied from class: Context.Builder
      Copy creator.
      Specified by:
      copy in class UonParser.Builder<UrlEncodingParser.Builder>
      Returns:
      A new mutable copy of this builder.

    • expandedParams

      public UrlEncodingParser.Builder expandedParams()
      Serialize 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.

      Example:

      public class MyBean { public String[] f1; public List<String> f2; } UrlEncodingParser parser1 = UrlEncodingParser.DEFAULT; UrlEncodingParser parser2 = UrlEncodingParser.create().expandedParams().build(); MyBean myBean1 = parser1.read("f1=@(a,b)&f2=@(c,d)", A.class); MyBean myBean2 = parser2.read("f1=a&f1=b&f2=c&f2=d", A.class);

      This option only applies to beans.

      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.
      Returns:
      This object.

    • expandedParams

      public UrlEncodingParser.Builder expandedParams(boolean value)
      Same as expandedParams() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • hashKey

      public HashKey hashKey()
      Description copied from class: Context.Builder
      Returns the hashkey of this builder.

      Used to return previously instantiated context beans that have matching hashkeys. The HashKey object is suitable for use as a hashmap key of a map of context beans. A context bean is considered equivalent if the HashKey.equals(Object) method is the same.

      Overrides:
      hashKey in class UonParser.Builder<UrlEncodingParser.Builder>
      Returns:
      The hashkey of this builder.