Package software.amazon.awssdk.crt.mqtt5.packets

Enum PublishPacket.PayloadFormatIndicator

java.lang.Object

java.lang.Enum<PublishPacket.PayloadFormatIndicator>

software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PayloadFormatIndicator

All Implemented Interfaces:

Serializable, Comparable<PublishPacket.PayloadFormatIndicator>

Enclosing class:

PublishPacket

public static enum PublishPacket.PayloadFormatIndicator
extends Enum<PublishPacket.PayloadFormatIndicator>

Optional property describing a PublishPacket payload's format. Enum values match MQTT5 spec encoding values.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTES	The payload is arbitrary binary data
UTF8	The payload is a well-formed utf-8 string value.

Method Summary

Modifier and Type	Method	Description
static PublishPacket.PayloadFormatIndicator	getEnumValueFromInteger(int value)	Creates a Java PayloadFormatIndicator enum value from a native integer value.
int	getValue()
static PublishPacket.PayloadFormatIndicator	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PublishPacket.PayloadFormatIndicator[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

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

BYTES

public static final PublishPacket.PayloadFormatIndicator BYTES

The payload is arbitrary binary data

UTF8

public static final PublishPacket.PayloadFormatIndicator UTF8

The payload is a well-formed utf-8 string value.

Method Detail

values

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

Returns:

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

valueOf

public static PublishPacket.PayloadFormatIndicator 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

getValue

public int getValue()

Returns:

The native enum integer value associated with this Java enum value

getEnumValueFromInteger

public static PublishPacket.PayloadFormatIndicator getEnumValueFromInteger(int value)

Creates a Java PayloadFormatIndicator enum value from a native integer value.

Parameters:

value - native integer value for PayloadFormatIndicator

Returns:

a new PayloadFormatIndicator value