Package com.arc_e_tect.gradle.apionly.transcriberj.spi

Record Class ResponseBody

java.lang.Object

java.lang.Record

com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody

Record Components:

bodyClass - the simple name of the generated class of the body, as a case's responseBodyClass names it

required - what requiredBody() returns

full - what fullBody() returns

public record ResponseBody(String bodyClass, ResponseBody.Body required, ResponseBody.Body full)
extends Record

The body of a response an operation declares, as an emitter is given it: the generated class its contract cases name, and the valid bodies that class's requiredBody() and fullBody() return. What an emitter that writes a response as a file, rather than as Java calling those methods, answers with.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ResponseBody.Body	One valid body: its text, or, when the core cannot build one, where and why -- what the generated method throws instead.

Constructor Summary

Constructors

Constructor	Description
ResponseBody(String bodyClass, ResponseBody.Body required, ResponseBody.Body full)	Creates an instance of a ResponseBody record class.

Method Summary

Modifier and Type	Method	Description
String	bodyClass()	Returns the value of the bodyClass record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ResponseBody.Body	full()	Returns the value of the full record component.
final int	hashCode()	Returns a hash code value for this object.
ResponseBody.Body	required()	Returns the value of the required 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

ResponseBody

public ResponseBody(String bodyClass,
 ResponseBody.Body required,
 ResponseBody.Body full)

Creates an instance of a ResponseBody record class.

Parameters:

bodyClass - the value for the bodyClass record component

required - the value for the required record component

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

bodyClass

public String bodyClass()

Returns the value of the bodyClass record component.

Returns:

the value of the bodyClass record component

required

public ResponseBody.Body required()

Returns the value of the required record component.

Returns:

the value of the required record component

full

public ResponseBody.Body full()

Returns the value of the full record component.

Returns:

the value of the full record component