Package com.wireguard.android.backend

Enum Tunnel.State

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Tunnel.State>
    Enclosing interface:
    Tunnel
    public static enum Tunnel.State
extends java.lang.Enum<Tunnel.State>
    Enum class to represent all possible states of a Tunnel.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DOWN  
      TOGGLE  
      UP  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Tunnel.State of​(boolean running)
      Get the state of a Tunnel
      static Tunnel.State valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Tunnel.State[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static Tunnel.State[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Tunnel.State c : Tunnel.State.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Tunnel.State valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • of

        public static Tunnel.State of​(boolean running)
        Get the state of a Tunnel
        Parameters:
        running - boolean indicating if the tunnel is running.
        Returns:
        State of the tunnel based on whether or not it is running.