Package org.springdoc.core.fn.builders.parameter

Class Builder

java.lang.Object
org.springdoc.core.fn.builders.parameter.Builder
public class Builder extends Object
The type Parameter builder.
Author:
bnasslahsen

  • Method Details

    • parameterBuilder

      public static Builder parameterBuilder()
      Builder parameter builder.
      Returns:
      the parameter builder

    • name

      public Builder name(String name)
      Name parameter builder.
      Parameters:
      name - the name
      Returns:
      the parameter builder

    • in

      public Builder in(io.swagger.v3.oas.annotations.enums.ParameterIn in)
      In parameter builder.
      Parameters:
      in - the in
      Returns:
      the parameter builder

    • description

      public Builder description(String description)
      Description parameter builder.
      Parameters:
      description - the description
      Returns:
      the parameter builder

    • required

      public Builder required(boolean required)
      Required parameter builder.
      Parameters:
      required - the required
      Returns:
      the parameter builder

    • deprecated

      public Builder deprecated(boolean deprecated)
      Deprecated parameter builder.
      Parameters:
      deprecated - the deprecated
      Returns:
      the parameter builder

    • allowEmptyValue

      public Builder allowEmptyValue(boolean allowEmptyValue)
      Allow empty value parameter builder.
      Parameters:
      allowEmptyValue - the allow empty value
      Returns:
      the parameter builder

    • style

      public Builder style(io.swagger.v3.oas.annotations.enums.ParameterStyle style)
      Style parameter builder.
      Parameters:
      style - the style
      Returns:
      the parameter builder

    • explode

      public Builder explode(io.swagger.v3.oas.annotations.enums.Explode explode)
      Explode parameter builder.
      Parameters:
      explode - the explode
      Returns:
      the parameter builder

    • allowReserved

      public Builder allowReserved(boolean allowReserved)
      Allow reserved parameter builder.
      Parameters:
      allowReserved - the allow reserved
      Returns:
      the parameter builder

    • schema

      public Builder schema(Builder schemaBuilder)
      Schema parameter builder.
      Parameters:
      schemaBuilder - the schema builder
      Returns:
      the parameter builder

    • array

      public Builder array(Builder arraySchemaBuilder)
      Array parameter builder.
      Parameters:
      arraySchemaBuilder - the array schema builder
      Returns:
      the parameter builder

    • implementationArray

      public Builder implementationArray(Class clazz)
      Implementation array parameter builder.
      Parameters:
      clazz - the clazz
      Returns:
      the parameter builder

    • implementation

      public Builder implementation(Class clazz)
      Implementation parameter builder.
      Parameters:
      clazz - the clazz
      Returns:
      the parameter builder

    • content

      public Builder content(Builder contentBuilder)
      Content parameter builder.
      Parameters:
      contentBuilder - the content builder
      Returns:
      the parameter builder

    • hidden

      public Builder hidden(boolean hidden)
      Hidden parameter builder.
      Parameters:
      hidden - the hidden
      Returns:
      the parameter builder

    • examples

      public Builder examples(Builder exampleObjectBuilder)
      Examples parameter builder.
      Parameters:
      exampleObjectBuilder - the example object builder
      Returns:
      the parameter builder

    • example

      public Builder example(String example)
      Example parameter builder.
      Parameters:
      example - the example
      Returns:
      the parameter builder

    • extensions

      public Builder extensions(Builder extensionBuilder)
      Extensions parameter builder.
      Parameters:
      extensionBuilder - the extension builder
      Returns:
      the parameter builder

    • ref

      public Builder ref(String ref)
      Ref parameter builder.
      Parameters:
      ref - the ref
      Returns:
      the parameter builder

    • build

      public io.swagger.v3.oas.annotations.Parameter build()
      Build parameter.
      Returns:
      the parameter