Record Class OpenApiOptions

java.lang.Object

java.lang.Record

io.fluxzero.sdk.web.OpenApiOptions

public record OpenApiOptions(String title, String version, String description, List<String> servers, String openApiVersion)
extends Record

Global options for rendering an ApiDocCatalog as an OpenAPI document.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_OPENAPI_VERSION

Constructor Summary

Constructors

Constructor	Description
OpenApiOptions(String title, String version, String description, List<String> servers)
OpenApiOptions(String title, String version, String description, List<String> servers, String openApiVersion)	Creates an instance of a OpenApiOptions record class.

Method Summary

Modifier and Type	Method	Description
static OpenApiOptions	defaults()
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static OpenApiOptions	of(String title, String version)
String	openApiVersion()	Returns the value of the openApiVersion record component.
List<String>	servers()	Returns the value of the servers record component.
String	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.
String	version()	Returns the value of the version record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_OPENAPI_VERSION

public static final String DEFAULT_OPENAPI_VERSION

See Also:

• Constant Field Values

Constructor Details

OpenApiOptions

public OpenApiOptions(String title,
 String version,
 String description,
 List<String> servers)

OpenApiOptions

public OpenApiOptions(String title,
 String version,
 String description,
 List<String> servers,
 String openApiVersion)

Creates an instance of a OpenApiOptions record class.

Parameters:

title - the value for the title record component

version - the value for the version record component

description - the value for the description record component

servers - the value for the servers record component

openApiVersion - the value for the openApiVersion record component

Method Details

defaults

public static OpenApiOptions defaults()

of

public static OpenApiOptions of(String title,
 String version)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

version

public String version()

Returns the value of the version record component.

Returns:

the value of the version record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

servers

public List<String> servers()

Returns the value of the servers record component.

Returns:

the value of the servers record component

openApiVersion

public String openApiVersion()

Returns the value of the openApiVersion record component.

Returns:

the value of the openApiVersion record component