From 68acbe5c7d4f57ce5c2abbd270b21008d4ba4195 Mon Sep 17 00:00:00 2001 From: akwizgran Date: Tue, 1 Jun 2021 11:33:06 +0100 Subject: [PATCH] Add javadocs for message states. --- .../api/sync/validation/MessageState.java | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/MessageState.java b/bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/MessageState.java index 42a1adb85..770d57617 100644 --- a/bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/MessageState.java +++ b/bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/MessageState.java @@ -1,8 +1,33 @@ package org.briarproject.bramble.api.sync.validation; +import org.briarproject.bramble.api.sync.validation.IncomingMessageHook.DeliveryAction; + public enum MessageState { - UNKNOWN(0), INVALID(1), PENDING(2), DELIVERED(3); + /** + * A remote message that has not yet been validated. + */ + UNKNOWN(0), + + /** + * A remote message that has failed validation, has been + * {@link DeliveryAction#REJECT rejected} by the local sync client, or + * depends on another message that has failed validation or been rejected. + */ + INVALID(1), + + /** + * A remote message that has passed validation and is awaiting delivery to + * the local sync client. The message will not be delivered until all its + * dependencies have been validated and delivered. + */ + PENDING(2), + + /** + * A local message, or a remote message that has passed validation and + * been delivered to the local sync client. + */ + DELIVERED(3); private final int value;