org.neo4j.bolt.v1.messaging

Enum BoltResponseMessage

java.lang.Object

java.lang.Enum<BoltResponseMessage>

org.neo4j.bolt.v1.messaging.BoltResponseMessage

All Implemented Interfaces:

Serializable, Comparable<BoltResponseMessage>

public enum BoltResponseMessage
extends Enum<BoltResponseMessage>

Enumeration representing all defined Bolt response messages. Also contains the signature byte with which the message is encoded on the wire.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILURE
IGNORED
RECORD
SUCCESS

Method Summary

Modifier and Type	Method and Description
byte	signature()
static BoltResponseMessage	valueOf(String name) Returns the enum constant of this type with the specified name.
static BoltResponseMessage[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static BoltResponseMessage	withSignature(int signature) Obtain a response message by signature.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final BoltResponseMessage SUCCESS

RECORD

public static final BoltResponseMessage RECORD

IGNORED

public static final BoltResponseMessage IGNORED

FAILURE

public static final BoltResponseMessage FAILURE

Method Detail

values

public static BoltResponseMessage[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BoltResponseMessage c : BoltResponseMessage.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BoltResponseMessage valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

withSignature

public static BoltResponseMessage withSignature(int signature)

Obtain a response message by signature.

Parameters:

signature - the signature byte to look up

Returns:

the appropriate message instance

Throws:

IllegalArgumentException - if no such message exists

signature

public byte signature()