From 280563ffa0117359ede2d2729b9bdddebbbe1da6 Mon Sep 17 00:00:00 2001 From: Andrew Steinborn Date: Sat, 29 Dec 2018 14:25:06 -0500 Subject: [PATCH] Clarifications around plugin message API. --- .../api/proxy/messages/ChannelIdentifier.java | 2 +- .../api/proxy/messages/ChannelMessageSink.java | 2 +- .../api/proxy/messages/ChannelMessageSource.java | 2 +- .../api/proxy/messages/LegacyChannelIdentifier.java | 5 +++++ 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelIdentifier.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelIdentifier.java index 4318ed230..fd3101e70 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelIdentifier.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelIdentifier.java @@ -1,7 +1,7 @@ package com.velocitypowered.api.proxy.messages; /** - * Represents a kind of channel identifier for use with plugin messaging. + * Represents a channel identifier for use with plugin messaging. */ public interface ChannelIdentifier { diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSink.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSink.java index aca183a4c..f61c58963 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSink.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSink.java @@ -1,7 +1,7 @@ package com.velocitypowered.api.proxy.messages; /** - * Represents something that can send plugin messages. + * Represents something that can be sent plugin messages. */ public interface ChannelMessageSink { diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSource.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSource.java index 8985ad83e..108d082a4 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSource.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/messages/ChannelMessageSource.java @@ -1,7 +1,7 @@ package com.velocitypowered.api.proxy.messages; /** - * A marker interface that indicates a source of plugin messages. + * Indicates that this may be a source of plugin messages. */ public interface ChannelMessageSource { diff --git a/api/src/main/java/com/velocitypowered/api/proxy/messages/LegacyChannelIdentifier.java b/api/src/main/java/com/velocitypowered/api/proxy/messages/LegacyChannelIdentifier.java index ed298e2d5..c9f471035 100644 --- a/api/src/main/java/com/velocitypowered/api/proxy/messages/LegacyChannelIdentifier.java +++ b/api/src/main/java/com/velocitypowered/api/proxy/messages/LegacyChannelIdentifier.java @@ -14,6 +14,11 @@ public final class LegacyChannelIdentifier implements ChannelIdentifier { private final String name; + /** + * Creates a new legacy channel identifier. + * + * @param name the name for the channel + */ public LegacyChannelIdentifier(String name) { Preconditions.checkArgument(!Strings.isNullOrEmpty(name), "provided name is empty"); this.name = name;