Class AbstractSelectionKey

java.lang.Object
java.nio.channels.SelectionKey
java.nio.channels.spi.AbstractSelectionKey

public abstract class AbstractSelectionKey extends SelectionKey
Base implementation class for selection keys.

This class tracks the validity of the key and implements cancellation.

Since:
1.4
  • Field Summary

    Fields declared in class SelectionKey

    OP_ACCEPT, OP_CONNECT, OP_READ, OP_WRITE
    Modifier and Type
    Field
    Description
    static final int
    Operation-set bit for socket-accept operations.
    static final int
    Operation-set bit for socket-connect operations.
    static final int
    Operation-set bit for read operations.
    static final int
    Operation-set bit for write operations.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Initializes a new instance of this class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    Cancels this key.
    final boolean
    Tells whether or not this key is valid.

    Methods declared in class SelectionKey

    attach, attachment, channel, interestOps, interestOps, interestOpsAnd, interestOpsOr, isAcceptable, isConnectable, isReadable, isWritable, readyOps, selector
    Modifier and Type
    Method
    Description
    final Object
    Attaches the given object to this key.
    final Object
    Retrieves the current attachment.
    Returns the channel for which this key was created.
    abstract int
    Retrieves this key's interest set.
    abstract SelectionKey
    interestOps(int ops)
    Sets this key's interest set to the given value.
    int
    interestOpsAnd(int ops)
    Atomically sets this key's interest set to the bitwise intersection ("and") of the existing interest set and the given value.
    int
    interestOpsOr(int ops)
    Atomically sets this key's interest set to the bitwise union ("or") of the existing interest set and the given value.
    final boolean
    Tests whether this key's channel is ready to accept a new socket connection.
    final boolean
    Tests whether this key's channel has either finished, or failed to finish, its socket-connection operation.
    final boolean
    Tests whether this key's channel is ready for reading.
    final boolean
    Tests whether this key's channel is ready for writing.
    abstract int
    Retrieves this key's ready-operation set.
    abstract Selector
    Returns the selector for which this key was created.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    Creates and returns a copy of this object.
    boolean
    Indicates whether some other object is "equal to" this one.
    protected void
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    Returns the runtime class of this Object.
    int
    Returns a hash code value for this object.
    final void
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    Wakes up all threads that are waiting on this object's monitor.
    Returns a string representation of the object.
    final void
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
  • Constructor Details

    • AbstractSelectionKey

      protected AbstractSelectionKey()
      Initializes a new instance of this class.
  • Method Details

    • isValid

      public final boolean isValid()
      Description copied from class: SelectionKey
      Tells whether or not this key is valid.

      A key is valid upon creation and remains so until it is cancelled, its channel is closed, or its selector is closed.

      Specified by:
      isValid in class SelectionKey
      Returns:
      true if, and only if, this key is valid
    • cancel

      public final void cancel()
      Cancels this key.

      If this key has not yet been cancelled then it is added to its selector's cancelled-key set while synchronized on that set.

      Specified by:
      cancel in class SelectionKey