Package com.inductiveautomation.ignition.gateway.dataroutes.openapi

Record Class ResponsesObject

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.dataroutes.openapi.ResponsesObject

public record ResponsesObject(ResponseObject defaultResponse, Map<Integer,ResponseObject> httpCodes)
extends Record

Record class that represents an OpenAPI Responses Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResponsesObject.Serializer	Specialized serializer to accommodate the specification's format of this object doesn't naturally work with GSON

Constructor Summary

Constructors

Constructor	Description
ResponsesObject(ResponseObject defaultResponse, Map<Integer,ResponseObject> httpCodes)	Creates an instance of a ResponsesObject record class.

Method Summary

Modifier and Type	Method	Description
ResponseObject	defaultResponse()	Returns the value of the defaultResponse 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.
Map<Integer,ResponseObject>	httpCodes()	Returns the value of the httpCodes 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

ResponsesObject

public ResponsesObject(ResponseObject defaultResponse,
 Map<Integer,ResponseObject> httpCodes)

Creates an instance of a ResponsesObject record class.

Parameters:

defaultResponse - the value for the defaultResponse record component

httpCodes - the value for the httpCodes 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.

defaultResponse

public ResponseObject defaultResponse()

Returns the value of the defaultResponse record component.

Returns:

the value of the defaultResponse record component

httpCodes

public Map<Integer,ResponseObject> httpCodes()

Returns the value of the httpCodes record component.

Returns:

the value of the httpCodes record component