Record Class ApiQueryParameterDefinition

java.lang.Object

java.lang.Record

com.bluebell.greenhouse.planter.resolvers.request.ApiQueryParameterDefinition

Record Components:

name - parameter name

type - ApiQueryParameterType

required - whether the parameter is required

public record ApiQueryParameterDefinition(String name, ApiQueryParameterType type, boolean required)
extends Record

Defines a query parameter consumed by a resolved request context.

Version:

3.0.5

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
ApiQueryParameterDefinition(String name, ApiQueryParameterType type, boolean required)	Creates an instance of a ApiQueryParameterDefinition record class.

Method Summary

Modifier and Type	Method	Description
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.
String	name()	Returns the value of the name record component.
boolean	required()	Returns the value of the required record component.
final String	toString()	Returns a string representation of this record class.
ApiQueryParameterType	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

ApiQueryParameterDefinition

public ApiQueryParameterDefinition(String name,
 ApiQueryParameterType type,
 boolean required)

Creates an instance of a ApiQueryParameterDefinition record class.

Parameters:

name - the value for the name record component

type - the value for the type record component

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

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

type

public ApiQueryParameterType type()

Returns the value of the type record component.

Returns:

the value of the type record component

required

public boolean required()

Returns the value of the required record component.

Returns:

the value of the required record component