Package com.sshtools.client.shell

Enum ExpectShell.OS

java.lang.Object
java.lang.Enum<ExpectShell.OS>
com.sshtools.client.shell.ExpectShell.OS
All Implemented Interfaces:
Serializable, Comparable<ExpectShell.OS>, java.lang.constant.Constable
Enclosing class:
ExpectShell
public static enum ExpectShell.OS extends Enum<ExpectShell.OS>
Enumeration of operating systems, that also encapsulates some operating specific information

  • Enum Constant Details

  • Method Details

    • values

      public static ExpectShell.OS[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ExpectShell.OS valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • code

      @Deprecated(forRemoval=true, since="3.1.3") public int code()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the legacy operating system code for this operating system.
      Returns:
      code

    • code

      @Deprecated(forRemoval=true, since="3.1.3") public static ExpectShell.OS code(int code)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get an ExpectShell.OS given the legacy code (see the constants in ExpectShell.
      Parameters:
      code - legacy code
      Returns:
      operating system constant

    • description

      public String description()
      Get a description of the operating system.
      Returns:
      description

    • exitCodeVariable

      public String exitCodeVariable()
      Get the exit code variable this operating system uses.
      Returns:
      exit code variable

    • echoCommand

      public String echoCommand()
      Get the command this operating system uses to echo content back to the terminal.
      Returns:
      echo command

    • pipeCommand

      public String pipeCommand()
      Get the pipe command, if this OS has one.
      Returns:
      pipe command

    • eol

      public String eol()
      Get the end of line sequence.
      Returns: