Package org.apache.juneau.httppart

Class HttpPartSchema.Builder

java.lang.Object
org.apache.juneau.httppart.HttpPartSchema.Builder
Enclosing class:
HttpPartSchema
public static class HttpPartSchema.Builder extends Object
Builder class.

  • Constructor Details

  • Method Details

    • build

      public HttpPartSchema build()
      Instantiates a new HttpPartSchema object based on the configuration of this builder.

      This method can be called multiple times to produce new schema objects.

      Returns:
      A new HttpPartSchema object.
      Never null.

    • apply

      public HttpPartSchema.Builder apply(Annotation a)
      Apply the specified annotation to this schema.
      Parameters:
      a - The annotation to apply.
      Returns:
      This object.

    • name

      public HttpPartSchema.Builder name(String value)
      name field.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • n

      public HttpPartSchema.Builder n(String value)
      Synonym for name(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • codes

      public HttpPartSchema.Builder codes(int[] value)
      httpStatusCode key.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if null or an empty array.
      Returns:
      This object.

    • code

      public HttpPartSchema.Builder code(int value)
      httpStatusCode key.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is 0.
      Returns:
      This object.

    • required

      public HttpPartSchema.Builder required(Boolean value)
      required field.

      Determines whether the parameter is mandatory.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • r

      public HttpPartSchema.Builder r(Boolean value)
      Synonym for required(Boolean).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • required

      public HttpPartSchema.Builder required(String value)
      required field.

      Determines whether the parameter is mandatory.

      Same as required(Boolean) but takes in a boolean value as a string.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • r

      public HttpPartSchema.Builder r(String value)
      Synonym for required(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • required

      public HttpPartSchema.Builder required()
      required field.

      Shortcut for calling required(true);.

      Returns:
      This object.

    • r

      public HttpPartSchema.Builder r()
      Synonym for required().
      Returns:
      This object.

    • type

      public HttpPartSchema.Builder type(String value)
      type field.

      The type of the parameter.

      If the type is not specified, it will be auto-detected based on the parameter class type.

      Applicable to the following Swagger schema objects:

      • "string"
        Parameter must be a string or a POJO convertible from a string.
      • "number"
        Parameter must be a number primitive or number object.
        If parameter is Object, creates either a Float or Double depending on the size of the number.
      • "integer"
        Parameter must be a integer/long primitive or integer/long object.
        If parameter is Object, creates either a Short, Integer, or Long depending on the size of the number.
      • "boolean"
        Parameter must be a boolean primitive or object.
      • "array"
        Parameter must be an array or collection.
        Elements must be strings or POJOs convertible from strings.
        If parameter is Object, creates an JsonList.
      • "object"
        Parameter must be a map or bean.
        If parameter is Object, creates an JsonMap.
        Note that this is an extension of the OpenAPI schema as Juneau allows for arbitrarily-complex POJOs to be serialized as HTTP parts.
      • "file"
        This type is currently not supported.
      See Also:
      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • t

      public HttpPartSchema.Builder t(String value)
      Synonym for type(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • tString

      public HttpPartSchema.Builder tString()
      Shortcut for type(HttpPartDataType.STRING).
      Returns:
      This object.

    • tNumber

      public HttpPartSchema.Builder tNumber()
      Shortcut for type(HttpPartDataType.NUMBER).
      Returns:
      This object.

    • tInteger

      public HttpPartSchema.Builder tInteger()
      Shortcut for type(HttpPartDataType.INTEGER).
      Returns:
      This object.

    • tBoolean

      public HttpPartSchema.Builder tBoolean()
      Shortcut for type(HttpPartDataType.BOOLEAN).
      Returns:
      This object.

    • tArray

      public HttpPartSchema.Builder tArray()
      Shortcut for type(HttpPartDataType.ARRAY).
      Returns:
      This object.

    • tObject

      public HttpPartSchema.Builder tObject()
      Shortcut for type(HttpPartDataType.OBJECT).
      Returns:
      This object.

    • tFile

      public HttpPartSchema.Builder tFile()
      Shortcut for type(HttpPartDataType.FILE).
      Returns:
      This object.

    • tNone

      public HttpPartSchema.Builder tNone()
      Shortcut for type(HttpPartDataType.NO_TYPE).
      Returns:
      This object.

    • type

      public HttpPartSchema.Builder type(HttpPartDataType value)
      type field.

      The type of the parameter.

      If the type is not specified, it will be auto-detected based on the parameter class type.

      Applicable to the following Swagger schema objects:

      • HttpPartDataType
        • STRING
          Parameter must be a string or a POJO convertible from a string.
        • NUMBER
          Parameter must be a number primitive or number object.
          If parameter is Object, creates either a Float or Double depending on the size of the number.
        • INTEGER
          Parameter must be a integer/long primitive or integer/long object.
          If parameter is Object, creates either a Short, Integer, or Long depending on the size of the number.
        • BOOLEAN
          Parameter must be a boolean primitive or object.
        • ARRAY
          Parameter must be an array or collection.
          Elements must be strings or POJOs convertible from strings.
          If parameter is Object, creates an JsonList.
        • OBJECT
          Parameter must be a map or bean.
          If parameter is Object, creates an JsonMap.
          Note that this is an extension of the OpenAPI schema as Juneau allows for arbitrarily-complex POJOs to be serialized as HTTP parts.
        • FILE
          This type is currently not supported.
      See Also:
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • t

      public HttpPartSchema.Builder t(HttpPartDataType value)
      Synonym for type(HttpPartDataType).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • format

      public HttpPartSchema.Builder format(String value)
      format field.

      The extending format for the previously mentioned parameter type.

      Applicable to the following Swagger schema objects:

      • "int32" - Signed 32 bits.
        Only valid with type "integer".
      • "int64" - Signed 64 bits.
        Only valid with type "integer".
      • "float" - 32-bit floating point number.
        Only valid with type "number".
      • "double" - 64-bit floating point number.
        Only valid with type "number".
      • "byte" - BASE-64 encoded characters.
        Only valid with type "string".
        Parameters of type POJO convertible from string are converted after the string has been decoded.
      • "binary" - Hexadecimal encoded octets (e.g. "00FF").
        Only valid with type "string".
        Parameters of type POJO convertible from string are converted after the string has been decoded.
      • "binary-spaced" - Hexadecimal encoded octets, spaced (e.g. "00 FF").
        Only valid with type "string".
        Parameters of type POJO convertible from string are converted after the string has been decoded.
      • "date" - An RFC3339 full-date.
        Only valid with type "string".
      • "date-time" - An RFC3339 date-time.
        Only valid with type "string".
      • "password" - Used to hint UIs the input needs to be obscured.
        This format does not affect the serialization or parsing of the parameter.
      • "uon" - UON notation (e.g. "(foo=bar,baz=@(qux,123))").
        Only valid with type "object".
        If not specified, then the input is interpreted as plain-text and is converted to a POJO directly.
      See Also:
      Parameters:
      value - The new value for this property.
      Ignored if value is null or an empty string.
      Returns:
      This object.

    • f

      public HttpPartSchema.Builder f(String value)
      Synonym for format(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • format

      public HttpPartSchema.Builder format(HttpPartFormat value)
      format field.

      The extending format for the previously mentioned parameter type.

      Applicable to the following Swagger schema objects:

          HttpPartFormat
          • INT32 - Signed 32 bits.
            Only valid with type "integer".
          • INT64 - Signed 64 bits.
            Only valid with type "integer".
          • FLOAT - 32-bit floating point number.
            Only valid with type "number".
          • DOUBLE - 64-bit floating point number.
            Only valid with type "number".
          • BYTE - BASE-64 encoded characters.
            Only valid with type "string".
            Parameters of type POJO convertible from string are converted after the string has been decoded.
          • BINARY - Hexadecimal encoded octets (e.g. "00FF").
            Only valid with type "string".
            Parameters of type POJO convertible from string are converted after the string has been decoded.
          • BINARY_SPACED - Hexadecimal encoded octets, spaced (e.g. "00 FF").
            Only valid with type "string".
            Parameters of type POJO convertible from string are converted after the string has been decoded.
          • DATE - An RFC3339 full-date.
            Only valid with type "string".
          • DATE_TIME - An RFC3339 date-time.
            Only valid with type "string".
          • PASSWORD - Used to hint UIs the input needs to be obscured.
            This format does not affect the serialization or parsing of the parameter.
          • UON - UON notation (e.g. "(foo=bar,baz=@(qux,123))").
            Only valid with type "object".
            If not specified, then the input is interpreted as plain-text and is converted to a POJO directly.
        See Also:
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • f

      public HttpPartSchema.Builder f(HttpPartFormat value)
      Synonym for format(HttpPartFormat).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • fInt32

      public HttpPartSchema.Builder fInt32()
      Shortcut for format(HttpPartFormat.INT32).
      Returns:
      This object.

    • fInt64

      public HttpPartSchema.Builder fInt64()
      Shortcut for format(HttpPartFormat.INT64).
      Returns:
      This object.

    • fFloat

      public HttpPartSchema.Builder fFloat()
      Shortcut for format(HttpPartFormat.FLOAT).
      Returns:
      This object.

    • fDouble

      public HttpPartSchema.Builder fDouble()
      Shortcut for format(HttpPartFormat.DOUBLE).
      Returns:
      This object.

    • fByte

      public HttpPartSchema.Builder fByte()
      Shortcut for format(HttpPartFormat.BYTE).
      Returns:
      This object.

    • fBinary

      public HttpPartSchema.Builder fBinary()
      Shortcut for format(HttpPartFormat.BINARY).
      Returns:
      This object.

    • fBinarySpaced

      public HttpPartSchema.Builder fBinarySpaced()
      Shortcut for format(HttpPartFormat.BINARY_SPACED).
      Returns:
      This object.

    • fDate

      public HttpPartSchema.Builder fDate()
      Shortcut for format(HttpPartFormat.DATE).
      Returns:
      This object.

    • fDateTime

      public HttpPartSchema.Builder fDateTime()
      Shortcut for format(HttpPartFormat.DATE_TIME).
      Returns:
      This object.

    • fPassword

      public HttpPartSchema.Builder fPassword()
      Shortcut for format(HttpPartFormat.PASSWORD).
      Returns:
      This object.

    • fUon

      public HttpPartSchema.Builder fUon()
      Shortcut for format(HttpPartFormat.UON).
      Returns:
      This object.

    • fNone

      public HttpPartSchema.Builder fNone()
      Shortcut for format(HttpPartFormat.NO_FORMAT).
      Returns:
      This object.

    • allowEmptyValue

      public HttpPartSchema.Builder allowEmptyValue(Boolean value)
      allowEmptyValue field.

      Sets the ability to pass empty-valued parameters.
      This is valid only for either query or formData parameters and allows you to send a parameter with a name only or an empty value.
      The default value is false.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • aev

      public HttpPartSchema.Builder aev(Boolean value)
      Synonym for allowEmptyValue(Boolean).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • allowEmptyValue

      public HttpPartSchema.Builder allowEmptyValue(String value)
      allowEmptyValue field.

      Same as allowEmptyValue(Boolean) but takes in a string boolean value.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • aev

      public HttpPartSchema.Builder aev(String value)
      Synonym for allowEmptyValue(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • allowEmptyValue

      public HttpPartSchema.Builder allowEmptyValue()
      allowEmptyValue field.

      Shortcut for calling allowEmptyValue(true);.

      Returns:
      This object.

    • aev

      public HttpPartSchema.Builder aev()
      Synonym for allowEmptyValue().
      Returns:
      This object.

    • items

      public HttpPartSchema.Builder items(HttpPartSchema.Builder value)
      items field.

      Describes the type of items in the array.

      Required if type is "array".
      Can only be used if type is "array".

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • i

      public HttpPartSchema.Builder i(HttpPartSchema.Builder value)
      Synonym for items(HttpPartSchema.Builder).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • items

      public HttpPartSchema.Builder items(HttpPartSchema value)
      items field.

      Describes the type of items in the array.

      Required if type is "array".
      Can only be used if type is "array".

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • i

      public HttpPartSchema.Builder i(HttpPartSchema value)
      Synonym for items(HttpPartSchema).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • collectionFormat

      public HttpPartSchema.Builder collectionFormat(String value)
      collectionFormat field.

      Determines the format of the array if type "array" is used.
      Can only be used if type is "array".

      Applicable to the following Swagger schema objects:

      Note that for collections/arrays parameters with POJO element types, the input is broken into a string array before being converted into POJO elements.

      • "csv" (default) - Comma-separated values (e.g. "foo,bar").
      • "ssv" - Space-separated values (e.g. "foo bar").
      • "tsv" - Tab-separated values (e.g. "foo\tbar").
      • "pipes - Pipe-separated values (e.g. "foo|bar").
      • "multi" - Corresponds to multiple parameter instances instead of multiple values for a single instance (e.g. "foo=bar&foo=baz").
      • "uon" - UON notation (e.g. "@(foo,bar)").
      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • cf

      public HttpPartSchema.Builder cf(String value)
      Synonym for collectionFormat(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • collectionFormat

      public HttpPartSchema.Builder collectionFormat(HttpPartCollectionFormat value)
      collectionFormat field.

      Determines the format of the array if type "array" is used.
      Can only be used if type is "array".

      Applicable to the following Swagger schema objects:

      Note that for collections/arrays parameters with POJO element types, the input is broken into a string array before being converted into POJO elements.

          HttpPartCollectionFormat
          • CSV (default) - Comma-separated values (e.g. "foo,bar").
          • SSV - Space-separated values (e.g. "foo bar").
          • TSV - Tab-separated values (e.g. "foo\tbar").
          • PIPES - Pipe-separated values (e.g. "foo|bar").
          • MULTI - Corresponds to multiple parameter instances instead of multiple values for a single instance (e.g. "foo=bar&foo=baz").
          • UONC - UON collection notation (e.g. "@(foo,bar)").
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • cf

      public HttpPartSchema.Builder cf(HttpPartCollectionFormat value)
      Synonym for collectionFormat(HttpPartCollectionFormat).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • cfCsv

      public HttpPartSchema.Builder cfCsv()
      Shortcut for collectionFormat(HttpPartCollectionFormat.CSV).
      Returns:
      This object.

    • cfSsv

      public HttpPartSchema.Builder cfSsv()
      Shortcut for collectionFormat(HttpPartCollectionFormat.SSV).
      Returns:
      This object.

    • cfTsv

      public HttpPartSchema.Builder cfTsv()
      Shortcut for collectionFormat(HttpPartCollectionFormat.TSV).
      Returns:
      This object.

    • cfPipes

      public HttpPartSchema.Builder cfPipes()
      Shortcut for collectionFormat(HttpPartCollectionFormat.PIPES).
      Returns:
      This object.

    • cfMulti

      public HttpPartSchema.Builder cfMulti()
      Shortcut for collectionFormat(HttpPartCollectionFormat.MULTI).
      Returns:
      This object.

    • cfUon

      public HttpPartSchema.Builder cfUon()
      Shortcut for collectionFormat(HttpPartCollectionFormat.UONC).
      Returns:
      This object.

    • cfNone

      public HttpPartSchema.Builder cfNone()
      Shortcut for collectionFormat(HttpPartCollectionFormat.NO_COLLECTION_FORMAT).
      Returns:
      This object.

    • _default

      public HttpPartSchema.Builder _default(String value)
      default field.

      Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request.
      (Note: "default" has no meaning for required parameters.)

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • df

      public HttpPartSchema.Builder df(String value)
      Synonym for _default(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • maximum

      public HttpPartSchema.Builder maximum(Number value)
      maximum field.

      Defines the maximum value for a parameter of numeric types.

      Only allowed for the following types: "integer", "number".

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • max

      public HttpPartSchema.Builder max(Number value)
      Synonym for maximum(Number).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • exclusiveMaximum

      public HttpPartSchema.Builder exclusiveMaximum(Boolean value)
      exclusiveMaximum field.

      Defines whether the maximum is matched exclusively.

      Only allowed for the following types: "integer", "number".
      If true, must be accompanied with maximum.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • emax

      public HttpPartSchema.Builder emax(Boolean value)
      Synonym for exclusiveMaximum(Boolean).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • exclusiveMaximum

      public HttpPartSchema.Builder exclusiveMaximum(String value)
      exclusiveMaximum field.

      Same as exclusiveMaximum(Boolean) but takes in a string boolean value.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • emax

      public HttpPartSchema.Builder emax(String value)
      Synonym for exclusiveMaximum(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • exclusiveMaximum

      public HttpPartSchema.Builder exclusiveMaximum()
      exclusiveMaximum field.

      Shortcut for calling exclusiveMaximum(true);.

      Returns:
      This object.

    • emax

      public HttpPartSchema.Builder emax()
      Synonym for exclusiveMaximum().
      Returns:
      This object.

    • minimum

      public HttpPartSchema.Builder minimum(Number value)
      minimum field.

      Defines the minimum value for a parameter of numeric types.

      Only allowed for the following types: "integer", "number".

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • min

      public HttpPartSchema.Builder min(Number value)
      Synonym for minimum(Number).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • exclusiveMinimum

      public HttpPartSchema.Builder exclusiveMinimum(Boolean value)
      exclusiveMinimum field.

      Defines whether the minimum is matched exclusively.

      Only allowed for the following types: "integer", "number".
      If true, must be accompanied with minimum.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • emin

      public HttpPartSchema.Builder emin(Boolean value)
      Synonym for exclusiveMinimum(Boolean).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • exclusiveMinimum

      public HttpPartSchema.Builder exclusiveMinimum(String value)
      exclusiveMinimum field.

      Same as exclusiveMinimum(Boolean) but takes in a string boolean value.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • emin

      public HttpPartSchema.Builder emin(String value)
      Synonym for exclusiveMinimum(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • exclusiveMinimum

      public HttpPartSchema.Builder exclusiveMinimum()
      exclusiveMinimum field.

      Shortcut for calling exclusiveMinimum(true);.

      Returns:
      This object.

    • emin

      public HttpPartSchema.Builder emin()
      Synonym for exclusiveMinimum().
      Returns:
      This object.

    • maxLength

      public HttpPartSchema.Builder maxLength(Long value)
      maxLength field.

      A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword.
      The length of a string instance is defined as the number of its characters as defined by RFC 4627.

      Only allowed for the following types: "string".

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or -1.
      Returns:
      This object.

    • maxl

      public HttpPartSchema.Builder maxl(Long value)
      Synonym for maxLength(Long).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • maxLength

      public HttpPartSchema.Builder maxLength(String value)
      maxLength field.

      Same as maxLength(Long) but takes in a string number.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • maxl

      public HttpPartSchema.Builder maxl(String value)
      Synonym for maxLength(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • minLength

      public HttpPartSchema.Builder minLength(Long value)
      minLength field.

      A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword.
      The length of a string instance is defined as the number of its characters as defined by RFC 4627.

      Only allowed for the following types: "string".

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or -1.
      Returns:
      This object.

    • minl

      public HttpPartSchema.Builder minl(Long value)
      Synonym for minLength(Long).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • minLength

      public HttpPartSchema.Builder minLength(String value)
      minLength field.

      Same as minLength(Long) but takes in a string number.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • minl

      public HttpPartSchema.Builder minl(String value)
      Synonym for minLength(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • pattern

      public HttpPartSchema.Builder pattern(String value)
      pattern field.

      A string input is valid if it matches the specified regular expression pattern.

      Only allowed for the following types: "string".

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • p

      public HttpPartSchema.Builder p(String value)
      Synonym for pattern(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • maxItems

      public HttpPartSchema.Builder maxItems(Long value)
      maxItems field.

      An array or collection is valid if its size is less than, or equal to, the value of this keyword.

      Only allowed for the following types: "array".

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or -1.
      Returns:
      This object.

    • maxi

      public HttpPartSchema.Builder maxi(Long value)
      Synonym for maxItems(Long).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • maxItems

      public HttpPartSchema.Builder maxItems(String value)
      maxItems field.

      Same as maxItems(Long) but takes in a string number.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • maxi

      public HttpPartSchema.Builder maxi(String value)
      Synonym for maxItems(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • minItems

      public HttpPartSchema.Builder minItems(Long value)
      minItems field.

      An array or collection is valid if its size is greater than, or equal to, the value of this keyword.

      Only allowed for the following types: "array".

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or -1.
      Returns:
      This object.

    • mini

      public HttpPartSchema.Builder mini(Long value)
      Synonym for minItems(Long).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • minItems

      public HttpPartSchema.Builder minItems(String value)
      minItems field.

      Same as minItems(Long) but takes in a string number.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • mini

      public HttpPartSchema.Builder mini(String value)
      Synonym for minItems(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • uniqueItems

      public HttpPartSchema.Builder uniqueItems(Boolean value)
      uniqueItems field.

      If true, the input validates successfully if all of its elements are unique.


      If the parameter type is a subclass of Set, this validation is skipped (since a set can only contain unique items anyway).
      Otherwise, the collection or array is checked for duplicate items.

      Only allowed for the following types: "array".

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • ui

      public HttpPartSchema.Builder ui(Boolean value)
      Synonym for uniqueItems(Boolean).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • uniqueItems

      public HttpPartSchema.Builder uniqueItems(String value)
      uniqueItems field.

      Same as uniqueItems(Boolean) but takes in a string boolean.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty..
      Returns:
      This object.

    • ui

      public HttpPartSchema.Builder ui(String value)
      Synonym for uniqueItems(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • uniqueItems

      public HttpPartSchema.Builder uniqueItems()
      uniqueItems field.

      Shortcut for calling uniqueItems(true);.

      Returns:
      This object.

    • ui

      public HttpPartSchema.Builder ui()
      Synonym for uniqueItems().
      Returns:
      This object.

    • skipIfEmpty

      public HttpPartSchema.Builder skipIfEmpty(Boolean value)
      skipIfEmpty field.

      Identifies whether an item should be skipped during serialization if it's empty.

      Parameters:
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • sie

      public HttpPartSchema.Builder sie(Boolean value)
      Synonym for skipIfEmpty(Boolean).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • skipIfEmpty

      public HttpPartSchema.Builder skipIfEmpty(String value)
      skipIfEmpty field.

      Same as skipIfEmpty(Boolean) but takes in a string boolean.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • sie

      public HttpPartSchema.Builder sie(String value)
      Synonym for skipIfEmpty(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • skipIfEmpty

      public HttpPartSchema.Builder skipIfEmpty()
      Identifies whether an item should be skipped if it's empty.

      Shortcut for calling skipIfEmpty(true);.

      Returns:
      This object.

    • sie

      public HttpPartSchema.Builder sie()
      Synonym for skipIfEmpty().
      Returns:
      This object.

    • _enum

      public HttpPartSchema.Builder _enum(Set<String> value)
      enum field.

      If specified, the input validates successfully if it is equal to one of the elements in this array.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or an empty set.
      Returns:
      This object.

    • e

      public HttpPartSchema.Builder e(Set<String> value)
      Synonym for _enum(Set).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • _enum

      public HttpPartSchema.Builder _enum(String... values)
      _enum field.

      Same as _enum(Set) but takes in a var-args array.

      Parameters:
      values - The new values for this property.
      Ignored if value is empty.
      Returns:
      This object.

    • e

      public HttpPartSchema.Builder e(String... values)
      Synonym for _enum(String...).
      Parameters:
      values - The new values for this property.
      Returns:
      This object.

    • multipleOf

      public HttpPartSchema.Builder multipleOf(Number value)
      multipleOf field.

      A numeric instance is valid if the result of the division of the instance by this keyword's value is an integer.

      Only allowed for the following types: "integer", "number".

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • mo

      public HttpPartSchema.Builder mo(Number value)
      Synonym for multipleOf(Number).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • maxProperties

      public HttpPartSchema.Builder maxProperties(Long value)
      mapProperties field.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or -1.
      Returns:
      This object.

    • maxp

      public HttpPartSchema.Builder maxp(Long value)
      Synonym for maxProperties(Long).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • maxProperties

      public HttpPartSchema.Builder maxProperties(String value)
      mapProperties field.

      Same as maxProperties(Long) but takes in a string number.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • maxp

      public HttpPartSchema.Builder maxp(String value)
      Synonym for maxProperties(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • minProperties

      public HttpPartSchema.Builder minProperties(Long value)
      minProperties field.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • minp

      public HttpPartSchema.Builder minp(Long value)
      Synonym for minProperties(Long).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • minProperties

      public HttpPartSchema.Builder minProperties(String value)
      minProperties field.

      Same as minProperties(Long) but takes in a string boolean.

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • minp

      public HttpPartSchema.Builder minp(String value)
      Synonym for minProperties(String).
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • property

      public HttpPartSchema.Builder property(String key, HttpPartSchema.Builder value)
      properties field.

      Applicable to the following Swagger schema objects:

      Parameters:
      key - The property name.
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • property

      public HttpPartSchema.Builder property(String key, HttpPartSchema value)
      properties field.

      Applicable to the following Swagger schema objects:

      Parameters:
      key - The property name.
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • p

      public HttpPartSchema.Builder p(String key, HttpPartSchema.Builder value)
      Shortcut for property(key, value).

      Applicable to the following Swagger schema objects:

      Parameters:
      key - The property name.
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • p

      public HttpPartSchema.Builder p(String key, HttpPartSchema value)
      Shortcut for property(key, value).

      Applicable to the following Swagger schema objects:

      Parameters:
      key - The property name.
      value - The new value for this property.
      Ignored if value is null.
      Returns:
      This object.

    • additionalProperties

      public HttpPartSchema.Builder additionalProperties(HttpPartSchema.Builder value)
      additionalProperties field.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • additionalProperties

      public HttpPartSchema.Builder additionalProperties(HttpPartSchema value)
      additionalProperties field.

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • ap

      public HttpPartSchema.Builder ap(HttpPartSchema.Builder value)
      Shortcut for additionalProperties(value)

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • ap

      public HttpPartSchema.Builder ap(HttpPartSchema value)
      Shortcut for additionalProperties(value)

      Applicable to the following Swagger schema objects:

      Parameters:
      value - The new value for this property.
      Ignored if value is null or empty.
      Returns:
      This object.

    • serializer

      public HttpPartSchema.Builder serializer(Class<? extends HttpPartSerializer> value)
      Identifies the part serializer to use for serializing this part.
      Parameters:
      value - The new value for this property.
      Ignored if value is null or HttpPartSerializer.Void.
      Returns:
      This object.

    • parser

      public HttpPartSchema.Builder parser(Class<? extends HttpPartParser> value)
      Identifies the part parser to use for parsing this part.
      Parameters:
      value - The new value for this property.
      Ignored if value is null or HttpPartParser.Void.
      Returns:
      This object.

    • noValidate

      public HttpPartSchema.Builder noValidate(Boolean value)
      Disables Swagger schema usage validation checking.
      Parameters:
      value - Specify true to prevent ContextRuntimeException from being thrown if invalid Swagger usage was detected.
      Returns:
      This object.

    • noValidate

      public HttpPartSchema.Builder noValidate()
      Disables Swagger schema usage validation checking.

      Shortcut for calling noValidate(true);.

      Returns:
      This object.