Class OpenApi3xMapperRules.Builder

java.lang.Object

io.helidon.openapi.v30.OpenApi3xMapperRules.BuilderBase<OpenApi3xMapperRules.Builder, OpenApi3xMapperRules>

io.helidon.openapi.v30.OpenApi3xMapperRules.Builder

All Implemented Interfaces:

Prototype.Builder<OpenApi3xMapperRules.Builder, OpenApi3xMapperRules>, Builder<OpenApi3xMapperRules.Builder, OpenApi3xMapperRules>, Supplier<OpenApi3xMapperRules>

Enclosing interface:

OpenApi3xMapperRules

public static class OpenApi3xMapperRules.Builder
extends OpenApi3xMapperRules.BuilderBase<OpenApi3xMapperRules.Builder, OpenApi3xMapperRules>
implements Builder<OpenApi3xMapperRules.Builder, OpenApi3xMapperRules>

Fluent API builder for OpenApi3xMapperRules.

Nested Class Summary

Nested classes/interfaces inherited from class OpenApi3xMapperRules.BuilderBase

OpenApi3xMapperRules.BuilderBase.OpenApi3xMapperRulesImpl

Modifier and Type	Class	Description
protected static class	OpenApi3xMapperRules.BuilderBase.OpenApi3xMapperRulesImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
OpenApi3xMapperRules	build()	Create an instance from this builder.
OpenApi3xMapperRules	buildPrototype()	Create an instance of the prototype.

Methods inherited from class OpenApi3xMapperRules.BuilderBase

addComponentsField, addComponentsFields, addContactField, addContactFields, addDocumentField, addDocumentFields, addEncodingField, addEncodingFields, addExampleField, addExampleFields, addExternalDocsField, addExternalDocsFields, addFixedPathOperationField, addFixedPathOperationFields, addHeaderField, addHeaderFields, addInfoField, addInfoFields, addLicenseField, addLicenseFields, addLinkField, addLinkFields, addMediaTypeField, addMediaTypeFields, addOauthFlowField, addOauthFlowFields, addOauthFlowsField, addOauthFlowsFields, addOperationField, addOperationFields, addParameterField, addParameterFields, addParameterLocation, addParameterLocations, addPathItemField, addPathItemFields, addRequestBodyField, addRequestBodyFields, addResponseField, addResponseFields, addSecuritySchemeField, addSecuritySchemeFields, addSecuritySchemeType, addSecuritySchemeTypes, addServerField, addServerFields, addServerVariableField, addServerVariableFields, addTagField, addTagFields, clearComponentsFields, clearContactFields, clearDocumentFields, clearEncodingFields, clearExampleFields, clearExternalDocsFields, clearFixedPathOperationFields, clearHeaderFields, clearInfoFields, clearLicenseFields, clearLinkFields, clearMediaTypeFields, clearOauthFlowFields, clearOauthFlowsFields, clearOperationFields, clearParameterFields, clearParameterLocations, clearPathItemFields, clearRequestBodyFields, clearResponseFields, clearSecuritySchemeFields, clearSecuritySchemeTypes, clearServerFields, clearServerVariableFields, clearTagFields, componentsFields, componentsFields, contactFields, contactFields, documentFields, documentFields, encodingFields, encodingFields, exampleFields, exampleFields, externalDocsFields, externalDocsFields, fixedPathOperationFields, fixedPathOperationFields, from, from, headerFields, headerFields, infoFields, infoFields, licenseFields, licenseFields, linkFields, linkFields, mediaTypeFields, mediaTypeFields, oauthFlowFields, oauthFlowFields, oauthFlowsFields, oauthFlowsFields, operationFields, operationFields, operationResponsesRequired, operationResponsesRequired, parameterFields, parameterFields, parameterLocations, parameterLocations, pathItemFields, pathItemFields, preBuildPrototype, requestBodyFields, requestBodyFields, responseDescriptionRequired, responseDescriptionRequired, responseFields, responseFields, securitySchemeFields, securitySchemeFields, securitySchemeTypes, securitySchemeTypes, serverFields, serverFields, serverVariableFields, serverVariableFields, tagFields, tagFields, targetVersion, targetVersion, toString, validatePrototype

Modifier and Type	Method	Description
OpenApi3xMapperRules.Builder	addComponentsField(String componentsField)	Components fields.
OpenApi3xMapperRules.Builder	addComponentsFields(Set<String> componentsFields)	Components fields.
OpenApi3xMapperRules.Builder	addContactField(String contactField)	Contact fields.
OpenApi3xMapperRules.Builder	addContactFields(Set<String> contactFields)	Contact fields.
OpenApi3xMapperRules.Builder	addDocumentField(String documentField)	Document fields.
OpenApi3xMapperRules.Builder	addDocumentFields(Set<String> documentFields)	Document fields.
OpenApi3xMapperRules.Builder	addEncodingField(String encodingField)	Encoding fields.
OpenApi3xMapperRules.Builder	addEncodingFields(Set<String> encodingFields)	Encoding fields.
OpenApi3xMapperRules.Builder	addExampleField(String exampleField)	Example fields.
OpenApi3xMapperRules.Builder	addExampleFields(Set<String> exampleFields)	Example fields.
OpenApi3xMapperRules.Builder	addExternalDocsField(String externalDocsField)	External docs fields.
OpenApi3xMapperRules.Builder	addExternalDocsFields(Set<String> externalDocsFields)	External docs fields.
OpenApi3xMapperRules.Builder	addFixedPathOperationField(String fixedPathOperationField)	Fixed path operation fields.
OpenApi3xMapperRules.Builder	addFixedPathOperationFields(Set<String> fixedPathOperationFields)	Fixed path operation fields.
OpenApi3xMapperRules.Builder	addHeaderField(String headerField)	Header fields.
OpenApi3xMapperRules.Builder	addHeaderFields(Set<String> headerFields)	Header fields.
OpenApi3xMapperRules.Builder	addInfoField(String infoField)	Info fields.
OpenApi3xMapperRules.Builder	addInfoFields(Set<String> infoFields)	Info fields.
OpenApi3xMapperRules.Builder	addLicenseField(String licenseField)	License fields.
OpenApi3xMapperRules.Builder	addLicenseFields(Set<String> licenseFields)	License fields.
OpenApi3xMapperRules.Builder	addLinkField(String linkField)	Link fields.
OpenApi3xMapperRules.Builder	addLinkFields(Set<String> linkFields)	Link fields.
OpenApi3xMapperRules.Builder	addMediaTypeField(String mediaTypeField)	Media type fields.
OpenApi3xMapperRules.Builder	addMediaTypeFields(Set<String> mediaTypeFields)	Media type fields.
OpenApi3xMapperRules.Builder	addOauthFlowField(String oauthFlowField)	OAuth flow fields.
OpenApi3xMapperRules.Builder	addOauthFlowFields(Set<String> oauthFlowFields)	OAuth flow fields.
OpenApi3xMapperRules.Builder	addOauthFlowsField(String oauthFlowsField)	OAuth flows fields.
OpenApi3xMapperRules.Builder	addOauthFlowsFields(Set<String> oauthFlowsFields)	OAuth flows fields.
OpenApi3xMapperRules.Builder	addOperationField(String operationField)	Operation fields.
OpenApi3xMapperRules.Builder	addOperationFields(Set<String> operationFields)	Operation fields.
OpenApi3xMapperRules.Builder	addParameterField(String parameterField)	Parameter fields.
OpenApi3xMapperRules.Builder	addParameterFields(Set<String> parameterFields)	Parameter fields.
OpenApi3xMapperRules.Builder	addParameterLocation(String parameterLocation)	Parameter locations.
OpenApi3xMapperRules.Builder	addParameterLocations(Set<String> parameterLocations)	Parameter locations.
OpenApi3xMapperRules.Builder	addPathItemField(String pathItemField)	Path item fields.
OpenApi3xMapperRules.Builder	addPathItemFields(Set<String> pathItemFields)	Path item fields.
OpenApi3xMapperRules.Builder	addRequestBodyField(String requestBodyField)	Request body fields.
OpenApi3xMapperRules.Builder	addRequestBodyFields(Set<String> requestBodyFields)	Request body fields.
OpenApi3xMapperRules.Builder	addResponseField(String responseField)	Response fields.
OpenApi3xMapperRules.Builder	addResponseFields(Set<String> responseFields)	Response fields.
OpenApi3xMapperRules.Builder	addSecuritySchemeField(String securitySchemeField)	Security scheme fields.
OpenApi3xMapperRules.Builder	addSecuritySchemeFields(Set<String> securitySchemeFields)	Security scheme fields.
OpenApi3xMapperRules.Builder	addSecuritySchemeType(String securitySchemeType)	Security scheme types.
OpenApi3xMapperRules.Builder	addSecuritySchemeTypes(Set<String> securitySchemeTypes)	Security scheme types.
OpenApi3xMapperRules.Builder	addServerField(String serverField)	Server fields.
OpenApi3xMapperRules.Builder	addServerFields(Set<String> serverFields)	Server fields.
OpenApi3xMapperRules.Builder	addServerVariableField(String serverVariableField)	Server variable fields.
OpenApi3xMapperRules.Builder	addServerVariableFields(Set<String> serverVariableFields)	Server variable fields.
OpenApi3xMapperRules.Builder	addTagField(String tagField)	Tag fields.
OpenApi3xMapperRules.Builder	addTagFields(Set<String> tagFields)	Tag fields.
OpenApi3xMapperRules.Builder	clearComponentsFields()	Clear all componentsFields.
OpenApi3xMapperRules.Builder	clearContactFields()	Clear all contactFields.
OpenApi3xMapperRules.Builder	clearDocumentFields()	Clear all documentFields.
OpenApi3xMapperRules.Builder	clearEncodingFields()	Clear all encodingFields.
OpenApi3xMapperRules.Builder	clearExampleFields()	Clear all exampleFields.
OpenApi3xMapperRules.Builder	clearExternalDocsFields()	Clear all externalDocsFields.
OpenApi3xMapperRules.Builder	clearFixedPathOperationFields()	Clear all fixedPathOperationFields.
OpenApi3xMapperRules.Builder	clearHeaderFields()	Clear all headerFields.
OpenApi3xMapperRules.Builder	clearInfoFields()	Clear all infoFields.
OpenApi3xMapperRules.Builder	clearLicenseFields()	Clear all licenseFields.
OpenApi3xMapperRules.Builder	clearLinkFields()	Clear all linkFields.
OpenApi3xMapperRules.Builder	clearMediaTypeFields()	Clear all mediaTypeFields.
OpenApi3xMapperRules.Builder	clearOauthFlowFields()	Clear all oauthFlowFields.
OpenApi3xMapperRules.Builder	clearOauthFlowsFields()	Clear all oauthFlowsFields.
OpenApi3xMapperRules.Builder	clearOperationFields()	Clear all operationFields.
OpenApi3xMapperRules.Builder	clearParameterFields()	Clear all parameterFields.
OpenApi3xMapperRules.Builder	clearParameterLocations()	Clear all parameterLocations.
OpenApi3xMapperRules.Builder	clearPathItemFields()	Clear all pathItemFields.
OpenApi3xMapperRules.Builder	clearRequestBodyFields()	Clear all requestBodyFields.
OpenApi3xMapperRules.Builder	clearResponseFields()	Clear all responseFields.
OpenApi3xMapperRules.Builder	clearSecuritySchemeFields()	Clear all securitySchemeFields.
OpenApi3xMapperRules.Builder	clearSecuritySchemeTypes()	Clear all securitySchemeTypes.
OpenApi3xMapperRules.Builder	clearServerFields()	Clear all serverFields.
OpenApi3xMapperRules.Builder	clearServerVariableFields()	Clear all serverVariableFields.
OpenApi3xMapperRules.Builder	clearTagFields()	Clear all tagFields.
Set<String>	componentsFields()	Components fields.
OpenApi3xMapperRules.Builder	componentsFields(Set<String> componentsFields)	Components fields.
Set<String>	contactFields()	Contact fields.
OpenApi3xMapperRules.Builder	contactFields(Set<String> contactFields)	Contact fields.
Set<String>	documentFields()	Document fields.
OpenApi3xMapperRules.Builder	documentFields(Set<String> documentFields)	Document fields.
Set<String>	encodingFields()	Encoding fields.
OpenApi3xMapperRules.Builder	encodingFields(Set<String> encodingFields)	Encoding fields.
Set<String>	exampleFields()	Example fields.
OpenApi3xMapperRules.Builder	exampleFields(Set<String> exampleFields)	Example fields.
Set<String>	externalDocsFields()	External docs fields.
OpenApi3xMapperRules.Builder	externalDocsFields(Set<String> externalDocsFields)	External docs fields.
Set<String>	fixedPathOperationFields()	Fixed path operation fields.
OpenApi3xMapperRules.Builder	fixedPathOperationFields(Set<String> fixedPathOperationFields)	Fixed path operation fields.
OpenApi3xMapperRules.Builder	from(OpenApi3xMapperRules prototype)	Update this builder from an existing prototype instance.
OpenApi3xMapperRules.Builder	from(OpenApi3xMapperRules.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Set<String>	headerFields()	Header fields.
OpenApi3xMapperRules.Builder	headerFields(Set<String> headerFields)	Header fields.
Set<String>	infoFields()	Info fields.
OpenApi3xMapperRules.Builder	infoFields(Set<String> infoFields)	Info fields.
Set<String>	licenseFields()	License fields.
OpenApi3xMapperRules.Builder	licenseFields(Set<String> licenseFields)	License fields.
Set<String>	linkFields()	Link fields.
OpenApi3xMapperRules.Builder	linkFields(Set<String> linkFields)	Link fields.
Set<String>	mediaTypeFields()	Media type fields.
OpenApi3xMapperRules.Builder	mediaTypeFields(Set<String> mediaTypeFields)	Media type fields.
Set<String>	oauthFlowFields()	OAuth flow fields.
OpenApi3xMapperRules.Builder	oauthFlowFields(Set<String> oauthFlowFields)	OAuth flow fields.
Set<String>	oauthFlowsFields()	OAuth flows fields.
OpenApi3xMapperRules.Builder	oauthFlowsFields(Set<String> oauthFlowsFields)	OAuth flows fields.
Set<String>	operationFields()	Operation fields.
OpenApi3xMapperRules.Builder	operationFields(Set<String> operationFields)	Operation fields.
boolean	operationResponsesRequired()	Whether operations must define responses.
OpenApi3xMapperRules.Builder	operationResponsesRequired(boolean operationResponsesRequired)	Whether operations must define responses.
Set<String>	parameterFields()	Parameter fields.
OpenApi3xMapperRules.Builder	parameterFields(Set<String> parameterFields)	Parameter fields.
Set<String>	parameterLocations()	Parameter locations.
OpenApi3xMapperRules.Builder	parameterLocations(Set<String> parameterLocations)	Parameter locations.
Set<String>	pathItemFields()	Path item fields.
OpenApi3xMapperRules.Builder	pathItemFields(Set<String> pathItemFields)	Path item fields.
protected void	preBuildPrototype()	Handles providers and decorators.
Set<String>	requestBodyFields()	Request body fields.
OpenApi3xMapperRules.Builder	requestBodyFields(Set<String> requestBodyFields)	Request body fields.
boolean	responseDescriptionRequired()	Whether responses must define a description.
OpenApi3xMapperRules.Builder	responseDescriptionRequired(boolean responseDescriptionRequired)	Whether responses must define a description.
Set<String>	responseFields()	Response fields.
OpenApi3xMapperRules.Builder	responseFields(Set<String> responseFields)	Response fields.
Set<String>	securitySchemeFields()	Security scheme fields.
OpenApi3xMapperRules.Builder	securitySchemeFields(Set<String> securitySchemeFields)	Security scheme fields.
Set<String>	securitySchemeTypes()	Security scheme types.
OpenApi3xMapperRules.Builder	securitySchemeTypes(Set<String> securitySchemeTypes)	Security scheme types.
Set<String>	serverFields()	Server fields.
OpenApi3xMapperRules.Builder	serverFields(Set<String> serverFields)	Server fields.
Set<String>	serverVariableFields()	Server variable fields.
OpenApi3xMapperRules.Builder	serverVariableFields(Set<String> serverVariableFields)	Server variable fields.
Set<String>	tagFields()	Tag fields.
OpenApi3xMapperRules.Builder	tagFields(Set<String> tagFields)	Tag fields.
Optional<String>	targetVersion()	Target OpenAPI version.
OpenApi3xMapperRules.Builder	targetVersion(String targetVersion)	Target OpenAPI version.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default OpenApi3xMapperRules	get()
default OpenApi3xMapperRules.Builder	identity()	Instance of this builder as the correct type.
default OpenApi3xMapperRules.Builder	update(Consumer<OpenApi3xMapperRules.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default OpenApi3xMapperRules.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public OpenApi3xMapperRules buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<OpenApi3xMapperRules.Builder, OpenApi3xMapperRules>

Returns:

an instance of the setup object created from this builder

build

public OpenApi3xMapperRules build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<OpenApi3xMapperRules.Builder, OpenApi3xMapperRules>

Returns:

instance of the built type