Top Description Constructors Methods
org.eclipse.microprofile.openapi

public final Class OASFactory

extends Object
Class Inheritance
Imports
org.eclipse.microprofile.openapi.models.Components, .Constructible, .ExternalDocumentation, .OpenAPI, .Operation, .PathItem, .Paths, org.eclipse.microprofile.openapi.models.callbacks.Callback, org.eclipse.microprofile.openapi.models.examples.Example, org.eclipse.microprofile.openapi.models.headers.Header, org.eclipse.microprofile.openapi.models.info.Contact, .Info, .License, org.eclipse.microprofile.openapi.models.links.Link, org.eclipse.microprofile.openapi.models.media.Content, .Discriminator, .Encoding, .MediaType, .Schema, .XML, org.eclipse.microprofile.openapi.models.parameters.Parameter, .RequestBody, org.eclipse.microprofile.openapi.models.responses.APIResponse, .APIResponses, org.eclipse.microprofile.openapi.models.security.OAuthFlow, .OAuthFlows, .SecurityRequirement, .SecurityScheme, org.eclipse.microprofile.openapi.models.servers.Server, .ServerVariable, org.eclipse.microprofile.openapi.models.tags.Tag, org.eclipse.microprofile.openapi.spi.OASFactoryResolver

This class allows application developers to build new OpenAPI model elements.

For example, to start a new top-level OpenAPI element with an ExternalDocument inside of it an application developer would write:
OASFactory.createObject(OpenAPI.class)
         .setExternalDocs(OASFactory.createObject(ExternalDocumentation.class).url("http://myDoc"));

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static APIResponse

Returns:

a new APIResponse instance
createAPIResponse
()

This method creates a new org.eclipse.microprofile.openapi.models.responses.APIResponse instance.

public static APIResponses

Returns:

a new APIResponses instance
createAPIResponses
()

This method creates a new org.eclipse.microprofile.openapi.models.responses.APIResponses instance.

public static Callback

Returns:

a new Callback instance
createCallback
()

This method creates a new org.eclipse.microprofile.openapi.models.callbacks.Callback instance.

public static Components

Returns:

a new Components instance
createComponents
()

This method creates a new org.eclipse.microprofile.openapi.models.Components instance.

public static Contact

Returns:

a new Contact instance
createContact
()

This method creates a new org.eclipse.microprofile.openapi.models.info.Contact instance.

public static Content

Returns:

a new Content instance
createContent
()

This method creates a new org.eclipse.microprofile.openapi.models.media.Content instance.

public static Discriminator

Returns:

a new Discriminator instance
createDiscriminator
()

This method creates a new org.eclipse.microprofile.openapi.models.media.Discriminator instance.

public static Encoding

Returns:

a new Encoding instance
createEncoding
()

This method creates a new org.eclipse.microprofile.openapi.models.media.Encoding instance.

public static Example

Returns:

a new Example instance
createExample
()

This method creates a new org.eclipse.microprofile.openapi.models.examples.Example instance.

public static ExternalDocumentation

Returns:

a new ExternalDocumentation instance
createExternalDocumentation
()

This method creates a new org.eclipse.microprofile.openapi.models.ExternalDocumentation instance.

public static Header

Returns:

a new Header instance
createHeader
()

This method creates a new org.eclipse.microprofile.openapi.models.headers.Header instance.

public static Info

Returns:

a new Info instance
createInfo
()

This method creates a new org.eclipse.microprofile.openapi.models.info.Info instance.

public static License

Returns:

a new License instance
createLicense
()

This method creates a new org.eclipse.microprofile.openapi.models.info.License instance.

public static MediaType

Returns:

a new MediaType instance
createMediaType
()

This method creates a new org.eclipse.microprofile.openapi.models.media.MediaType instance.

public static OAuthFlow

Returns:

a new OAuthFlow instance
createOAuthFlow
()

This method creates a new org.eclipse.microprofile.openapi.models.security.OAuthFlow instance.

public static OAuthFlows

Returns:

a new OAuthFlows instance
createOAuthFlows
()

This method creates a new org.eclipse.microprofile.openapi.models.security.OAuthFlows instance.

public static <
describes the type parameter
T extends Constructible
>
T

Returns:

a new instance of the requested model class
createObject
(Class<T>
represents a model which extends the org.eclipse.microprofile.openapi.models.Constructible interface
clazz
)

This method creates a new instance of a constructible element from the OpenAPI model tree.

public static OpenAPI

Returns:

a new OpenAPI instance
createOpenAPI
()

This method creates a new org.eclipse.microprofile.openapi.models.OpenAPI instance.

public static Operation

Returns:

a new Operation instance
createOperation
()

This method creates a new org.eclipse.microprofile.openapi.models.Operation instance.

public static Parameter

Returns:

a new Parameter instance
createParameter
()

This method creates a new org.eclipse.microprofile.openapi.models.parameters.Parameter instance.

public static PathItem

Returns:

a new PathItem instance
createPathItem
()

This method creates a new org.eclipse.microprofile.openapi.models.PathItem instance.

public static Paths

Returns:

a new Paths instance
createPaths
()

This method creates a new org.eclipse.microprofile.openapi.models.Paths instance.

public static RequestBody

Returns:

a new RequestBody instance
createRequestBody
()

This method creates a new org.eclipse.microprofile.openapi.models.parameters.RequestBody instance.

public static Schema

Returns:

a new Schema instance
createSchema
()

This method creates a new org.eclipse.microprofile.openapi.models.media.Schema instance.

public static SecurityRequirement

Returns:

a new SecurityRequirement instance
createSecurityRequirement
()

This method creates a new org.eclipse.microprofile.openapi.models.security.SecurityRequirement instance.

public static SecurityScheme

Returns:

a new SecurityScheme instance
createSecurityScheme
()

This method creates a new org.eclipse.microprofile.openapi.models.security.SecurityScheme instance.

public static Server

Returns:

a new Server instance
createServer
()

This method creates a new org.eclipse.microprofile.openapi.models.servers.Server instance.

public static ServerVariable

Returns:

a new ServerVariable instance
createServerVariable
()

This method creates a new org.eclipse.microprofile.openapi.models.servers.ServerVariable instance.

public static Tag

Returns:

a new Tag instance
createTag
()

This method creates a new org.eclipse.microprofile.openapi.models.tags.Tag instance.

public static XML

Returns:

a new XML instance
createXML
()

This method creates a new org.eclipse.microprofile.openapi.models.media.XML instance.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

OASFactoryback to summary
private OASFactory()

Method Detail

createAPIResponseback to summary
public static APIResponse createAPIResponse()

This method creates a new org.eclipse.microprofile.openapi.models.responses.APIResponse instance.

Returns:APIResponse

a new APIResponse instance

createAPIResponsesback to summary
public static APIResponses createAPIResponses()

This method creates a new org.eclipse.microprofile.openapi.models.responses.APIResponses instance.

Returns:APIResponses

a new APIResponses instance

createCallbackback to summary
public static Callback createCallback()

This method creates a new org.eclipse.microprofile.openapi.models.callbacks.Callback instance.

Returns:Callback

a new Callback instance

createComponentsback to summary
public static Components createComponents()

This method creates a new org.eclipse.microprofile.openapi.models.Components instance.

Returns:Components

a new Components instance

createContactback to summary
public static Contact createContact()

This method creates a new org.eclipse.microprofile.openapi.models.info.Contact instance.

Returns:Contact

a new Contact instance

createContentback to summary
public static Content createContent()

This method creates a new org.eclipse.microprofile.openapi.models.media.Content instance.

Returns:Content

a new Content instance

createDiscriminatorback to summary
public static Discriminator createDiscriminator()

This method creates a new org.eclipse.microprofile.openapi.models.media.Discriminator instance.

Returns:Discriminator

a new Discriminator instance

createEncodingback to summary
public static Encoding createEncoding()

This method creates a new org.eclipse.microprofile.openapi.models.media.Encoding instance.

Returns:Encoding

a new Encoding instance

createExampleback to summary
public static Example createExample()

This method creates a new org.eclipse.microprofile.openapi.models.examples.Example instance.

Returns:Example

a new Example instance

createExternalDocumentationback to summary
public static ExternalDocumentation createExternalDocumentation()

This method creates a new org.eclipse.microprofile.openapi.models.ExternalDocumentation instance.

Returns:ExternalDocumentation

a new ExternalDocumentation instance

createHeaderback to summary
public static Header createHeader()

This method creates a new org.eclipse.microprofile.openapi.models.headers.Header instance.

Returns:Header

a new Header instance

createInfoback to summary
public static Info createInfo()

This method creates a new org.eclipse.microprofile.openapi.models.info.Info instance.

Returns:Info

a new Info instance

createLicenseback to summary
public static License createLicense()

This method creates a new org.eclipse.microprofile.openapi.models.info.License instance.

Returns:License

a new License instance

createMediaTypeback to summary
public static MediaType createMediaType()

This method creates a new org.eclipse.microprofile.openapi.models.media.MediaType instance.

Returns:MediaType

a new MediaType instance

createOAuthFlowback to summary
public static OAuthFlow createOAuthFlow()

This method creates a new org.eclipse.microprofile.openapi.models.security.OAuthFlow instance.

Returns:OAuthFlow

a new OAuthFlow instance

createOAuthFlowsback to summary
public static OAuthFlows createOAuthFlows()

This method creates a new org.eclipse.microprofile.openapi.models.security.OAuthFlows instance.

Returns:OAuthFlows

a new OAuthFlows instance

createObjectback to summary
public static <T extends Constructible> T createObject(Class<T> clazz)

This method creates a new instance of a constructible element from the OpenAPI model tree.

Example:

OASFactory.createObject(Info.class).title("Airlines").description("Airlines APIs").version("1.0.0");

Parameters
<T>
describes the type parameter
clazz:Class<T>

represents a model which extends the org.eclipse.microprofile.openapi.models.Constructible interface

Returns:T

a new instance of the requested model class

Exceptions
NullPointerException:
if the specified class is null
IllegalArgumentException:
if an instance could not be created, most likely, due to an illegal or inappropriate class
createOpenAPIback to summary
public static OpenAPI createOpenAPI()

This method creates a new org.eclipse.microprofile.openapi.models.OpenAPI instance.

Returns:OpenAPI

a new OpenAPI instance

createOperationback to summary
public static Operation createOperation()

This method creates a new org.eclipse.microprofile.openapi.models.Operation instance.

Returns:Operation

a new Operation instance

createParameterback to summary
public static Parameter createParameter()

This method creates a new org.eclipse.microprofile.openapi.models.parameters.Parameter instance.

Returns:Parameter

a new Parameter instance

createPathItemback to summary
public static PathItem createPathItem()

This method creates a new org.eclipse.microprofile.openapi.models.PathItem instance.

Returns:PathItem

a new PathItem instance

createPathsback to summary
public static Paths createPaths()

This method creates a new org.eclipse.microprofile.openapi.models.Paths instance.

Returns:Paths

a new Paths instance

createRequestBodyback to summary
public static RequestBody createRequestBody()

This method creates a new org.eclipse.microprofile.openapi.models.parameters.RequestBody instance.

Returns:RequestBody

a new RequestBody instance

createSchemaback to summary
public static Schema createSchema()

This method creates a new org.eclipse.microprofile.openapi.models.media.Schema instance.

Returns:Schema

a new Schema instance

createSecurityRequirementback to summary
public static SecurityRequirement createSecurityRequirement()

This method creates a new org.eclipse.microprofile.openapi.models.security.SecurityRequirement instance.

Returns:SecurityRequirement

a new SecurityRequirement instance

createSecuritySchemeback to summary
public static SecurityScheme createSecurityScheme()

This method creates a new org.eclipse.microprofile.openapi.models.security.SecurityScheme instance.

Returns:SecurityScheme

a new SecurityScheme instance

createServerback to summary
public static Server createServer()

This method creates a new org.eclipse.microprofile.openapi.models.servers.Server instance.

Returns:Server

a new Server instance

createServerVariableback to summary
public static ServerVariable createServerVariable()

This method creates a new org.eclipse.microprofile.openapi.models.servers.ServerVariable instance.

Returns:ServerVariable

a new ServerVariable instance

createTagback to summary
public static Tag createTag()

This method creates a new org.eclipse.microprofile.openapi.models.tags.Tag instance.

Returns:Tag

a new Tag instance

createXMLback to summary
public static XML createXML()

This method creates a new org.eclipse.microprofile.openapi.models.media.XML instance.

Returns:XML

a new XML instance