This is the mail archive of the java-patches@gcc.gnu.org mailing list for the Java project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[Patch] java.nio.channels documentation


Hi list,


I commited the attached patch to add exception documentation to 
DatagramChannel and SocketChannel in java.nio.channels.


Michael
-- 
Homepage: http://www.worldforge.org/
GPG-key: http://konqueror.dyndns.org/~mkoch/michael.gpg
Index: ChangeLog
===================================================================
RCS file: /cvs/gcc/gcc/libjava/ChangeLog,v
retrieving revision 1.1566
diff -b -u -r1.1566 ChangeLog
--- ChangeLog	29 Nov 2002 09:57:04 -0000	1.1566
+++ ChangeLog	29 Nov 2002 12:01:22 -0000
@@ -1,5 +1,24 @@
 2002-11-29  Michael Koch <konqueror@gmx.de>
 
+	* java/nio/channels/DatagramChannel.java
+	(open): Added exception documentation.
+	(write): Added exception documentation.
+	(connect): Added exception documentation.
+	(disconnect): Added exception documentation.
+	(isConnected): Added exception documentation.
+	(read): Added exception documentation.
+	(receive): Added exception documentation.
+	(send): Added exception documentation.
+	(validOps): Added exception documentation.
+	* java/nio/channels/SocketChannel.java
+	(open): Added exception documentation.
+	(read): Added exception documentation.
+	(write): Added exception documentation.
+	(connect): Added exception documentation.
+	(finishConnect): Added exception documentation.
+	
+2002-11-29  Michael Koch <konqueror@gmx.de>
+
 	* gnu/java/nio/DatagramChannelImpl:
 	(fd): New member variable to store file descriptor of socket.
 	* gnu/java/nio/SelectionKeyImpl.java:
Index: java/nio/channels/DatagramChannel.java
===================================================================
RCS file: /cvs/gcc/gcc/libjava/java/nio/channels/DatagramChannel.java,v
retrieving revision 1.4
diff -b -u -r1.4 DatagramChannel.java
--- java/nio/channels/DatagramChannel.java	13 Nov 2002 12:21:25 -0000	1.4
+++ java/nio/channels/DatagramChannel.java	29 Nov 2002 12:01:22 -0000
@@ -61,6 +61,8 @@
 
   /**
    * Opens a datagram channel.
+   *
+   * @exception IOException If an error occurs
    */
   public static DatagramChannel open () throws IOException
   {
@@ -82,6 +84,9 @@
   
   /**
    * Writes data to this channel.
+   *
+   * @exception IOException If an error occurs
+   * @exception NotYetConnectedException The channel's socket is not connected.
    */
   public final long write (ByteBuffer[] srcs)
   {
@@ -95,16 +100,31 @@
     
   /**
    * Connects this channel's socket.
+   *
+   * @exception AsynchronousCloseException If another thread closes this channel
+   * while the connect operation is in progress.
+   * @exception ClosedByInterruptException If another thread interrupts the
+   * current thread while the read operation is in progress, thereby closing the
+   * channel and setting the current thread's interrupt status.
+   * @exception ClosedChannelException If this channel is closed.
+   * @exception IOException If an error occurs.
+   * @exception SecurityException If a security manager has been installed and
+   * it does not permit datagrams to be sent to the given address.
    */
   public abstract DatagramChannel connect (SocketAddress remote);
 
   /**
    * Disonnects this channel's socket.
+   *
+   * @exception IOException If an error occurs
    */
   public abstract DatagramChannel disconnect ();
 
   /**
    * Tells whether or not this channel's socket is connected.
+   *
+   * @exception IOException If an error occurs.
+   * @exception NotYetConnectedException The channel's socket is not connected.
    */
   public abstract boolean isConnected ();
   
@@ -115,16 +135,39 @@
   
   /**
    * Reads data from this channel.
+   *
+   * @exception IOException If an error occurs.
+   * @exception NotYetConnectedException The channel's socket is not connected.
    */
   public abstract long read (ByteBuffer[] dsts, int offset, int length);
  
   /**
    * Receives a datagram via this channel.
+   *
+   * @exception AsynchronousCloseException If another thread closes this channel
+   * while the connect operation is in progress.
+   * @exception ClosedByInterruptException If another thread interrupts the
+   * current thread while the read operation is in progress, thereby closing the
+   * channel and setting the current thread's interrupt status.
+   * @exception ClosedChannelException If this channel is closed.
+   * @exception IOException If an error occurs
+   * @exception SecurityException If a security manager has been installed and
+   * it does not permit datagrams to be sent to the given address.
    */
   public abstract SocketAddress receive (ByteBuffer dst);
  
   /**
    * Sends a datagram via this channel.
+   *
+   * @exception AsynchronousCloseException If another thread closes this channel
+   * while the connect operation is in progress.
+   * @exception ClosedByInterruptException If another thread interrupts the
+   * current thread while the read operation is in progress, thereby closing the
+   * channel and setting the current thread's interrupt status.
+   * @exception ClosedChannelException If this channel is closed.
+   * @exception IOException If an error occurs
+   * @exception SecurityException If a security manager has been installed and
+   * it does not permit datagrams to be sent to the given address.
    */
   public abstract int send (ByteBuffer src, SocketAddress target);
  
@@ -135,16 +178,25 @@
   
   /**
    * Writes data to this channel.
+   *
+   * @exception IOException If an error occurs.
+   * @exception NotYetConnectedException The channel's socket is not connected.
    */
   public abstract int write (ByteBuffer src);
   
   /**
    * Writes data to this channel.
+   *
+   * @exception IOException If an error occurs.
+   * @exception NotYetConnectedException The channel's socket is not connected.
    */
   public abstract long write (ByteBuffer[] srcs, int offset, int length);
 
   /**
    * Retrieves the valid operations for this channel.
+   *
+   * @exception IOException If an error occurs.
+   * @exception NotYetConnectedException The channel's socket is not connected.
    */
   public final int validOps ()
   {
Index: java/nio/channels/SocketChannel.java
===================================================================
RCS file: /cvs/gcc/gcc/libjava/java/nio/channels/SocketChannel.java,v
retrieving revision 1.4
diff -b -u -r1.4 SocketChannel.java
--- java/nio/channels/SocketChannel.java	13 Nov 2002 12:21:25 -0000	1.4
+++ java/nio/channels/SocketChannel.java	29 Nov 2002 12:01:22 -0000
@@ -60,6 +60,8 @@
  
   /**
    * Opens a socket channel.
+   *
+   * @exception IOException If an error occurs
    */
   public static SocketChannel open () throws IOException
   {
@@ -68,6 +70,18 @@
   
   /**
    * Opens a channel and connects it to a remote address.
+   *
+   * @exception AsynchronousCloseException If this channel is already connected.
+   * @exception ClosedByInterruptException If another thread interrupts the
+   * current thread while the connect operation is in progress, thereby closing
+   * the channel and setting the current thread's interrupt status.
+   * @exception IOException If an error occurs
+   * @exception SecurityException If a security manager has been installed and
+   * it does not permit access to the given remote endpoint.
+   * @exception UnresolvedAddressException If the given remote address is not
+   * fully resolved.
+   * @exception UnsupportedAddressTypeException If the type of the given remote
+   * address is not supported.
    */
   public static SocketChannel open (SocketAddress remote) throws IOException
   {
@@ -82,6 +96,9 @@
     
   /**
    * Reads data from the channel.
+   *
+   * @exception IOException If an error occurs
+   * @exception NotYetConnectedException If this channel is not yet connected.
    */
   public final long read (ByteBuffer[] dsts)
   {
@@ -97,6 +114,9 @@
     
   /**
    * Writes data to the channel.
+   *
+   * @exception IOException If an error occurs
+   * @exception NotYetConnectedException If this channel is not yet connected.
    */
   public final long write (ByteBuffer[] dsts)
   {
@@ -120,16 +140,44 @@
 
   /**
    * Reads data from the channel.
+   *
+   * @exception IOException If an error occurs
+   * @exception NotYetConnectedException If this channel is not yet connected.
    */
   public abstract int read (ByteBuffer dst);
 
   /**
    * Connects the channel's socket to the remote address.
+   *
+   * @exception AlreadyConnectedException If this channel is already connected.
+   * @exception AsynchronousCloseException If this channel is already connected.
+   * @exception ClosedByInterruptException If another thread interrupts the
+   * current thread while the connect operation is in progress, thereby closing
+   * the channel and setting the current thread's interrupt status.
+   * @exception ClosedChannelException If this channel is closed.
+   * @exception ConnectionPendingException If a non-blocking connection
+   * operation is already in progress on this channel.
+   * @exception IOException If an error occurs
+   * @exception SecurityException If a security manager has been installed and
+   * it does not permit access to the given remote endpoint.
+   * @exception UnresolvedAddressException If the given remote address is not
+   * fully resolved.
+   * @exception UnsupportedAddressTypeException If the type of the given remote
+   * address is not supported.
    */
   public abstract boolean connect (SocketAddress remote) throws IOException;
   
   /**
    * Finishes the process of connecting a socket channel.
+   *
+   * @exception AsynchronousCloseException If this channel is already connected.
+   * @exception ClosedByInterruptException If another thread interrupts the
+   * current thread while the connect operation is in progress, thereby closing
+   * the channel and setting the current thread's interrupt status.
+   * @exception ClosedChannelException If this channel is closed.
+   * @exception IOException If an error occurs
+   * @exception NoConnectionPendingException If this channel is not connected
+   * and a connection operation has not been initiated.
    */
   public abstract boolean finishConnect ();
  
@@ -145,6 +193,9 @@
   
   /**
    * Reads data from the channel.
+   *
+   * @exception IOException If an error occurs
+   * @exception NotYetConnectedException If this channel is not yet connected.
    */
   public abstract long read (ByteBuffer[] dsts, int offset, int length);
  
@@ -155,11 +206,17 @@
   
   /**
    * Writes data to the channel.
+   *
+   * @exception IOException If an error occurs
+   * @exception NotYetConnectedException If this channel is not yet connected.
    */
   public abstract int write (ByteBuffer src);
   
   /**
    * Writes data to the channel.
+   *
+   * @exception IOException If an error occurs
+   * @exception NotYetConnectedException If this channel is not yet connected.
    */
   public abstract long write (ByteBuffer[] srcs, int offset, int length);
 }

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]