From cc6fed0298acf27c8fdde4e776eb2b46fa84dcdb Mon Sep 17 00:00:00 2001
From: akwizgran <michael@briarproject.org>
Date: Fri, 13 Apr 2018 16:27:30 +0100
Subject: [PATCH] Add javadocs.
---
.../bramble/api/lifecycle/LifecycleManager.java | 9 ++++++---
.../bramble/api/sync/ClientVersioningManager.java | 10 ++++++++++
.../bramble/api/sync/ValidationManager.java | 10 +++++++---
3 files changed, 23 insertions(+), 6 deletions(-)
diff --git a/bramble-api/src/main/java/org/briarproject/bramble/api/lifecycle/LifecycleManager.java b/bramble-api/src/main/java/org/briarproject/bramble/api/lifecycle/LifecycleManager.java
index 5a036a3b6c..d3cd1bc245 100644
--- a/bramble-api/src/main/java/org/briarproject/bramble/api/lifecycle/LifecycleManager.java
+++ b/bramble-api/src/main/java/org/briarproject/bramble/api/lifecycle/LifecycleManager.java
@@ -43,17 +43,20 @@ public interface LifecycleManager {
}
/**
- * Registers a {@link Service} to be started and stopped.
+ * Registers a {@link Service} to be started and stopped. This method
+ * should be called before {@link #startServices(String)}.
*/
void registerService(Service s);
/**
- * Registers a {@link Client} to be started.
+ * Registers a {@link Client} to be started. This method should be called
+ * before {@link #startServices(String)}.
*/
void registerClient(Client c);
/**
- * Registers an {@link ExecutorService} to be shut down.
+ * Registers an {@link ExecutorService} to be shut down. This method
+ * should be called before {@link #startServices(String)}.
*/
void registerForShutdown(ExecutorService e);
diff --git a/bramble-api/src/main/java/org/briarproject/bramble/api/sync/ClientVersioningManager.java b/bramble-api/src/main/java/org/briarproject/bramble/api/sync/ClientVersioningManager.java
index a449233731..8a374b288c 100644
--- a/bramble-api/src/main/java/org/briarproject/bramble/api/sync/ClientVersioningManager.java
+++ b/bramble-api/src/main/java/org/briarproject/bramble/api/sync/ClientVersioningManager.java
@@ -3,6 +3,7 @@ package org.briarproject.bramble.api.sync;
import org.briarproject.bramble.api.contact.Contact;
import org.briarproject.bramble.api.db.DbException;
import org.briarproject.bramble.api.db.Transaction;
+import org.briarproject.bramble.api.lifecycle.LifecycleManager;
import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
import org.briarproject.bramble.api.sync.Group.Visibility;
@@ -19,8 +20,17 @@ public interface ClientVersioningManager {
*/
int CLIENT_VERSION = 0;
+ /**
+ * Registers a client that will be advertised to contacts. This method
+ * should be called before {@link LifecycleManager#startServices(String)}.
+ */
void registerClient(ClientId clientId, int clientVersion);
+ /**
+ * Registers a hook that will be called when the visibility of the given
+ * client changes. This method should be called before
+ * {@link LifecycleManager#startServices(String)}.
+ */
void registerClientVersioningHook(ClientId clientId, int clientVersion,
ClientVersioningHook hook);
diff --git a/bramble-api/src/main/java/org/briarproject/bramble/api/sync/ValidationManager.java b/bramble-api/src/main/java/org/briarproject/bramble/api/sync/ValidationManager.java
index bc73714b78..56571ad976 100644
--- a/bramble-api/src/main/java/org/briarproject/bramble/api/sync/ValidationManager.java
+++ b/bramble-api/src/main/java/org/briarproject/bramble/api/sync/ValidationManager.java
@@ -3,6 +3,7 @@ package org.briarproject.bramble.api.sync;
import org.briarproject.bramble.api.db.DbException;
import org.briarproject.bramble.api.db.Metadata;
import org.briarproject.bramble.api.db.Transaction;
+import org.briarproject.bramble.api.lifecycle.LifecycleManager;
import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
/**
@@ -33,14 +34,17 @@ public interface ValidationManager {
}
/**
- * Sets the message validator for the given client.
+ * Registers the message validator for the given client. This method
+ * should be called before {@link LifecycleManager#startServices(String)}.
*/
void registerMessageValidator(ClientId c, int clientVersion,
MessageValidator v);
/**
- * Sets the incoming message hook for the given client. The hook will be
- * called once for each incoming message that passes validation.
+ * Registers the incoming message hook for the given client. The hook will
+ * be called once for each incoming message that passes validation. This
+ * method should be called before
+ * {@link LifecycleManager#startServices(String)}.
*/
void registerIncomingMessageHook(ClientId c, int clientVersion,
IncomingMessageHook hook);
--
GitLab