org.gradle.profiler.client.protocol.serialization

Enum MessageSerializer

java.lang.Object

java.lang.Enum<MessageSerializer>

org.gradle.profiler.client.protocol.serialization.MessageSerializer

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MessageSerializer>

public enum MessageSerializer
extends java.lang.Enum<MessageSerializer>

Message serializers that read and write messages from and to a Connection.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GRADLE_INVOCATION_COMPLETED
GRADLE_INVOCATION_PARAMETERS
GRADLE_INVOCATION_STARTED
STUDIO_AGENT_CONNECTION_PARAMETERS
STUDIO_CACHE_CLEANUP_COMPLETED
STUDIO_REQUEST
STUDIO_SYNC_REQUEST_COMPLETED

Method Summary

Modifier and Type	Method and Description
protected abstract Message	doReadFrom(Connection connection, int bodyTimeoutMillis)
protected abstract void	doWriteTo(Connection connection, Message message)
static MessageSerializer	getMessageSerializer(byte messageId)
static MessageSerializer	getMessageSerializer(java.lang.Class<? extends Message> messageClass)
Message	readFrom(Connection connection, int timeoutMillis) Reads a message from the given connection.
static MessageSerializer	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MessageSerializer[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	writeTo(Connection connection, Message message) Writes a message to the given connection.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GRADLE_INVOCATION_STARTED

public static final MessageSerializer GRADLE_INVOCATION_STARTED

GRADLE_INVOCATION_COMPLETED

public static final MessageSerializer GRADLE_INVOCATION_COMPLETED

GRADLE_INVOCATION_PARAMETERS

public static final MessageSerializer GRADLE_INVOCATION_PARAMETERS

STUDIO_AGENT_CONNECTION_PARAMETERS

public static final MessageSerializer STUDIO_AGENT_CONNECTION_PARAMETERS

STUDIO_REQUEST

public static final MessageSerializer STUDIO_REQUEST

STUDIO_SYNC_REQUEST_COMPLETED

public static final MessageSerializer STUDIO_SYNC_REQUEST_COMPLETED

STUDIO_CACHE_CLEANUP_COMPLETED

public static final MessageSerializer STUDIO_CACHE_CLEANUP_COMPLETED

Method Detail

values

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

Returns:

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

valueOf

public static MessageSerializer valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

doReadFrom

protected abstract Message doReadFrom(Connection connection,
                                      int bodyTimeoutMillis)
                               throws java.io.IOException

Throws:

java.io.IOException

doWriteTo

protected abstract void doWriteTo(Connection connection,
                                  Message message)
                           throws java.io.IOException

Throws:

java.io.IOException

readFrom

public Message readFrom(Connection connection,
                        int timeoutMillis)
                 throws java.io.IOException

Reads a message from the given connection.

Throws:

java.io.IOException

writeTo

public void writeTo(Connection connection,
                    Message message)
             throws java.io.IOException

Writes a message to the given connection.

Throws:

java.io.IOException

getMessageSerializer

public static MessageSerializer getMessageSerializer(java.lang.Class<? extends Message> messageClass)

getMessageSerializer

public static MessageSerializer getMessageSerializer(byte messageId)