Package com.arc_e_tect.gradle.apionly.transcriberj.model

Record Class Reference

java.lang.Object

java.lang.Record

com.arc_e_tect.gradle.apionly.transcriberj.model.Reference

Record Components:

name - the name of the component the reference names directly

summary - the reference's own summary, or null

description - the reference's own description, or null; when present, OpenAPI 3.1 has it override the component's

other - any other key written beside the $ref, as parsed; OpenAPI has these ignored

public record Reference(String name, String summary, String description, Map<String,Object> other)
extends Record

A $ref written where a parameter, request body or response would be.

The object carrying it is resolved: its typed fields are those of the component the reference leads to, following references to references. What the reference itself says is kept here.

Constructor Summary

Constructors

Constructor	Description
Reference(String name, String summary, String description, Map<String,Object> other)	Creates an instance of a Reference record class.

Method Summary

Modifier and Type	Method	Description
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.
String	name()	Returns the value of the name record component.
Map<String,Object>	other()	Returns the value of the other record component.
String	summary()	Returns the value of the summary 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

Reference

public Reference(String name,
 String summary,
 String description,
 Map<String,Object> other)

Creates an instance of a Reference record class.

Parameters:

name - the value for the name record component

summary - the value for the summary record component

description - the value for the description record component

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

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

summary

public String summary()

Returns the value of the summary record component.

Returns:

the value of the summary record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

other

public Map<String,Object> other()

Returns the value of the other record component.

Returns:

the value of the other record component