Class OpenApi3xMapperRules.BuilderBase<BUILDER extends OpenApi3xMapperRules.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends OpenApi3xMapperRules>

java.lang.Object
io.helidon.openapi.v30.OpenApi3xMapperRules.BuilderBase<BUILDER, PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER, PROTOTYPE>
Direct Known Subclasses:
OpenApi3xMapperRules.Builder
Enclosing interface:
OpenApi3xMapperRules
public abstract static class OpenApi3xMapperRules.BuilderBase<BUILDER extends OpenApi3xMapperRules.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends OpenApi3xMapperRules> extends Object implements Prototype.Builder<BUILDER, PROTOTYPE>
Fluent API builder base for OpenApi3xMapperRules.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(OpenApi3xMapperRules prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(OpenApi3xMapperRules.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • targetVersion

      public BUILDER targetVersion(String targetVersion)
      Target OpenAPI version.
      Parameters:
      targetVersion - target OpenAPI version
      Returns:
      updated builder instance
      See Also:

    • operationResponsesRequired

      public BUILDER operationResponsesRequired(boolean operationResponsesRequired)
      Whether operations must define responses.
      Parameters:
      operationResponsesRequired - whether operation responses are required
      Returns:
      updated builder instance
      See Also:

    • responseDescriptionRequired

      public BUILDER responseDescriptionRequired(boolean responseDescriptionRequired)
      Whether responses must define a description.
      Parameters:
      responseDescriptionRequired - whether response descriptions are required
      Returns:
      updated builder instance
      See Also:

    • clearDocumentFields

      public BUILDER clearDocumentFields()
      Clear all documentFields.
      Returns:
      updated builder instance
      See Also:

    • documentFields

      public BUILDER documentFields(Set<String> documentFields)
      Document fields.
      Parameters:
      documentFields - document fields
      Returns:
      updated builder instance
      See Also:

    • addDocumentFields

      public BUILDER addDocumentFields(Set<String> documentFields)
      Document fields.
      Parameters:
      documentFields - document fields
      Returns:
      updated builder instance
      See Also:

    • addDocumentField

      public BUILDER addDocumentField(String documentField)
      Document fields.
      Parameters:
      documentField - add single document fields
      Returns:
      updated builder instance
      See Also:

    • clearInfoFields

      public BUILDER clearInfoFields()
      Clear all infoFields.
      Returns:
      updated builder instance
      See Also:

    • infoFields

      public BUILDER infoFields(Set<String> infoFields)
      Info fields.
      Parameters:
      infoFields - info fields
      Returns:
      updated builder instance
      See Also:

    • addInfoFields

      public BUILDER addInfoFields(Set<String> infoFields)
      Info fields.
      Parameters:
      infoFields - info fields
      Returns:
      updated builder instance
      See Also:

    • addInfoField

      public BUILDER addInfoField(String infoField)
      Info fields.
      Parameters:
      infoField - add single info fields
      Returns:
      updated builder instance
      See Also:

    • clearContactFields

      public BUILDER clearContactFields()
      Clear all contactFields.
      Returns:
      updated builder instance
      See Also:

    • contactFields

      public BUILDER contactFields(Set<String> contactFields)
      Contact fields.
      Parameters:
      contactFields - contact fields
      Returns:
      updated builder instance
      See Also:

    • addContactFields

      public BUILDER addContactFields(Set<String> contactFields)
      Contact fields.
      Parameters:
      contactFields - contact fields
      Returns:
      updated builder instance
      See Also:

    • addContactField

      public BUILDER addContactField(String contactField)
      Contact fields.
      Parameters:
      contactField - add single contact fields
      Returns:
      updated builder instance
      See Also:

    • clearLicenseFields

      public BUILDER clearLicenseFields()
      Clear all licenseFields.
      Returns:
      updated builder instance
      See Also:

    • licenseFields

      public BUILDER licenseFields(Set<String> licenseFields)
      License fields.
      Parameters:
      licenseFields - license fields
      Returns:
      updated builder instance
      See Also:

    • addLicenseFields

      public BUILDER addLicenseFields(Set<String> licenseFields)
      License fields.
      Parameters:
      licenseFields - license fields
      Returns:
      updated builder instance
      See Also:

    • addLicenseField

      public BUILDER addLicenseField(String licenseField)
      License fields.
      Parameters:
      licenseField - add single license fields
      Returns:
      updated builder instance
      See Also:

    • clearServerFields

      public BUILDER clearServerFields()
      Clear all serverFields.
      Returns:
      updated builder instance
      See Also:

    • serverFields

      public BUILDER serverFields(Set<String> serverFields)
      Server fields.
      Parameters:
      serverFields - server fields
      Returns:
      updated builder instance
      See Also:

    • addServerFields

      public BUILDER addServerFields(Set<String> serverFields)
      Server fields.
      Parameters:
      serverFields - server fields
      Returns:
      updated builder instance
      See Also:

    • addServerField

      public BUILDER addServerField(String serverField)
      Server fields.
      Parameters:
      serverField - add single server fields
      Returns:
      updated builder instance
      See Also:

    • clearServerVariableFields

      public BUILDER clearServerVariableFields()
      Clear all serverVariableFields.
      Returns:
      updated builder instance
      See Also:

    • serverVariableFields

      public BUILDER serverVariableFields(Set<String> serverVariableFields)
      Server variable fields.
      Parameters:
      serverVariableFields - server variable fields
      Returns:
      updated builder instance
      See Also:

    • addServerVariableFields

      public BUILDER addServerVariableFields(Set<String> serverVariableFields)
      Server variable fields.
      Parameters:
      serverVariableFields - server variable fields
      Returns:
      updated builder instance
      See Also:

    • addServerVariableField

      public BUILDER addServerVariableField(String serverVariableField)
      Server variable fields.
      Parameters:
      serverVariableField - add single server variable fields
      Returns:
      updated builder instance
      See Also:

    • clearTagFields

      public BUILDER clearTagFields()
      Clear all tagFields.
      Returns:
      updated builder instance
      See Also:

    • tagFields

      public BUILDER tagFields(Set<String> tagFields)
      Tag fields.
      Parameters:
      tagFields - tag fields
      Returns:
      updated builder instance
      See Also:

    • addTagFields

      public BUILDER addTagFields(Set<String> tagFields)
      Tag fields.
      Parameters:
      tagFields - tag fields
      Returns:
      updated builder instance
      See Also:

    • addTagField

      public BUILDER addTagField(String tagField)
      Tag fields.
      Parameters:
      tagField - add single tag fields
      Returns:
      updated builder instance
      See Also:

    • clearPathItemFields

      public BUILDER clearPathItemFields()
      Clear all pathItemFields.
      Returns:
      updated builder instance
      See Also:

    • pathItemFields

      public BUILDER pathItemFields(Set<String> pathItemFields)
      Path item fields.
      Parameters:
      pathItemFields - path item fields
      Returns:
      updated builder instance
      See Also:

    • addPathItemFields

      public BUILDER addPathItemFields(Set<String> pathItemFields)
      Path item fields.
      Parameters:
      pathItemFields - path item fields
      Returns:
      updated builder instance
      See Also:

    • addPathItemField

      public BUILDER addPathItemField(String pathItemField)
      Path item fields.
      Parameters:
      pathItemField - add single path item fields
      Returns:
      updated builder instance
      See Also:

    • clearFixedPathOperationFields

      public BUILDER clearFixedPathOperationFields()
      Clear all fixedPathOperationFields.
      Returns:
      updated builder instance
      See Also:

    • fixedPathOperationFields

      public BUILDER fixedPathOperationFields(Set<String> fixedPathOperationFields)
      Fixed path operation fields.
      Parameters:
      fixedPathOperationFields - fixed path operation fields
      Returns:
      updated builder instance
      See Also:

    • addFixedPathOperationFields

      public BUILDER addFixedPathOperationFields(Set<String> fixedPathOperationFields)
      Fixed path operation fields.
      Parameters:
      fixedPathOperationFields - fixed path operation fields
      Returns:
      updated builder instance
      See Also:

    • addFixedPathOperationField

      public BUILDER addFixedPathOperationField(String fixedPathOperationField)
      Fixed path operation fields.
      Parameters:
      fixedPathOperationField - add single fixed path operation fields
      Returns:
      updated builder instance
      See Also:

    • clearOperationFields

      public BUILDER clearOperationFields()
      Clear all operationFields.
      Returns:
      updated builder instance
      See Also:

    • operationFields

      public BUILDER operationFields(Set<String> operationFields)
      Operation fields.
      Parameters:
      operationFields - operation fields
      Returns:
      updated builder instance
      See Also:

    • addOperationFields

      public BUILDER addOperationFields(Set<String> operationFields)
      Operation fields.
      Parameters:
      operationFields - operation fields
      Returns:
      updated builder instance
      See Also:

    • addOperationField

      public BUILDER addOperationField(String operationField)
      Operation fields.
      Parameters:
      operationField - add single operation fields
      Returns:
      updated builder instance
      See Also:

    • clearParameterFields

      public BUILDER clearParameterFields()
      Clear all parameterFields.
      Returns:
      updated builder instance
      See Also:

    • parameterFields

      public BUILDER parameterFields(Set<String> parameterFields)
      Parameter fields.
      Parameters:
      parameterFields - parameter fields
      Returns:
      updated builder instance
      See Also:

    • addParameterFields

      public BUILDER addParameterFields(Set<String> parameterFields)
      Parameter fields.
      Parameters:
      parameterFields - parameter fields
      Returns:
      updated builder instance
      See Also:

    • addParameterField

      public BUILDER addParameterField(String parameterField)
      Parameter fields.
      Parameters:
      parameterField - add single parameter fields
      Returns:
      updated builder instance
      See Also:

    • clearParameterLocations

      public BUILDER clearParameterLocations()
      Clear all parameterLocations.
      Returns:
      updated builder instance
      See Also:

    • parameterLocations

      public BUILDER parameterLocations(Set<String> parameterLocations)
      Parameter locations.
      Parameters:
      parameterLocations - parameter locations
      Returns:
      updated builder instance
      See Also:

    • addParameterLocations

      public BUILDER addParameterLocations(Set<String> parameterLocations)
      Parameter locations.
      Parameters:
      parameterLocations - parameter locations
      Returns:
      updated builder instance
      See Also:

    • addParameterLocation

      public BUILDER addParameterLocation(String parameterLocation)
      Parameter locations.
      Parameters:
      parameterLocation - add single parameter locations
      Returns:
      updated builder instance
      See Also:

    • clearHeaderFields

      public BUILDER clearHeaderFields()
      Clear all headerFields.
      Returns:
      updated builder instance
      See Also:

    • headerFields

      public BUILDER headerFields(Set<String> headerFields)
      Header fields.
      Parameters:
      headerFields - header fields
      Returns:
      updated builder instance
      See Also:

    • addHeaderFields

      public BUILDER addHeaderFields(Set<String> headerFields)
      Header fields.
      Parameters:
      headerFields - header fields
      Returns:
      updated builder instance
      See Also:

    • addHeaderField

      public BUILDER addHeaderField(String headerField)
      Header fields.
      Parameters:
      headerField - add single header fields
      Returns:
      updated builder instance
      See Also:

    • clearRequestBodyFields

      public BUILDER clearRequestBodyFields()
      Clear all requestBodyFields.
      Returns:
      updated builder instance
      See Also:

    • requestBodyFields

      public BUILDER requestBodyFields(Set<String> requestBodyFields)
      Request body fields.
      Parameters:
      requestBodyFields - request body fields
      Returns:
      updated builder instance
      See Also:

    • addRequestBodyFields

      public BUILDER addRequestBodyFields(Set<String> requestBodyFields)
      Request body fields.
      Parameters:
      requestBodyFields - request body fields
      Returns:
      updated builder instance
      See Also:

    • addRequestBodyField

      public BUILDER addRequestBodyField(String requestBodyField)
      Request body fields.
      Parameters:
      requestBodyField - add single request body fields
      Returns:
      updated builder instance
      See Also:

    • clearResponseFields

      public BUILDER clearResponseFields()
      Clear all responseFields.
      Returns:
      updated builder instance
      See Also:

    • responseFields

      public BUILDER responseFields(Set<String> responseFields)
      Response fields.
      Parameters:
      responseFields - response fields
      Returns:
      updated builder instance
      See Also:

    • addResponseFields

      public BUILDER addResponseFields(Set<String> responseFields)
      Response fields.
      Parameters:
      responseFields - response fields
      Returns:
      updated builder instance
      See Also:

    • addResponseField

      public BUILDER addResponseField(String responseField)
      Response fields.
      Parameters:
      responseField - add single response fields
      Returns:
      updated builder instance
      See Also:

    • clearMediaTypeFields

      public BUILDER clearMediaTypeFields()
      Clear all mediaTypeFields.
      Returns:
      updated builder instance
      See Also:

    • mediaTypeFields

      public BUILDER mediaTypeFields(Set<String> mediaTypeFields)
      Media type fields.
      Parameters:
      mediaTypeFields - media type fields
      Returns:
      updated builder instance
      See Also:

    • addMediaTypeFields

      public BUILDER addMediaTypeFields(Set<String> mediaTypeFields)
      Media type fields.
      Parameters:
      mediaTypeFields - media type fields
      Returns:
      updated builder instance
      See Also:

    • addMediaTypeField

      public BUILDER addMediaTypeField(String mediaTypeField)
      Media type fields.
      Parameters:
      mediaTypeField - add single media type fields
      Returns:
      updated builder instance
      See Also:

    • clearEncodingFields

      public BUILDER clearEncodingFields()
      Clear all encodingFields.
      Returns:
      updated builder instance
      See Also:

    • encodingFields

      public BUILDER encodingFields(Set<String> encodingFields)
      Encoding fields.
      Parameters:
      encodingFields - encoding fields
      Returns:
      updated builder instance
      See Also:

    • addEncodingFields

      public BUILDER addEncodingFields(Set<String> encodingFields)
      Encoding fields.
      Parameters:
      encodingFields - encoding fields
      Returns:
      updated builder instance
      See Also:

    • addEncodingField

      public BUILDER addEncodingField(String encodingField)
      Encoding fields.
      Parameters:
      encodingField - add single encoding fields
      Returns:
      updated builder instance
      See Also:

    • clearComponentsFields

      public BUILDER clearComponentsFields()
      Clear all componentsFields.
      Returns:
      updated builder instance
      See Also:

    • componentsFields

      public BUILDER componentsFields(Set<String> componentsFields)
      Components fields.
      Parameters:
      componentsFields - components fields
      Returns:
      updated builder instance
      See Also:

    • addComponentsFields

      public BUILDER addComponentsFields(Set<String> componentsFields)
      Components fields.
      Parameters:
      componentsFields - components fields
      Returns:
      updated builder instance
      See Also:

    • addComponentsField

      public BUILDER addComponentsField(String componentsField)
      Components fields.
      Parameters:
      componentsField - add single components fields
      Returns:
      updated builder instance
      See Also:

    • clearSecuritySchemeFields

      public BUILDER clearSecuritySchemeFields()
      Clear all securitySchemeFields.
      Returns:
      updated builder instance
      See Also:

    • securitySchemeFields

      public BUILDER securitySchemeFields(Set<String> securitySchemeFields)
      Security scheme fields.
      Parameters:
      securitySchemeFields - security scheme fields
      Returns:
      updated builder instance
      See Also:

    • addSecuritySchemeFields

      public BUILDER addSecuritySchemeFields(Set<String> securitySchemeFields)
      Security scheme fields.
      Parameters:
      securitySchemeFields - security scheme fields
      Returns:
      updated builder instance
      See Also:

    • addSecuritySchemeField

      public BUILDER addSecuritySchemeField(String securitySchemeField)
      Security scheme fields.
      Parameters:
      securitySchemeField - add single security scheme fields
      Returns:
      updated builder instance
      See Also:

    • clearSecuritySchemeTypes

      public BUILDER clearSecuritySchemeTypes()
      Clear all securitySchemeTypes.
      Returns:
      updated builder instance
      See Also:

    • securitySchemeTypes

      public BUILDER securitySchemeTypes(Set<String> securitySchemeTypes)
      Security scheme types.
      Parameters:
      securitySchemeTypes - security scheme types
      Returns:
      updated builder instance
      See Also:

    • addSecuritySchemeTypes

      public BUILDER addSecuritySchemeTypes(Set<String> securitySchemeTypes)
      Security scheme types.
      Parameters:
      securitySchemeTypes - security scheme types
      Returns:
      updated builder instance
      See Also:

    • addSecuritySchemeType

      public BUILDER addSecuritySchemeType(String securitySchemeType)
      Security scheme types.
      Parameters:
      securitySchemeType - add single security scheme types
      Returns:
      updated builder instance
      See Also:

    • clearOauthFlowsFields

      public BUILDER clearOauthFlowsFields()
      Clear all oauthFlowsFields.
      Returns:
      updated builder instance
      See Also:

    • oauthFlowsFields

      public BUILDER oauthFlowsFields(Set<String> oauthFlowsFields)
      OAuth flows fields.
      Parameters:
      oauthFlowsFields - OAuth flows fields
      Returns:
      updated builder instance
      See Also:

    • addOauthFlowsFields

      public BUILDER addOauthFlowsFields(Set<String> oauthFlowsFields)
      OAuth flows fields.
      Parameters:
      oauthFlowsFields - OAuth flows fields
      Returns:
      updated builder instance
      See Also:

    • addOauthFlowsField

      public BUILDER addOauthFlowsField(String oauthFlowsField)
      OAuth flows fields.
      Parameters:
      oauthFlowsField - add single OAuth flows fields
      Returns:
      updated builder instance
      See Also:

    • clearOauthFlowFields

      public BUILDER clearOauthFlowFields()
      Clear all oauthFlowFields.
      Returns:
      updated builder instance
      See Also:

    • oauthFlowFields

      public BUILDER oauthFlowFields(Set<String> oauthFlowFields)
      OAuth flow fields.
      Parameters:
      oauthFlowFields - OAuth flow fields
      Returns:
      updated builder instance
      See Also:

    • addOauthFlowFields

      public BUILDER addOauthFlowFields(Set<String> oauthFlowFields)
      OAuth flow fields.
      Parameters:
      oauthFlowFields - OAuth flow fields
      Returns:
      updated builder instance
      See Also:

    • addOauthFlowField

      public BUILDER addOauthFlowField(String oauthFlowField)
      OAuth flow fields.
      Parameters:
      oauthFlowField - add single OAuth flow fields
      Returns:
      updated builder instance
      See Also:

    • clearLinkFields

      public BUILDER clearLinkFields()
      Clear all linkFields.
      Returns:
      updated builder instance
      See Also:

    • linkFields

      public BUILDER linkFields(Set<String> linkFields)
      Link fields.
      Parameters:
      linkFields - link fields
      Returns:
      updated builder instance
      See Also:

    • addLinkFields

      public BUILDER addLinkFields(Set<String> linkFields)
      Link fields.
      Parameters:
      linkFields - link fields
      Returns:
      updated builder instance
      See Also:

    • addLinkField

      public BUILDER addLinkField(String linkField)
      Link fields.
      Parameters:
      linkField - add single link fields
      Returns:
      updated builder instance
      See Also:

    • clearExampleFields

      public BUILDER clearExampleFields()
      Clear all exampleFields.
      Returns:
      updated builder instance
      See Also:

    • exampleFields

      public BUILDER exampleFields(Set<String> exampleFields)
      Example fields.
      Parameters:
      exampleFields - example fields
      Returns:
      updated builder instance
      See Also:

    • addExampleFields

      public BUILDER addExampleFields(Set<String> exampleFields)
      Example fields.
      Parameters:
      exampleFields - example fields
      Returns:
      updated builder instance
      See Also:

    • addExampleField

      public BUILDER addExampleField(String exampleField)
      Example fields.
      Parameters:
      exampleField - add single example fields
      Returns:
      updated builder instance
      See Also:

    • clearExternalDocsFields

      public BUILDER clearExternalDocsFields()
      Clear all externalDocsFields.
      Returns:
      updated builder instance
      See Also:

    • externalDocsFields

      public BUILDER externalDocsFields(Set<String> externalDocsFields)
      External docs fields.
      Parameters:
      externalDocsFields - external docs fields
      Returns:
      updated builder instance
      See Also:

    • addExternalDocsFields

      public BUILDER addExternalDocsFields(Set<String> externalDocsFields)
      External docs fields.
      Parameters:
      externalDocsFields - external docs fields
      Returns:
      updated builder instance
      See Also:

    • addExternalDocsField

      public BUILDER addExternalDocsField(String externalDocsField)
      External docs fields.
      Parameters:
      externalDocsField - add single external docs fields
      Returns:
      updated builder instance
      See Also:

    • targetVersion

      public Optional<String> targetVersion()
      Target OpenAPI version.
      Returns:
      target OpenAPI version

    • operationResponsesRequired

      public boolean operationResponsesRequired()
      Whether operations must define responses.
      Returns:
      whether operation responses are required

    • responseDescriptionRequired

      public boolean responseDescriptionRequired()
      Whether responses must define a description.
      Returns:
      whether response descriptions are required

    • documentFields

      public Set<String> documentFields()
      Document fields.
      Returns:
      document fields

    • infoFields

      public Set<String> infoFields()
      Info fields.
      Returns:
      info fields

    • contactFields

      public Set<String> contactFields()
      Contact fields.
      Returns:
      contact fields

    • licenseFields

      public Set<String> licenseFields()
      License fields.
      Returns:
      license fields

    • serverFields

      public Set<String> serverFields()
      Server fields.
      Returns:
      server fields

    • serverVariableFields

      public Set<String> serverVariableFields()
      Server variable fields.
      Returns:
      server variable fields

    • tagFields

      public Set<String> tagFields()
      Tag fields.
      Returns:
      tag fields

    • pathItemFields

      public Set<String> pathItemFields()
      Path item fields.
      Returns:
      path item fields

    • fixedPathOperationFields

      public Set<String> fixedPathOperationFields()
      Fixed path operation fields.
      Returns:
      fixed path operation fields

    • operationFields

      public Set<String> operationFields()
      Operation fields.
      Returns:
      operation fields

    • parameterFields

      public Set<String> parameterFields()
      Parameter fields.
      Returns:
      parameter fields

    • parameterLocations

      public Set<String> parameterLocations()
      Parameter locations.
      Returns:
      parameter locations

    • headerFields

      public Set<String> headerFields()
      Header fields.
      Returns:
      header fields

    • requestBodyFields

      public Set<String> requestBodyFields()
      Request body fields.
      Returns:
      request body fields

    • responseFields

      public Set<String> responseFields()
      Response fields.
      Returns:
      response fields

    • mediaTypeFields

      public Set<String> mediaTypeFields()
      Media type fields.
      Returns:
      media type fields

    • encodingFields

      public Set<String> encodingFields()
      Encoding fields.
      Returns:
      encoding fields

    • componentsFields

      public Set<String> componentsFields()
      Components fields.
      Returns:
      components fields

    • securitySchemeFields

      public Set<String> securitySchemeFields()
      Security scheme fields.
      Returns:
      security scheme fields

    • securitySchemeTypes

      public Set<String> securitySchemeTypes()
      Security scheme types.
      Returns:
      security scheme types

    • oauthFlowsFields

      public Set<String> oauthFlowsFields()
      OAuth flows fields.
      Returns:
      OAuth flows fields

    • oauthFlowFields

      public Set<String> oauthFlowFields()
      OAuth flow fields.
      Returns:
      OAuth flow fields

    • linkFields

      public Set<String> linkFields()
      Link fields.
      Returns:
      link fields

    • exampleFields

      public Set<String> exampleFields()
      Example fields.
      Returns:
      example fields

    • externalDocsFields

      public Set<String> externalDocsFields()
      External docs fields.
      Returns:
      external docs fields

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.