diff options
Diffstat (limited to 'tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java')
| -rw-r--r-- | tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java | 11 |
1 files changed, 10 insertions, 1 deletions
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..dbc91c27 100644 --- a/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java +++ b/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java @@ -1,5 +1,5 @@ /* - * Copyright © 2020 WireGuard LLC. All Rights Reserved. + * Copyright © 2017-2025 WireGuard LLC. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0 */ @@ -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; } |