Enum AbstractClientChannel.NullIoInputStream

java.lang.Object
java.lang.Enum<AbstractClientChannel.NullIoInputStream>
org.apache.sshd.client.channel.AbstractClientChannel.NullIoInputStream
All Implemented Interfaces:
Closeable, Serializable, AutoCloseable, Comparable<AbstractClientChannel.NullIoInputStream>, Channel, Closeable, IoInputStream
Enclosing class:
AbstractClientChannel

private static enum AbstractClientChannel.NullIoInputStream extends Enum<AbstractClientChannel.NullIoInputStream> implements IoInputStream
  • Enum Constant Details

  • Field Details

  • Constructor Details

    • NullIoInputStream

      private NullIoInputStream()
  • Method Details

    • values

      public static AbstractClientChannel.NullIoInputStream[] 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 AbstractClientChannel.NullIoInputStream 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
    • close

      public CloseFuture close(boolean immediately)
      Description copied from interface: Closeable
      Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.
      Specified by:
      close in interface Closeable
      Parameters:
      immediately - true if the resource should be shut down abruptly, false for a graceful close
      Returns:
      a CloseFuture representing the close request
    • addCloseFutureListener

      public void addCloseFutureListener(SshFutureListener<CloseFuture> listener)
      Description copied from interface: Closeable
      Pre-register a listener to be informed when resource is closed. If resource is already closed, the listener will be invoked immediately and not registered for future notification
      Specified by:
      addCloseFutureListener in interface Closeable
      Parameters:
      listener - The notification SshFutureListener - never null
    • removeCloseFutureListener

      public void removeCloseFutureListener(SshFutureListener<CloseFuture> listener)
      Description copied from interface: Closeable
      Remove a pre-registered close event listener
      Specified by:
      removeCloseFutureListener in interface Closeable
      Parameters:
      listener - The register SshFutureListener - never null. Ignored if not registered or resource already closed
    • isClosed

      public boolean isClosed()
      Description copied from interface: Closeable
      Returns true if this object has been closed.
      Specified by:
      isClosed in interface Closeable
      Returns:
      true if closing
    • isClosing

      public boolean isClosing()
      Description copied from interface: Closeable
      Returns true if the Closeable.close(boolean) method has been called. Note that this method will return true even if this Closeable.isClosed() returns true.
      Specified by:
      isClosing in interface Closeable
      Returns:
      true if closing
    • read

      public IoReadFuture read(Buffer buffer)
      Description copied from interface: IoInputStream
      NOTE: the buffer must not be touched until the returned read future is completed.
      Specified by:
      read in interface IoInputStream
      Parameters:
      buffer - the Buffer to use
      Returns:
      The IoReadFuture for the operation