jdk/src/java.base/share/classes/java/nio/package-info.java
author jjg
Thu, 10 Aug 2017 15:21:17 -0700
changeset 46147 047bdc4d771d
parent 45437 c48b8edad8dd
permissions -rw-r--r--
8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages Reviewed-by: bpb, smarks
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     1
/*
45433
01ecdcf197df 8181290: Invalid HTML 5 in core-libs docs
jjg
parents: 32143
diff changeset
     2
 * Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     4
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    10
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    15
 * accompanied this code).
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    16
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    20
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    23
 * questions.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    24
 */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    26
/**
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    27
 * Defines buffers, which are containers for data, and provides an
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    28
 * overview of the other NIO packages.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    29
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    30
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    31
 * <p> The central abstractions of the NIO APIs are: </p>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    32
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    33
 * <ul>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    34
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    35
 *   <li><p> <a href="#buffers"><i>Buffers</i></a>, which are containers for data;
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    36
 *   </p></li>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    37
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    38
 *   <li><p> <a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    39
 *   href="charset/package-summary.html"><i>Charsets</i></a> and their
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    40
 *   associated <i>decoders</i> and <i>encoders</i>, <br> which
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    41
 *   translate between bytes and Unicode characters; </p></li>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    42
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    43
 *   <li><p> <a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    44
 *   href="channels/package-summary.html"><i>Channels</i></a> of
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    45
 *   various types, which represent connections <br> to entities
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    46
 *   capable of performing I/O operations; and </p></li>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    47
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    48
 *   <li><p> <i>Selectors</i> and <i>selection keys</i>, which
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    49
 *   together with <br> <i>selectable channels</i> define a <a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    50
 *   href="channels/package-summary.html#multiplex">multiplexed,
46147
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    51
 *   non-blocking <br> I/O</a> facility.  </p></li>
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    52
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    53
 *  </ul>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    54
 *
32143
394ab6a6658d 8133459: replace <tt> tags (obsolete in html5) in java.nio docs
avstepan
parents: 30788
diff changeset
    55
 * <p> The {@code java.nio} package defines the buffer classes, which
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    56
 * are used throughout the NIO APIs.  The charset API is defined in
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    57
 * the {@link java.nio.charset} package, and the channel and selector
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    58
 * APIs are defined in the {@link java.nio.channels} package.  Each of
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    59
 * these subpackages has its own service-provider (SPI) subpackage,
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    60
 * the contents of which can be used to extend the platform's default
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    61
 * implementations or to construct alternative implementations.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    62
 *
45433
01ecdcf197df 8181290: Invalid HTML 5 in core-libs docs
jjg
parents: 32143
diff changeset
    63
 * <a id="buffers"> </a>
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    64
 *
46147
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    65
 * <table class="striped" style="margin-left:2em; text-align:left">
45437
c48b8edad8dd 8181156: html5 issues in java.base javadoc
rriggs
parents: 45433
diff changeset
    66
 *     <caption style="display:none">Description of the various buffers</caption>
46147
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    67
 *   <thead>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    68
 *   <tr><th scope="col">Buffers</th>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    69
 *       <th scope="col">Description</th></tr>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    70
 *   </thead>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    71
 *   <tbody>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    72
 *   <tr><th scope="row">{@link java.nio.Buffer}</th>
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    73
 *       <td>Position, limit, and capacity;
46147
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    74
 *           clear, flip, rewind, and mark/reset</td></tr>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    75
 *   <tr><th scope="row">
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    76
 *         <span style="padding-left:1em">{@link java.nio.ByteBuffer}</span></th>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    77
 *       <td>Get/put, compact, views; allocate, wrap</td></tr>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    78
 *   <tr><th scope="row">
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    79
 *         <span style="padding-left:2em">{@link java.nio.MappedByteBuffer}</span></th>
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    80
 *       <td>A byte buffer mapped to a file</td></tr>
46147
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    81
 *   <tr><th scope="row">
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    82
 *         <span style="padding-left:1em">{@link java.nio.CharBuffer}</span></th>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    83
 *       <td>Get/put, compact; allocate, wrap</td></tr>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    84
 *   <tr><th scope="row">
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    85
 *         <span style="padding-left:1em">{@link java.nio.DoubleBuffer}</span></th>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    86
 *       <td>Get/put, compact; allocate, wrap</td></tr>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    87
 *   <tr><th scope="row">
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    88
 *         <span style="padding-left:1em">{@link java.nio.FloatBuffer}</span></th>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    89
 *       <td>Get/put, compact; allocate, wrap</td></tr>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    90
 *   <tr><th scope="row">
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    91
 *         <span style="padding-left:1em">{@link java.nio.IntBuffer}</span></th>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    92
 *       <td>Get/put, compact; allocate, wrap</td></tr>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    93
 *   <tr><th scope="row">
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    94
 *         <span style="padding-left:1em">{@link java.nio.LongBuffer}</span></th>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    95
 *       <td>Get/put, compact; allocate, wrap</td></tr>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    96
 *   <tr><th scope="row">
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    97
 *         <span style="padding-left:1em">{@link java.nio.ShortBuffer}</span></th>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    98
 *       <td>Get/put, compact; allocate, wrap</td></tr>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
    99
 *   <tr><th scope="row">{@link java.nio.ByteOrder}</th>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
   100
 *       <td>Typesafe enumeration for byte orders</td></tr>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
   101
 * </tbody>
047bdc4d771d 8185994: Fix a11y and HTML issues in the java.base/java.io and java.base/java.nio packages
jjg
parents: 45437
diff changeset
   102
 * </table>
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   103
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   104
 * <p> A <i>buffer</i> is a container for a fixed amount of data of a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   105
 * specific primitive type.  In addition to its content a buffer has a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   106
 * <i>position</i>, which is the index of the next element to be read
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   107
 * or written, and a <i>limit</i>, which is the index of the first
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   108
 * element that should not be read or written.  The base {@link
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   109
 * java.nio.Buffer} class defines these properties as well as methods
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   110
 * for <i>clearing</i>, <i>flipping</i>, and <i>rewinding</i>, for
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   111
 * <i>marking</i> the current position, and for <i>resetting</i> the
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   112
 * position to the previous mark.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   113
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   114
 * <p> There is a buffer class for each non-boolean primitive type.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   115
 * Each class defines a family of <i>get</i> and <i>put</i> methods
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   116
 * for moving data out of and in to a buffer, methods for
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   117
 * <i>compacting</i>, <i>duplicating</i>, and <i>slicing</i> a buffer,
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   118
 * and static methods for <i>allocating</i> a new buffer as well as
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   119
 * for <i>wrapping</i> an existing array into a buffer.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   120
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   121
 * <p> Byte buffers are distinguished in that they can be used as the
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   122
 * sources and targets of I/O operations.  They also support several
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   123
 * features not found in the other buffer classes:
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   124
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   125
 * <ul>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   126
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   127
 *   <li><p> A byte buffer can be allocated as a <a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   128
 *   href="ByteBuffer.html#direct"> <i>direct</i></a> buffer, in which
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   129
 *   case the Java virtual machine will make a best effort to perform
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   130
 *   native I/O operations directly upon it.  </p></li>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   131
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   132
 *   <li><p> A byte buffer can be created by {@link
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   133
 *   java.nio.channels.FileChannel#map <i>mapping</i>} a region of a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   134
 *   file directly into memory, in which case a few additional
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   135
 *   file-related operations defined in the {@link
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   136
 *   java.nio.MappedByteBuffer} class are available.  </p></li>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   137
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   138
 *   <li><p> A byte buffer provides access to its content as either a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   139
 *   heterogeneous or homogeneous sequence of <a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   140
 *   href="ByteBuffer.html#bin"><i>binary data</i></a> of any
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   141
 *   non-boolean primitive type, in either big-endian or little-endian
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   142
 *   <a href="ByteOrder.html">byte order</a>.  </p></li>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   143
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   144
 * </ul>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   145
 *
32143
394ab6a6658d 8133459: replace <tt> tags (obsolete in html5) in java.nio docs
avstepan
parents: 30788
diff changeset
   146
 * <p> Unless otherwise noted, passing a {@code null} argument to a
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   147
 * constructor or method in any class or interface in this package
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   148
 * will cause a {@link java.lang.NullPointerException
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   149
 * NullPointerException} to be thrown.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   150
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   151
 * @since 1.4
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   152
 * @author Mark Reinhold
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   153
 * @author JSR-51 Expert Group
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   154
 */
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
   155
package java.nio;