org.neo4j.bolt.v1.messaging

Enum BoltRequestMessage

java.lang.Object

java.lang.Enum<BoltRequestMessage>

org.neo4j.bolt.v1.messaging.BoltRequestMessage

All Implemented Interfaces:

Serializable, Comparable<BoltRequestMessage>

public enum BoltRequestMessage
extends Enum<BoltRequestMessage>

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACK_FAILURE
DISCARD_ALL
INIT
PULL_ALL
RESET
RUN

Method Summary

Modifier and Type	Method and Description
byte	signature()
static BoltRequestMessage	valueOf(String name) Returns the enum constant of this type with the specified name.
static BoltRequestMessage[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static BoltRequestMessage	withSignature(int signature) Obtain a request 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

INIT

public static final BoltRequestMessage INIT

ACK_FAILURE

public static final BoltRequestMessage ACK_FAILURE

RESET

public static final BoltRequestMessage RESET

RUN

public static final BoltRequestMessage RUN

DISCARD_ALL

public static final BoltRequestMessage DISCARD_ALL

PULL_ALL

public static final BoltRequestMessage PULL_ALL

Method Detail

values

public static BoltRequestMessage[] 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 (BoltRequestMessage c : BoltRequestMessage.values())
    System.out.println(c);

Returns:

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

valueOf

public static BoltRequestMessage 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 BoltRequestMessage withSignature(int signature)

Obtain a request 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()