Module org.neo4j.driver

Package org.neo4j.driver.internal.messaging.response

Record Class SuccessMessage

java.lang.Object

java.lang.Record

org.neo4j.driver.internal.messaging.response.SuccessMessage

All Implemented Interfaces:

Message

public record SuccessMessage(Map<String,Value> metadata)
extends Record
implements Message

SUCCESS response message

Sent by the server to signal a successful operation. Terminates response sequence.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	SIGNATURE

Constructor Summary

Constructors

Constructor	Description
SuccessMessage(Map<String,Value> metadata)	Creates an instance of a SuccessMessage record class.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
int	hashCode()	Returns a hash code value for this object.
Map<String,Value>	metadata()	Returns the value of the metadata record component.
byte	signature()
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

Field Details

SIGNATURE

public static final byte SIGNATURE

See Also:

• Constant Field Values

Constructor Details

SuccessMessage

public SuccessMessage(Map<String,Value> metadata)

Creates an instance of a SuccessMessage record class.

Parameters:

metadata - the value for the metadata record component

Method Details

signature

public byte signature()

Specified by:

signature in interface Message

toString

public 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

equals

public boolean equals(Object obj)

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:

obj - the object with which to compare

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public 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

metadata

public Map<String,Value> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component