From ff7d7e0edd9fbcafeea3bfb56c8d3a1f136efb56 Mon Sep 17 00:00:00 2001 From: Harsh Shandilya Date: Wed, 16 Sep 2020 16:12:59 +0530 Subject: tunnel: document more public API from backend package Signed-off-by: Harsh Shandilya --- tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java') diff --git a/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java b/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java index a9761929..2f12f6c3 100644 --- a/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java +++ b/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java @@ -36,11 +36,20 @@ public interface Tunnel { */ void onStateChange(State newState); + /** + * Enum class to represent all possible states of a {@link Tunnel}. + */ enum State { DOWN, TOGGLE, UP; + /** + * Get the state of a {@link Tunnel} + * + * @param running boolean indicating if the tunnel is running. + * @return State of the tunnel based on whether or not it is running. + */ public static State of(final boolean running) { return running ? UP : DOWN; } -- cgit v1.2.3