org.cornutum.tcases.openapi

Class InputModeller

java.lang.Object

org.cornutum.tcases.openapi.ConditionReporter<OpenApiContext>

org.cornutum.tcases.openapi.InputModeller

Direct Known Subclasses:

RequestInputModeller, ResponseInputModeller

public abstract class InputModeller
extends ConditionReporter<OpenApiContext>

Converts between OpenAPI models and Tcases input models.

OpenAPI models must conform to OAS version 3. See https://swagger.io/specification/#specification.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	InputModeller.View

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InputModeller(InputModeller.View view) Creates a new InputModeller instance.
protected	InputModeller(InputModeller.View view, ModelOptions options) Creates a new InputModeller instance.

Method Summary

Modifier and Type	Method and Description
ModelOptions	getOptions() Returns the options used by this InputModeller.
protected SystemInputDef	requestInputModel(io.swagger.v3.oas.models.OpenAPI api) Returns a system input definition for the API requests defined by the given OpenAPI specification.
protected SystemInputDef	responseInputModel(io.swagger.v3.oas.models.OpenAPI api) Returns a system input definition for the API responses defined by the given OpenAPI specification.
Dnf	simplified(Dnf dnf) Returns a new DNF that generates a simpler but equivalent input model.

Methods inherited from class org.cornutum.tcases.openapi.ConditionReporter

doFor, getContext, getNotifier, notifyError, notifyWarning, resultFor, setNotifier

Methods inherited from class java.lang.Object

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

Constructor Detail

InputModeller

protected InputModeller(InputModeller.View view)

Creates a new InputModeller instance.

InputModeller

protected InputModeller(InputModeller.View view,
                        ModelOptions options)

Creates a new InputModeller instance.

Method Detail

requestInputModel

protected SystemInputDef requestInputModel(io.swagger.v3.oas.models.OpenAPI api)

Returns a system input definition for the API requests defined by the given OpenAPI specification. Returns null if the given spec defines no API requests to model.

responseInputModel

protected SystemInputDef responseInputModel(io.swagger.v3.oas.models.OpenAPI api)

Returns a system input definition for the API responses defined by the given OpenAPI specification. Returns null if the given spec defines no API responses to model.

simplified

public Dnf simplified(Dnf dnf)

Returns a new DNF that generates a simpler but equivalent input model.

getOptions

public ModelOptions getOptions()

Returns the options used by this InputModeller.