Module java4ever.binding

Package tech.deplant.java4ever.binding.generator.reference

Record Class ApiFunction

java.lang.Object

java.lang.Record

tech.deplant.java4ever.binding.generator.reference.ApiFunction

public record ApiFunction(String name, String summary, String description, ApiType[] params, ApiType result, String errors)
extends Record

Constructor Summary

Constructors

Constructor	Description
ApiFunction(String name, String summary, String description, ApiType[] params, ApiType result, String errors)	Creates an instance of a ApiFunction 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.
String	errors()	Returns the value of the errors record component.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
ApiType[]	params()	Returns the value of the params record component.
ApiType	result()	Returns the value of the result 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

ApiFunction

public ApiFunction(String name,
 String summary,
 String description,
 ApiType[] params,
 ApiType result,
 String errors)

Creates an instance of a ApiFunction 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

params - the value for the params record component

result - the value for the result record component

errors - the value for the errors 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

params

public ApiType[] params()

Returns the value of the params record component.

Returns:

the value of the params record component

result

public ApiType result()

Returns the value of the result record component.

Returns:

the value of the result record component

errors

public String errors()

Returns the value of the errors record component.

Returns:

the value of the errors record component