Interface UserProperties
-
- All Known Subinterfaces:
ModifiableUserProperties
@DoNotImplement public interface UserProperties
The user properties of an MQTT packet.- Since:
- 4.0.0, CE 2019.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @Immutable @NotNull List<@NotNull UserProperty>
asList()
@Immutable @NotNull List<@NotNull String>
getAllForName(@NotNull String name)
@NotNull Optional<String>
getFirst(@NotNull String name)
boolean
isEmpty()
-
-
-
Method Detail
-
getFirst
@NotNull Optional<String> getFirst(@NotNull String name)
- Parameters:
name
- The name of the user property to get.- Returns:
- An
Optional
that contains the first user property with the specified name. - Since:
- 4.0.0, CE 2019.1
-
getAllForName
@Immutable @NotNull @Immutable @NotNull List<@NotNull String> getAllForName(@NotNull String name)
- Parameters:
name
- The name of the user properties to get.- Returns:
- The values user property with the specified name.
- Since:
- 4.0.0, CE 2019.1
-
asList
@Immutable @NotNull @Immutable @NotNull List<@NotNull UserProperty> asList()
- Returns:
- A list of all
UserProperty
s. - Since:
- 4.0.0, CE 2019.1
-
isEmpty
boolean isEmpty()
- Returns:
true
if no user properties are present, elsefalse
.- Since:
- 4.0.0, CE 2019.1
-
-