Interface Environment

All Known Implementing Classes:
StandardEnvironment

public interface Environment
Interface providing access to the environment map and allowing the registration of listeners for certain signals.
See Also:
  • Field Details

    • ENV_USER

      static final String ENV_USER
      Key for the user environment variable
      See Also:
    • ENV_LINES

      static final String ENV_LINES
      Key for the lines environment variable. Specifies the number of lines visible on the client side. ENV_LINES and ENV_COLUMNS make up the console screen size.
      See Also:
    • ENV_COLUMNS

      static final String ENV_COLUMNS
      Key for the columns environment variable. Specifies the number of columns visible on the client side. ENV_LINES and ENV_COLUMNS make up the console screen size.
      See Also:
    • ENV_TERM

      static final String ENV_TERM
      Key for the term environment variable. Describes the terminal or terminal emulation which is in use.
      See Also:
  • Method Details

    • getEnv

      Map<String,String> getEnv()
      Retrieve the environment map
      Returns:
      the environment Map - never null
    • getPtyModes

      Map<PtyMode,Integer> getPtyModes()
      Retrieve the PTY modes settings
      Returns:
      the Map of PtyModes - never null
    • addSignalListener

      default void addSignalListener(SignalListener listener, Signal... signals)
      Add a qualified listener for the specific signals
      Parameters:
      listener - the SignalListener to register
      signals - The (never null/empty) Signals the listener is interested in
    • addSignalListener

      default void addSignalListener(SignalListener listener)
      Add a global listener for all signals
      Parameters:
      listener - the SignalListener to register
    • addSignalListener

      void addSignalListener(SignalListener listener, Collection<Signal> signals)
      Add a qualified listener for the specific signals
      Parameters:
      listener - the SignalListener to register
      signals - the Signals the listener is interested in
    • removeSignalListener

      void removeSignalListener(SignalListener listener)
      Remove a previously registered listener for all the signals it was registered
      Parameters:
      listener - the SignalListener to remove