Package io.moderne.knowledge.model

Record Class MethodDescription

java.lang.Object

java.lang.Record

io.moderne.knowledge.model.MethodDescription

public record MethodDescription(String description, String descriptionOfReturnedValue, List<MethodDescription.Parameter> parameters, List<MethodDescription.Technique> techniquesInUse)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MethodDescription.Parameter
static final record	MethodDescription.Technique

Constructor Summary

Constructors

Constructor	Description
MethodDescription(String description, String descriptionOfReturnedValue, List<MethodDescription.Parameter> parameters, List<MethodDescription.Technique> techniquesInUse)	Creates an instance of a MethodDescription record class.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
String	descriptionOfReturnedValue()	Returns the value of the descriptionOfReturnedValue 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.
List<MethodDescription.Parameter>	parameters()	Returns the value of the parameters record component.
List<MethodDescription.Technique>	techniquesInUse()	Returns the value of the techniquesInUse 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

MethodDescription

public MethodDescription(String description,
 String descriptionOfReturnedValue,
 List<MethodDescription.Parameter> parameters,
 List<MethodDescription.Technique> techniquesInUse)

Creates an instance of a MethodDescription record class.

Parameters:

description - the value for the description record component

descriptionOfReturnedValue - the value for the descriptionOfReturnedValue record component

parameters - the value for the parameters record component

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

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

descriptionOfReturnedValue

public String descriptionOfReturnedValue()

Returns the value of the descriptionOfReturnedValue record component.

Returns:

the value of the descriptionOfReturnedValue record component

parameters

public List<MethodDescription.Parameter> parameters()

Returns the value of the parameters record component.

Returns:

the value of the parameters record component

techniquesInUse

public List<MethodDescription.Technique> techniquesInUse()

Returns the value of the techniquesInUse record component.

Returns:

the value of the techniquesInUse record component