2002-11-13 Michael Koch <konqueror@gmx.de>

	* java/nio/channels/AlreadyConnectedException.java:
	Removed unneeded import.
	(AlreadyConnectedException): Documentation added.
	* java/nio/channels/Pipe.java
	(SinkChannel.SinkChannel): Documentation added.
	(SinkChannel.validOps): New method.
	(SourceChannel.SourceChannel): Documentation added.
	(SourceChannel.validOps): New method.
	(Pipe): Documentation added.
	(open): Documentation added.
	(SinkChannel.channel): Documentation added.
	(SourceChannel.channel): Documentation added.
	* java/nio/channel/SelectableChannel.java
	(SelectableChannel): Documentation added.
	(blockingLock): Documentation added.
	(configureBlocking):Documentation added.
	(isBlocking):Documentation added.
	(isRegistered):Documentation added.
	(keyFor):Documentation added.
	(provider):Documentation added.
	(register): Documentation added.
	(validOps): Documentation added.
	* jaba/nio/channels/SelectionKey.java
	(SelectionKey): Documentation added.
	(attach): Documentation added.
	(attachment): Documentation added.
	(isAcceptable): Documentation added.
	(isConnetable): Documentation added.
	(isReadable): Documentation added.
	(isWritable): Documentation added.
	(cancel): Documentation added.
	(channel): Documentation added.
	(interestOps): Documentation added.
	(isValid): Documentation added.
	(readyOps): Documentation added.
	(selector): Documentation added.
	* jaba/nio/channels/Selector.java
	(Selector): Documentation added.
	(open): Documentation added.
	(close): Documentation added.
	(isOpen): Documentation added.
	(keys): Documentation added.
	(provider): Documentation added.
	(select): Documentation added.
	(selectedKeys): Documentation added.
	(selectNow): Documentation added.
	(wakeup): Documentation added.
	* java/nio/channels/spi/AbstractInterruptibleChannel.java
	(AbstractInterruptibleChannel): Documentation added.
	(opened): Default to true;
	(begin): Documentation added.
	(close): Set opened to false, documentation added.
	(isOpen): Documentation added.
	* java/nio/channels/spi/AbstractSelectionKey.java
	(AbstractSelectionKey): Documentation added.
	(cancel): Documentation added.
	(isValid): Documentation added.
	* java/nio/channels/spi/AbstractSelector.java
	(AbstractSelector): Documentation added.
	(begin): Documentation added.
	(close): Documentation added.
	(isOpen): Documentation added.
	(deregister): Documentation added.
	(end): Documentation added.
	(provider): Documentation added.
	(implCloseSelector): Documentation added.
	(register): Documentation added.
	* java/nio/channels/spi/SelectorProvider.java
	(SelectorProvider): Documentation added.
	(openDatagramChannel): Documentation added.
	(openPipe): Documentation added.
	(openSelector): Documentation added.
	(openServerSocketChannel): Documentation added.
	(openSocketChannel): Documentation added.
	(provider): Documentation added.


git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@59077 138bc75d-0d04-0410-961f-82ee72b054a4

1 files changed, 74 insertions, 30 deletions

diff --git a/libjava/java/nio/channels/SelectionKey.java b/libjava/java/nio/channels/SelectionKey.java
index 6835d1d99db..8d06a301143 100644
--- a/libjava/java/nio/channels/SelectionKey.java
+++ b/libjava/java/nio/channels/SelectionKey.java
@@ -37,6 +37,10 @@ exception statement from your version. */
 
 package java.nio.channels;
 
+/**
+ * @author Michael Koch
+ * @since 1.4
+ */
 public abstract class SelectionKey
 {
   public static final int OP_ACCEPT  = 1<<0;
@@ -45,76 +49,116 @@ public abstract class SelectionKey
   public static final int OP_WRITE   = 1<<3;
     
   Object attached;
-    
-  protected SelectionKey()
+   
+  /**
+   * Initializes the selection key.
+   */
+  protected SelectionKey ()
   {
   }
 
-  public final Object attach(Object obj)
+  /**
+   * Attaches obj to the key and returns the old attached object.
+   */
+  public final Object attach (Object obj)
   {
     Object old = attached;
     attached = obj;
     return old;
   }
-    
-  public final Object attachment()
+   
+  /**
+   * Returns the object attached to the key.
+   */
+  public final Object attachment ()
   {
     return attached;
   }    
 
   /**
-   * @exception CancelledKeyException FIXME
+   * Tests if the channel attached to this key is ready to accept
+   * a new socket connection.
+   * 
+   * @exception CancelledKeyException If this key has been cancelled
    */
-  public final boolean isAcceptable()
+  public final boolean isAcceptable ()
   { 
-    return (readyOps() & OP_ACCEPT) != 0;
+    return (readyOps () & OP_ACCEPT) != 0;
   }
 
   /**
-   * @exception CancelledKeyException FIXME
+   * Tests whether this key's channel has either finished,
+   * or failed to finish, its socket-connection operation.
+   * 
+   * @exception CancelledKeyException If this key has been cancelled
    */
-  public final boolean isConnectable()
+  public final boolean isConnectable ()
   {
-    return (readyOps() & OP_CONNECT) != 0;  
+    return (readyOps () & OP_CONNECT) != 0;  
   }        
   
   /**
-   * @exception CancelledKeyException FIXME
+   * Tests if the channel attached to the key is readable.
+   * 
+   * @exception CancelledKeyException If this key has been cancelled
    */
-  public final boolean isReadable()
+  public final boolean isReadable ()
   {
-    return (readyOps() & OP_READ) != 0; 
+    return (readyOps () & OP_READ) != 0; 
   }
   
   /**
-   * @exception CancelledKeyException FIXME
+   * Tests if the channel attached to the key is writable.
+   *
+   * @exception CancelledKeyException If this key has been cancelled
    */
-  public final boolean isWritable()
+  public final boolean isWritable ()
   {
-    return (readyOps() & OP_WRITE) != 0;
+    return (readyOps () & OP_WRITE) != 0;
   }
 
-  public abstract void cancel(); 
-  
-  public abstract SelectableChannel channel();
-  
   /**
-   * @exception CancelledKeyException FIXME
+   * Requests that the registration of this key's channel with
+   * its selector be cancelled.
    */
-  public abstract int interestOps();
+  public abstract void cancel (); 
+ 
+  /**
+   * return the channel attached to the key.
+   */
+  public abstract SelectableChannel channel ();
   
   /**
-   * @exception CancelledKeyException FIXME
-   * @exception IllegalArgumentException FIXME
+   * Returns the key's interest set.
+   * 
+   * @exception CancelledKeyException If this key has been cancelled
    */
-  public abstract SelectionKey interestOps(int ops);
+  public abstract int interestOps ();
   
-  public abstract boolean isValid();
+  /**
+   * Sets this key's interest set to the given value.
+   * 
+   * @exception CancelledKeyException If this key has been cancelled
+   * @exception IllegalArgumentException If a bit in the set does not
+   * correspond to an operation that is supported by this key's channel,
+   * that is, if set &amp; ~(channel().validOps()) != 0
+   */
+  public abstract SelectionKey interestOps (int ops);
  
   /**
-   * @exception CancelledKeyException FIXME
+   * Tells whether or not this key is valid.
    */
-  public abstract int readyOps();
+  public abstract boolean isValid ();
+ 
+  /**
+   * Retrieves this key's ready-operation set.
+   * 
+   * @exception CancelledKeyException If this key has been cancelled
+   */
+  public abstract int readyOps ();
   
-  public abstract Selector selector();
+  /**
+   * Returns the selector for which this key was created.
+   */
+  public abstract Selector selector ();
 }