MicroProfile 7.0 · org.eclipse.microprofile.openapi.spi.OASFactoryResolver

This class is not intended to be used by end-users. It should be used by vendors to set their implementation of OASFactoryResolver.

Service provider for OASFactoryResolver. The implementation registers itself via the java.util.ServiceLoader mechanism or by manually setting their implementation using the setInstance method.

Field Summary

Modifier and Type	Field and Description
private static volatile OASFactoryResolver	instance

Constructor Summary

Access	Constructor and Description
public	OASFactoryResolver()

Method Summary

Modifier and Type	Method and Description
public abstract < 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) Create a new instance of a constructible element from the OpenAPI model tree.
public static OASFactoryResolver	Returns: an instance of OASFactoryResolver instance() Creates an OASFactoryResolver object.
private static OASFactoryResolver	loadSpi(ClassLoader cl)
public static void	setInstance(OASFactoryResolver set the instance. factory) Set the instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

instance	back to summary
private static volatile OASFactoryResolver instance

Constructor Detail

OASFactoryResolver	back to summary
public OASFactoryResolver()

Method Detail

createObject	back to summary
public abstract <T extends Constructible> T createObject(Class<T> clazz) Create a new instance of a constructible element from the OpenAPI model tree. 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

createObject

back to summary

public abstract <T extends Constructible> T createObject(Class<T> clazz)

Create a new instance of a constructible element from the OpenAPI model tree.

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

instance back to summary

instance	back to summary
public static OASFactoryResolver instance() Creates an OASFactoryResolver object. Only used internally from within `org.eclipse.microprofile.openapi.OASFactory` Returns:OASFactoryResolver an instance of OASFactoryResolver

public static OASFactoryResolver instance()

Creates an OASFactoryResolver object. Only used internally from within org.eclipse.microprofile.openapi.OASFactory

Returns:OASFactoryResolver: an instance of OASFactoryResolver

loadSpi	back to summary
private static OASFactoryResolver loadSpi(ClassLoader cl)

setInstance	back to summary
public static void setInstance(OASFactoryResolver factory) Set the instance. It is used by OSGi environment while service loader pattern is not supported. Parameters factory:OASFactoryResolver set the instance.

setInstance