Package org.springdoc.core.fn.builders.schema

Class Builder

  • public class Builder
extends Object
    The type Schema builder.
    Author:
    bnasslahsen

    • Method Detail

      • schemaBuilder

        public static Builder schemaBuilder()
        Builder schema builder.
        Returns:
        the schema builder

      • implementation

        public Builder implementation​(Class<?> implementation)
        Implementation schema builder.
        Parameters:
        implementation - the implementation
        Returns:
        the schema builder

      • not

        public Builder not​(Class<?> not)
        Not schema builder.
        Parameters:
        not - the not
        Returns:
        the schema builder

      • oneOf

        public Builder oneOf​(Class<?>[] oneOf)
        One of schema builder.
        Parameters:
        oneOf - the one of
        Returns:
        the schema builder

      • anyOf

        public Builder anyOf​(Class<?>[] anyOf)
        Any of schema builder.
        Parameters:
        anyOf - the any of
        Returns:
        the schema builder

      • allOf

        public Builder allOf​(Class<?>[] allOf)
        All of schema builder.
        Parameters:
        allOf - the all of
        Returns:
        the schema builder

      • name

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

      • title

        public Builder title​(String title)
        Title schema builder.
        Parameters:
        title - the title
        Returns:
        the schema builder

      • multipleOf

        public Builder multipleOf​(double multipleOf)
        Multiple of schema builder.
        Parameters:
        multipleOf - the multiple of
        Returns:
        the schema builder

      • maximum

        public Builder maximum​(String maximum)
        Maximum schema builder.
        Parameters:
        maximum - the maximum
        Returns:
        the schema builder

      • exclusiveMaximum

        public Builder exclusiveMaximum​(boolean exclusiveMaximum)
        Exclusive maximum schema builder.
        Parameters:
        exclusiveMaximum - the exclusive maximum
        Returns:
        the schema builder

      • minimum

        public Builder minimum​(String minimum)
        Minimum schema builder.
        Parameters:
        minimum - the minimum
        Returns:
        the schema builder

      • exclusiveMinimum

        public Builder exclusiveMinimum​(boolean exclusiveMinimum)
        Exclusive minimum schema builder.
        Parameters:
        exclusiveMinimum - the exclusive minimum
        Returns:
        the schema builder

      • maxLength

        public Builder maxLength​(int maxLength)
        Max length schema builder.
        Parameters:
        maxLength - the max length
        Returns:
        the schema builder

      • minLength

        public Builder minLength​(int minLength)
        Min length schema builder.
        Parameters:
        minLength - the min length
        Returns:
        the schema builder

      • pattern

        public Builder pattern​(String pattern)
        Pattern schema builder.
        Parameters:
        pattern - the pattern
        Returns:
        the schema builder

      • maxProperties

        public Builder maxProperties​(int maxProperties)
        Max properties schema builder.
        Parameters:
        maxProperties - the max properties
        Returns:
        the schema builder

      • minProperties

        public Builder minProperties​(int minProperties)
        Min properties schema builder.
        Parameters:
        minProperties - the min properties
        Returns:
        the schema builder

      • requiredProperties

        public Builder requiredProperties​(String[] requiredProperties)
        Required properties schema builder.
        Parameters:
        requiredProperties - the required properties
        Returns:
        the schema builder

      • required

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

      • description

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

      • format

        public Builder format​(String format)
        Format schema builder.
        Parameters:
        format - the format
        Returns:
        the schema builder

      • ref

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

      • nullable

        public Builder nullable​(boolean nullable)
        Nullable schema builder.
        Parameters:
        nullable - the nullable
        Returns:
        the schema builder

      • accessMode

        public Builder accessMode​(io.swagger.v3.oas.annotations.media.Schema.AccessMode accessMode)
        Access mode schema builder.
        Parameters:
        accessMode - the access mode
        Returns:
        the schema builder

      • example

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

      • externalDocs

        public Builder externalDocs​(Builder externalDocumentationBuilder)
        External docs schema builder.
        Parameters:
        externalDocumentationBuilder - the external documentation builder
        Returns:
        the schema builder

      • deprecated

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

      • type

        public Builder type​(String type)
        Type schema builder.
        Parameters:
        type - the type
        Returns:
        the schema builder

      • allowableValues

        public Builder allowableValues​(String[] allowableValues)
        Allowable values schema builder.
        Parameters:
        allowableValues - the allowable values
        Returns:
        the schema builder

      • defaultValue

        public Builder defaultValue​(String defaultValue)
        Default value schema builder.
        Parameters:
        defaultValue - the default value
        Returns:
        the schema builder

      • discriminatorProperty

        public Builder discriminatorProperty​(String discriminatorProperty)
        Discriminator property schema builder.
        Parameters:
        discriminatorProperty - the discriminator property
        Returns:
        the schema builder

      • discriminatorMapping

        public Builder discriminatorMapping​(Builder discriminatorMappingBuilder)
        Discriminator mapping schema builder.
        Parameters:
        discriminatorMappingBuilder - the discriminator mapping builder
        Returns:
        the schema builder

      • hidden

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

      • enumAsRef

        public Builder enumAsRef​(boolean enumAsRef)
        Enum as ref schema builder.
        Parameters:
        enumAsRef - the enum as ref
        Returns:
        the schema builder

      • subTypes

        public Builder subTypes​(Class<?>[] subTypes)
        Sub types schema builder.
        Parameters:
        subTypes - the sub types
        Returns:
        the schema builder

      • extensions

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

      • build

        public io.swagger.v3.oas.annotations.media.Schema build()
        Build schema.
        Returns:
        the schema