jdk/src/share/classes/java/nio/channels/package-info.java
changeset 19034 d068b8fff162
parent 7668 d4a77089c587
child 21278 ef8a3a2a72f2
equal deleted inserted replaced
19033:13013b301bd0 19034:d068b8fff162
     1 /*
     1 /*
     2  * Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved.
     2  * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.  Oracle designates this
     7  * published by the Free Software Foundation.  Oracle designates this
    29  * multiplexed, non-blocking I/O operations.
    29  * multiplexed, non-blocking I/O operations.
    30  *
    30  *
    31  * <a name="channels"></a>
    31  * <a name="channels"></a>
    32  *
    32  *
    33  * <blockquote><table cellspacing=1 cellpadding=0 summary="Lists channels and their descriptions">
    33  * <blockquote><table cellspacing=1 cellpadding=0 summary="Lists channels and their descriptions">
    34  * <tr><th><p align="left">Channels</p></th><th><p align="left">Description</p></th></tr>
    34  * <tr><th align="left">Channels</th><th align="left">Description</th></tr>
    35  * <tr><td valign=top><tt><i>{@link java.nio.channels.Channel}</i></tt></td>
    35  * <tr><td valign=top><tt><i>{@link java.nio.channels.Channel}</i></tt></td>
    36  *     <td>A nexus for I/O operations</td></tr>
    36  *     <td>A nexus for I/O operations</td></tr>
    37  * <tr><td valign=top><tt>&nbsp;&nbsp;<i>{@link java.nio.channels.ReadableByteChannel}</i></tt></td>
    37  * <tr><td valign=top><tt>&nbsp;&nbsp;<i>{@link java.nio.channels.ReadableByteChannel}</i></tt></td>
    38  *     <td>Can read into a buffer</td></tr>
    38  *     <td>Can read into a buffer</td></tr>
    39  * <tr><td valign=top><tt>&nbsp;&nbsp;&nbsp;&nbsp;<i>{@link java.nio.channels.ScatteringByteChannel}&nbsp;&nbsp;</i></tt></td>
    39  * <tr><td valign=top><tt>&nbsp;&nbsp;&nbsp;&nbsp;<i>{@link java.nio.channels.ScatteringByteChannel}&nbsp;&nbsp;</i></tt></td>
   108  * from a given readable byte channel, and conversely a {@link java.io.Writer} can
   108  * from a given readable byte channel, and conversely a {@link java.io.Writer} can
   109  * be constructed that uses a given charset to encode characters into bytes and
   109  * be constructed that uses a given charset to encode characters into bytes and
   110  * write them to a given writable byte channel.
   110  * write them to a given writable byte channel.
   111  *
   111  *
   112  * <blockquote><table cellspacing=1 cellpadding=0 summary="Lists file channels and their descriptions">
   112  * <blockquote><table cellspacing=1 cellpadding=0 summary="Lists file channels and their descriptions">
   113  * <tr><th><p align="left">File channels</p></th><th><p align="left">Description</p></th></tr>
   113  * <tr><th align="left">File channels</th><th align="left">Description</th></tr>
   114  * <tr><td valign=top><tt>{@link java.nio.channels.FileChannel}</tt></td>
   114  * <tr><td valign=top><tt>{@link java.nio.channels.FileChannel}</tt></td>
   115  *     <td>Reads, writes, maps, and manipulates files</td></tr>
   115  *     <td>Reads, writes, maps, and manipulates files</td></tr>
   116  * <tr><td valign=top><tt>{@link java.nio.channels.FileLock}</tt></td>
   116  * <tr><td valign=top><tt>{@link java.nio.channels.FileLock}</tt></td>
   117  *     <td>A lock on a (region of a) file</td></tr>
   117  *     <td>A lock on a (region of a) file</td></tr>
   118  * <tr><td valign=top><tt>{@link java.nio.MappedByteBuffer}&nbsp;&nbsp;</tt></td>
   118  * <tr><td valign=top><tt>{@link java.nio.MappedByteBuffer}&nbsp;&nbsp;</tt></td>
   136  * file channel connected to the same underlying file as the <tt>{@link java.io}</tt>
   136  * file channel connected to the same underlying file as the <tt>{@link java.io}</tt>
   137  * class.
   137  * class.
   138  *
   138  *
   139  * <a name="multiplex"></a>
   139  * <a name="multiplex"></a>
   140  * <blockquote><table cellspacing=1 cellpadding=0 summary="Lists multiplexed, non-blocking channels and their descriptions">
   140  * <blockquote><table cellspacing=1 cellpadding=0 summary="Lists multiplexed, non-blocking channels and their descriptions">
   141  * <tr><th><p align="left">Multiplexed, non-blocking I/O</p></th><th><p align="left">Description</p></th></tr>
   141  * <tr><th align="left">Multiplexed, non-blocking I/O</th><th align="left"><p>Description</th></tr>
   142  * <tr><td valign=top><tt>{@link java.nio.channels.SelectableChannel}</tt></td>
   142  * <tr><td valign=top><tt>{@link java.nio.channels.SelectableChannel}</tt></td>
   143  *     <td>A channel that can be multiplexed</td></tr>
   143  *     <td>A channel that can be multiplexed</td></tr>
   144  * <tr><td valign=top><tt>&nbsp;&nbsp;{@link java.nio.channels.DatagramChannel}</tt></td>
   144  * <tr><td valign=top><tt>&nbsp;&nbsp;{@link java.nio.channels.DatagramChannel}</tt></td>
   145  *     <td>A channel to a datagram-oriented socket</td></tr>
   145  *     <td>A channel to a datagram-oriented socket</td></tr>
   146  * <tr><td valign=top><tt>&nbsp;&nbsp;{@link java.nio.channels.Pipe.SinkChannel}</tt></td>
   146  * <tr><td valign=top><tt>&nbsp;&nbsp;{@link java.nio.channels.Pipe.SinkChannel}</tt></td>
   223  * java.nio.channels.SelectableChannel} subclasses defined in this package.
   223  * java.nio.channels.SelectableChannel} subclasses defined in this package.
   224  *
   224  *
   225  * <a name="async"></a>
   225  * <a name="async"></a>
   226  *
   226  *
   227  * <blockquote><table cellspacing=1 cellpadding=0 summary="Lists asynchronous channels and their descriptions">
   227  * <blockquote><table cellspacing=1 cellpadding=0 summary="Lists asynchronous channels and their descriptions">
   228  * <tr><th><p align="left">Asynchronous I/O</p></th><th><p align="left">Description</p></th></tr>
   228  * <tr><th align="left">Asynchronous I/O</th><th align="left">Description</th></tr>
   229  * <tr><td valign=top><tt>{@link java.nio.channels.AsynchronousFileChannel}</tt></td>
   229  * <tr><td valign=top><tt>{@link java.nio.channels.AsynchronousFileChannel}</tt></td>
   230  *     <td>An asynchronous channel for reading, writing, and manipulating a file</td></tr>
   230  *     <td>An asynchronous channel for reading, writing, and manipulating a file</td></tr>
   231  * <tr><td valign=top><tt>{@link java.nio.channels.AsynchronousSocketChannel}</tt></td>
   231  * <tr><td valign=top><tt>{@link java.nio.channels.AsynchronousSocketChannel}</tt></td>
   232  *     <td>An asynchronous channel to a stream-oriented connecting socket</td></tr>
   232  *     <td>An asynchronous channel to a stream-oriented connecting socket</td></tr>
   233  * <tr><td valign=top><tt>{@link java.nio.channels.AsynchronousServerSocketChannel}&nbsp;&nbsp;</tt></td>
   233  * <tr><td valign=top><tt>{@link java.nio.channels.AsynchronousServerSocketChannel}&nbsp;&nbsp;</tt></td>