Record Class BasicResponse

java.lang.Object

java.lang.Record

com.kingsrook.qqq.middleware.javalin.specs.BasicResponse

public record BasicResponse(String contentType, io.javalin.http.HttpStatus status, String description, String schemaRefName, Map<String,Example> examples)
extends Record

Basic version of a response from a spec/endpoint.

Constructor Summary

Constructors

Constructor	Description
BasicResponse(io.javalin.http.HttpStatus status, String description, String schemaRefName)	Constructor
BasicResponse(io.javalin.http.HttpStatus status, String description, String schemaRefName, Map<String,Example> examples)	Constructor
BasicResponse(String contentType, io.javalin.http.HttpStatus status, String description, String schemaRefName, Map<String,Example> examples)	Creates an instance of a BasicResponse record class.
BasicResponse(String description, String schemaRefName)	Constructor
BasicResponse(String description, String schemaRefName, Map<String,Example> examples)	Constructor

Method Summary

Modifier and Type	Method	Description
String	contentType()	Returns the value of the contentType record component.
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.
Map<String,Example>	examples()	Returns the value of the examples record component.
final int	hashCode()	Returns a hash code value for this object.
String	schemaRefName()	Returns the value of the schemaRefName record component.
io.javalin.http.HttpStatus	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

BasicResponse

public BasicResponse(String description,
 String schemaRefName)

Constructor

BasicResponse

public BasicResponse(String description,
 String schemaRefName,
 Map<String,Example> examples)

Constructor

BasicResponse

public BasicResponse(io.javalin.http.HttpStatus status,
 String description,
 String schemaRefName)

Constructor

BasicResponse

public BasicResponse(io.javalin.http.HttpStatus status,
 String description,
 String schemaRefName,
 Map<String,Example> examples)

Constructor

BasicResponse

public BasicResponse(String contentType,
 io.javalin.http.HttpStatus status,
 String description,
 String schemaRefName,
 Map<String,Example> examples)

Creates an instance of a BasicResponse record class.

Parameters:

contentType - the value for the contentType record component

status - the value for the status record component

description - the value for the description record component

schemaRefName - the value for the schemaRefName record component

examples - the value for the examples record component

Method Details

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.

contentType

public String contentType()

Returns the value of the contentType record component.

Returns:

the value of the contentType record component

status

public io.javalin.http.HttpStatus status()

Returns the value of the status record component.

Returns:

the value of the status record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

schemaRefName

public String schemaRefName()

Returns the value of the schemaRefName record component.

Returns:

the value of the schemaRefName record component

examples

public Map<String,Example> examples()

Returns the value of the examples record component.

Returns:

the value of the examples record component