Record Class Parameter

java.lang.Object

java.lang.Record

org.infinispan.rest.framework.openapi.Parameter

Record Components:

name - A required case-sensitive property.

in -

required -

All Implemented Interfaces:

JsonSerialization

public record Parameter(String name, ParameterIn in, boolean required, Schema schema, String description)
extends Record
implements JsonSerialization

Describe the parameters of a single operation.

The parameter is uniquely identified by the name and location.

See Also:

• Parameter object schema

Constructor Summary

Constructors

Constructor	Description
Parameter(String name, ParameterIn in, boolean required, Schema schema, String description)	Creates an instance of a Parameter record class.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	hashCode()	Returns a hash code value for this object.
ParameterIn	in()	Returns the value of the in record component.
String	name()	Returns the value of the name record component.
boolean	required()	Returns the value of the required record component.
Schema	schema()	Returns the value of the schema record component.
Json	toJson()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

Parameter

public Parameter(String name,
 ParameterIn in,
 boolean required,
 Schema schema,
 String description)

Creates an instance of a Parameter record class.

Parameters:

name - the value for the name record component

in - the value for the in record component

required - the value for the required record component

schema - the value for the schema record component

description - the value for the description record component

Method Details

equals

public 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

hashCode

public 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

toJson

public Json toJson()

Specified by:

toJson in interface JsonSerialization

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

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

in

public ParameterIn in()

Returns the value of the in record component.

Returns:

the value of the in record component

required

public boolean required()

Returns the value of the required record component.

Returns:

the value of the required record component

schema

public Schema schema()

Returns the value of the schema record component.

Returns:

the value of the schema record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component