Hide WIP async methods in experimental interface

CHANGELOG

@@ -4,6 +4,7 @@ vNEXT (in development)
  * Added sendPart method
  * Fix occasional ConcurrentModificationException when adding state
  * (Internal) Moved message processors into their own package
+ * (Internal) Added ExperimentalIrcClient interface for features not yet ready for release
 
 v0.10.0
 

src/main/kotlin/com/dmdirc/ktirc/IrcClient.kt

@@ -89,39 +89,6 @@ interface IrcClient {
      */
     fun send(command: String, vararg arguments: String) = send(emptyMap(), command, *arguments)
 
-    /**
-     * Sends the given command to the IRC server, and waits for a response back.
-     *
-     * This should only be needed to send raw/custom commands; standard messages can be sent using the
-     * extension methods in [com.dmdirc.ktirc.messages] such as TODO: sendJoinAsync.
-     *
-     * This method will return immediately. If the server supports the labeled-responses capability,
-     * the returned [Deferred] will be eventually populated with the response from the server. If
-     * the server does not support the capability, or the response times out, `null` will be supplied.
-     *
-     * @param command The command to be sent.
-     * @param arguments The arguments to the command.
-     * @return A deferred [IrcEvent]? that contains the server's response to the command.
-     */
-    fun sendAsync(command: String, vararg arguments: String) = sendAsync(emptyMap(),  command, *arguments)
-
-    /**
-     * Sends the given command to the IRC server, and waits for a response back.
-     *
-     * This should only be needed to send raw/custom commands; standard messages can be sent using the
-     * extension methods in [com.dmdirc.ktirc.messages] such as TODO: sendJoinAsync.
-     *
-     * This method will return immediately. If the server supports the labeled-responses capability,
-     * the returned [Deferred] will be eventually populated with the response from the server. If
-     * the server does not support the capability, or the response times out, `null` will be supplied.
-     *
-     * @param tags The IRCv3 tags to prefix the message with, if any.
-     * @param command The command to be sent.
-     * @param arguments The arguments to the command.
-     * @return A deferred [IrcEvent]? that contains the server's response to the command.
-     */
-    fun sendAsync(tags: Map<MessageTag, String>, command: String, vararg arguments: String): Deferred<IrcEvent?>
-
     /**
      * Registers a new handler for all events on this connection.
      *
@@ -161,6 +128,43 @@ interface IrcClient {
 
 }
 
+internal interface ExperimentalIrcClient : IrcClient {
+
+    /**
+     * Sends the given command to the IRC server, and waits for a response back.
+     *
+     * This should only be needed to send raw/custom commands; standard messages can be sent using the
+     * extension methods in [com.dmdirc.ktirc.messages] such as TODO: sendJoinAsync.
+     *
+     * This method will return immediately. If the server supports the labeled-responses capability,
+     * the returned [Deferred] will be eventually populated with the response from the server. If
+     * the server does not support the capability, or the response times out, `null` will be supplied.
+     *
+     * @param command The command to be sent.
+     * @param arguments The arguments to the command.
+     * @return A deferred [IrcEvent]? that contains the server's response to the command.
+     */
+    fun sendAsync(command: String, vararg arguments: String) = sendAsync(emptyMap(),  command, *arguments)
+
+    /**
+     * Sends the given command to the IRC server, and waits for a response back.
+     *
+     * This should only be needed to send raw/custom commands; standard messages can be sent using the
+     * extension methods in [com.dmdirc.ktirc.messages] such as TODO: sendJoinAsync.
+     *
+     * This method will return immediately. If the server supports the labeled-responses capability,
+     * the returned [Deferred] will be eventually populated with the response from the server. If
+     * the server does not support the capability, or the response times out, `null` will be supplied.
+     *
+     * @param tags The IRCv3 tags to prefix the message with, if any.
+     * @param command The command to be sent.
+     * @param arguments The arguments to the command.
+     * @return A deferred [IrcEvent]? that contains the server's response to the command.
+     */
+    fun sendAsync(tags: Map<MessageTag, String>, command: String, vararg arguments: String): Deferred<IrcEvent?>
+
+}
+
 /**
  * Defines the behaviour of an [IrcClient].
  */

src/main/kotlin/com/dmdirc/ktirc/IrcClientImpl.kt

@@ -27,7 +27,7 @@ import java.util.logging.Level
  */
 // TODO: How should alternative nicknames work?
 // TODO: Should IRC Client take a pool of servers and rotate through, or make the caller do that?
-internal class IrcClientImpl(private val config: IrcClientConfig) : IrcClient, CoroutineScope {
+internal class IrcClientImpl(private val config: IrcClientConfig) : ExperimentalIrcClient, CoroutineScope {
 
     private val log by logger()