Package org.pkl.core.messaging

Record Class Messages.ReadModuleResponse

java.lang.Object

java.lang.Record

org.pkl.core.messaging.Messages.ReadModuleResponse

All Implemented Interfaces:

Message, Message.Client, Message.Client.Response, Message.Response

Enclosing class:

Messages

public static record Messages.ReadModuleResponse(long requestId, long evaluatorId, @Nullable String contents, @Nullable String error)
extends Record
implements Message.Client.Response

Nested Class Summary

Nested classes/interfaces inherited from interface org.pkl.core.messaging.Message

Message.Client, Message.OneWay, Message.Request, Message.Response, Message.Server, Message.Type

Nested classes/interfaces inherited from interface org.pkl.core.messaging.Message.Client

Message.Client.OneWay, Message.Client.Request, Message.Client.Response

Constructor Summary

Constructors

Constructor	Description
ReadModuleResponse(long requestId, long evaluatorId, @Nullable String contents, @Nullable String error)	Creates an instance of a ReadModuleResponse record class.

Method Summary

Modifier and Type	Method	Description
@Nullable String	contents()	Returns the value of the contents record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable String	error()	Returns the value of the error record component.
long	evaluatorId()	Returns the value of the evaluatorId record component.
final int	hashCode()	Returns a hash code value for this object.
long	requestId()	Returns the value of the requestId record component.
final String	toString()	Returns a string representation of this record class.
Message.Type	type()

Methods inherited from class java.lang.Object

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

Constructor Details

ReadModuleResponse

public ReadModuleResponse(long requestId,
 long evaluatorId,
 @Nullable
 @Nullable String contents,
 @Nullable
 @Nullable String error)

Creates an instance of a ReadModuleResponse record class.

Parameters:

requestId - the value for the requestId record component

evaluatorId - the value for the evaluatorId record component

contents - the value for the contents record component

error - the value for the error record component

Method Details

type

public Message.Type type()

Specified by:

type in interface Message

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 '=='.

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.

requestId

public long requestId()

Returns the value of the requestId record component.

Specified by:

requestId in interface Message.Response

Returns:

the value of the requestId record component

evaluatorId

public long evaluatorId()

Returns the value of the evaluatorId record component.

Returns:

the value of the evaluatorId record component

contents

@Nullable
public @Nullable String contents()

Returns the value of the contents record component.

Returns:

the value of the contents record component

error

@Nullable
public @Nullable String error()

Returns the value of the error record component.

Returns:

the value of the error record component