io.spine.web.parser

Enum MessageFormat

java.lang.Object

java.lang.Enum<MessageFormat>

io.spine.web.parser.MessageFormat

All Implemented Interfaces:

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

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

Message formats supported by the Spine web API.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASE64 The Base64 bytes message stringification format.
JSON The JSON message stringification format.

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<MessageFormat>	formatOf(javax.servlet.http.HttpServletRequest request) Finds the required format for the given request.
<T extends com.google.protobuf.Message> java.util.Optional<T>	parse(java.lang.String rawMessage, java.lang.Class<T> type) Parses a given string representation into a message of the given type.
static MessageFormat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MessageFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

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

JSON

public static final MessageFormat JSON

The JSON message stringification format.

BASE64

public static final MessageFormat BASE64

The Base64 bytes message stringification format.

Method Detail

values

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

Returns:

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

valueOf

public static MessageFormat 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

formatOf

public static java.util.Optional<MessageFormat> formatOf(javax.servlet.http.HttpServletRequest request)

Finds the required format for the given request.

The format is determined by the value of the Content-Type header. If the value is equal to application/json (case insensitive), returns MessageFormat.JSON. If the value is equal to application/x-protobuf (case insensitive), returns MessageFormat.BASE64. If the header is not set, returns MessageFormat.JSON.

Parameters:

request - the request to get the format for

Returns:

the format of the message in the given request or Optional.empty() if the request does not justify the described format

parse

public <T extends com.google.protobuf.Message> java.util.Optional<T> parse(java.lang.String rawMessage,
                                                                           java.lang.Class<T> type)

Parses a given string representation into a message of the given type.

Type Parameters:

T - expected class of the message

Parameters:

rawMessage - string representation of the message

type - expected class of the message

Returns:

the parsed message or Optional.empty() if parsing fails