Package software.amazon.smithy.mqtt.traits

Enum Class Topic.TopicRule

java.lang.Object

java.lang.Enum<Topic.TopicRule>

software.amazon.smithy.mqtt.traits.Topic.TopicRule

All Implemented Interfaces:

Serializable, Comparable<Topic.TopicRule>, Constable

Enclosing class:

Topic

public static enum Topic.TopicRule
extends Enum<Topic.TopicRule>

Controls the rules for how a value is parsed into a topic.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FILTER	Treat the value as a topic filter.
TOPIC	Treat the value as a basic topic.

Method Summary

Modifier and Type	Method	Description
static Topic.TopicRule	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Topic.TopicRule[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TOPIC

public static final Topic.TopicRule TOPIC

Treat the value as a basic topic. Wildcards are not allowed.

FILTER

public static final Topic.TopicRule FILTER

Treat the value as a topic filter. Single and multi-level wildcards are allowed if they follow the MQTT specification properly.

Method Details

values

public static Topic.TopicRule[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Topic.TopicRule valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null