AlreadyConnectedException.java: Removed unneeded import.

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.

From-SVN: r59077

1 files changed, 74 insertions, 25 deletions

diff --git a/libjava/java/nio/channels/SelectableChannel.java b/libjava/java/nio/channels/SelectableChannel.java
index 7b3a50e9bcd..2bc5cc47e35 100644
--- a/libjava/java/nio/channels/SelectableChannel.java
+++ b/libjava/java/nio/channels/SelectableChannel.java
@@ -40,50 +40,99 @@ package java.nio.channels;
 import java.nio.channels.spi.AbstractInterruptibleChannel;
 import java.nio.channels.spi.SelectorProvider;
 
+/**
+ * @author Michael Koch
+ * @since 1.4
+ */
 public abstract class SelectableChannel
   extends AbstractInterruptibleChannel
 {
-  protected SelectableChannel()
+  /**
+   * Initializes the channel.
+   */
+  protected SelectableChannel ()
   {
   }
-  
-  public abstract  Object blockingLock();
+ 
+  /**
+   * Returns the lock of this channel.
+   */
+  public abstract Object blockingLock ();
 
   /**
-   * @exception ClosedChannelException FIXME
-   * @exception IllegalBlockingModeException FIXME
-   * @exception IOException FIXME
+   * Adjusts this channel's blocking mode.
+   * 
+   * @exception ClosedChannelException If this channel is closed.
+   * @exception IllegalBlockingModeException If block is true and this channel
+   * is registered with one or more selectors.
+   * @exception IOException If an error occurs.
    */
-  public abstract  SelectableChannel configureBlocking(boolean block);
+  public abstract SelectableChannel configureBlocking (boolean block);
   
-  public abstract  boolean isBlocking();
+  /**
+   * Tells whether this channel is blocking or not.
+   */
+  public abstract boolean isBlocking ();
   
-  public abstract  boolean isRegistered();
+  /**
+   * Tells whether or not this channel is currently registered with
+   * any selectors.
+   */
+  public abstract boolean isRegistered ();
   
-  public abstract  SelectionKey keyFor(Selector sel);
+  /**
+   * Retrieves the key representing the channel's registration with
+   * the given selector.
+   */
+  public abstract SelectionKey keyFor (Selector sel);
   
-  public abstract  SelectorProvider provider();
+  /**
+   * Returns the provider that created this channel.
+   */
+  public abstract SelectorProvider provider ();
   
   /**
-   * @exception CancelledKeyException FIXME
-   * @exception ClosedChannelException FIXME
-   * @exception IllegalArgumentException FIXME
-   * @exception IllegalBlockingModeException FIXME
-   * @exception IllegalSelectorException FIXME
+   * Registers this channel with the given selector,
+   * returning a selection key.
+   * 
+   * @exception CancelledKeyException If this channel is currently registered
+   * with the given selector but the corresponding key has already been cancelled
+   * @exception ClosedChannelException If this channel is closed.
+   * @exception IllegalArgumentException If a bit in ops does not correspond
+   * to an operation that is supported by this channel, that is, if
+   * set & ~validOps() != 0.
+   * @exception IllegalBlockingModeException If block is true and this channel
+   * is registered with one or more selectors.
+   * @exception IllegalSelectorException If this channel was not created by
+   * the same provider as the given selector.
    */
-  public final SelectionKey register(Selector sel, int ops) throws java.nio.channels.ClosedChannelException
+  public final SelectionKey register (Selector sel, int ops)
+    throws ClosedChannelException
   {
-    return register(sel, ops, null);
+    return register (sel, ops, null);
   }
   
   /**
-   * @exception CancelledKeyException FIXME
-   * @exception ClosedChannelException FIXME
-   * @exception IllegalArgumentException FIXME
-   * @exception IllegalBlockingModeException FIXME
-   * @exception IllegalSelectorException FIXME
+   * Registers this channel with the given selector,
+   * returning a selection key.
+   *
+   * @exception CancelledKeyException If this channel is currently registered
+   * with the given selector but the corresponding key has already been
+   * cancelled.
+   * @exception ClosedChannelException If this channel is closed.
+   * @exception IllegalArgumentException If a bit in ops does not correspond
+   * to an operation that is supported by this channel, that is, if
+   * set & ~validOps() != 0.
+   * @exception IllegalBlockingModeException If block is true and this channel
+   * is registered with one or more selectors.
+   * @exception IllegalSelectorException If this channel was not created by
+   * the same provider as the given selector.
    */
-  public abstract  SelectionKey register(Selector sel, int ops, Object att) throws java.nio.channels.ClosedChannelException;
+  public abstract SelectionKey register (Selector sel, int ops, Object att)
+    throws ClosedChannelException;
   
-  public abstract  int validOps();  
+  /**
+   * Returns a set of valid operations on this channel.
+   */
+  public abstract int validOps();
 }