PayloadFormatIndicator (HiveMQ Extension SDK 4.7.1 API)

java.lang.Object
- java.lang.Enum<PayloadFormatIndicator>
- - com.hivemq.extension.sdk.api.packets.publish.PayloadFormatIndicator

All Implemented Interfaces:

Serializable, Comparable<PayloadFormatIndicator>
```
public enum PayloadFormatIndicator
extends Enum<PayloadFormatIndicator>
```
Indicator for the payload.

Since:

4.0.0, CE 2019.1

Enum Constant Summary

Enum Constants
Enum Constant Description

UNSPECIFIED
The format of the bytes of the payload is not known.

UTF_8
The format of the bytes of the payload is UTF-8.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static PayloadFormatIndicator`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static 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
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
  - UNSPECIFIED
```
public static final PayloadFormatIndicator UNSPECIFIED
```
    The format of the bytes of the payload is not known.
    
    Since:
    
    4.0.0, CE 2019.1
  - UTF_8
```
public static final PayloadFormatIndicator UTF_8
```
    The format of the bytes of the payload is UTF-8.
    
    Since:
    
    4.0.0, CE 2019.1
- Method Detail
  - values
```
public static 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 (PayloadFormatIndicator c : 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 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