Stay organized with collections
Save and categorize content based on your preferences.
java.nio
Defines buffers, which are containers for data, and provides an
overview of the other NIO packages.
The central abstractions of the NIO APIs are:
Buffers, which are containers for data;
Charsets and their
associated decoders and encoders,
which
translate between bytes and Unicode characters;
Channels of
various types, which represent connections
to entities
capable of performing I/O operations; and
Selectors and selection keys, which
together with
selectable channels define a multiplexed,
non-blocking
I/O facility.
The java.nio
package defines the buffer classes, which
are used throughout the NIO APIs. The charset API is defined in
the java.nio.charset
package, and the channel and selector
APIs are defined in the java.nio.channels
package. Each of
these subpackages has its own service-provider (SPI) subpackage,
the contents of which can be used to extend the platform's default
implementations or to construct alternative implementations.
Description of the various buffers
Buffers |
Description |
Buffer |
Position, limit, and capacity;
clear, flip, rewind, and mark/reset |
ByteBuffer |
Get/put, compact, views; allocate, wrap |
MappedByteBuffer |
A byte buffer mapped to a file |
CharBuffer |
Get/put, compact; allocate, wrap |
DoubleBuffer |
Get/put, compact; allocate, wrap |
FloatBuffer |
Get/put, compact; allocate, wrap |
IntBuffer |
Get/put, compact; allocate, wrap |
LongBuffer |
Get/put, compact; allocate, wrap |
ShortBuffer |
Get/put, compact; allocate, wrap |
ByteOrder |
Typesafe enumeration for byte orders |
A buffer is a container for a fixed amount of data of a
specific primitive type. In addition to its content a buffer has a
position, which is the index of the next element to be read
or written, and a limit, which is the index of the first
element that should not be read or written. The base Buffer
class defines these properties as well as methods
for clearing, flipping, and rewinding, for
marking the current position, and for resetting the
position to the previous mark.
There is a buffer class for each non-boolean primitive type.
Each class defines a family of get and put methods
for moving data out of and in to a buffer, methods for
compacting, duplicating, and slicing a buffer,
and static methods for allocating a new buffer as well as
for wrapping an existing array into a buffer.
Byte buffers are distinguished in that they can be used as the
sources and targets of I/O operations. They also support several
features not found in the other buffer classes:
A byte buffer can be allocated as a direct buffer, in which
case the Java virtual machine will make a best effort to perform
native I/O operations directly upon it.
A byte buffer can be created by mapping
a region of a
file directly into memory, in which case a few additional
file-related operations defined in the MappedByteBuffer
class are available.
A byte buffer provides access to its content as either a
heterogeneous or homogeneous sequence of binary data of any
non-boolean primitive type, in either big-endian or little-endian
byte order.
Unless otherwise noted, passing a null
argument to a
constructor or method in any class or interface in this package
will cause a NullPointerException
to be thrown.
Classes
Exceptions
BufferOverflowException |
Unchecked exception thrown when a relative put operation reaches
the target buffer's limit.
|
BufferUnderflowException |
Unchecked exception thrown when a relative get operation reaches
the source buffer's limit.
|
InvalidMarkException |
Unchecked exception thrown when an attempt is made to reset a buffer
when its mark is not defined.
|
ReadOnlyBufferException |
Unchecked exception thrown when a content-mutation method such as
put or compact is invoked upon a read-only buffer.
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# java.nio\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\njava.nio\n========\n\nDefines buffers, which are containers for data, and provides an overview of the other NIO packages.\n\nThe central abstractions of the NIO APIs are:\n\n- [*Buffers*](#buffers), which are containers for data;\n\n- [*Charsets*](/reference/java/nio/charset/package-summary) and their\n associated *decoders* and *encoders* , \n which\n translate between bytes and Unicode characters;\n\n- [*Channels*](/reference/java/nio/channels/package-summary) of\n various types, which represent connections \n to entities\n capable of performing I/O operations; and\n\n- *Selectors* and *selection keys* , which\n together with \n *selectable channels* define a [multiplexed,\n non-blocking\n I/O](/reference/java/nio/channels/package-summary#multiplex) facility.\n\nThe `java.nio` package defines the buffer classes, which\nare used throughout the NIO APIs. The charset API is defined in\nthe [java.nio.charset](/reference/java/nio/charset/package-summary) package, and the channel and selector\nAPIs are defined in the [java.nio.channels](/reference/java/nio/channels/package-summary) package. Each of\nthese subpackages has its own service-provider (SPI) subpackage,\nthe contents of which can be used to extend the platform's default\nimplementations or to construct alternative implementations.\n\n\n| Buffers | Description |\n| [Buffer](/reference/java/nio/Buffer) | Position, limit, and capacity; clear, flip, rewind, and mark/reset |\n| [ByteBuffer](/reference/java/nio/ByteBuffer) | Get/put, compact, views; allocate, wrap |\n| [MappedByteBuffer](/reference/java/nio/MappedByteBuffer) | A byte buffer mapped to a file |\n| [CharBuffer](/reference/java/nio/CharBuffer) | Get/put, compact; allocate, wrap |\n| [DoubleBuffer](/reference/java/nio/DoubleBuffer) | Get/put, compact; allocate, wrap |\n| [FloatBuffer](/reference/java/nio/FloatBuffer) | Get/put, compact; allocate, wrap |\n| [IntBuffer](/reference/java/nio/IntBuffer) | Get/put, compact; allocate, wrap |\n| [LongBuffer](/reference/java/nio/LongBuffer) | Get/put, compact; allocate, wrap |\n| [ShortBuffer](/reference/java/nio/ShortBuffer) | Get/put, compact; allocate, wrap |\n| [ByteOrder](/reference/java/nio/ByteOrder) | Typesafe enumeration for byte orders |\n|----------------------------------------------------------|--------------------------------------------------------------------|\n[Description of the various buffers]\n\nA *buffer* is a container for a fixed amount of data of a\nspecific primitive type. In addition to its content a buffer has a\n*position* , which is the index of the next element to be read\nor written, and a *limit* , which is the index of the first\nelement that should not be read or written. The base [Buffer](/reference/java/nio/Buffer) class defines these properties as well as methods\nfor *clearing* , *flipping* , and *rewinding* , for\n*marking* the current position, and for *resetting* the\nposition to the previous mark.\n\nThere is a buffer class for each non-boolean primitive type.\nEach class defines a family of *get* and *put* methods\nfor moving data out of and in to a buffer, methods for\n*compacting* , *duplicating* , and *slicing* a buffer,\nand static methods for *allocating* a new buffer as well as\nfor *wrapping* an existing array into a buffer.\n\nByte buffers are distinguished in that they can be used as the\nsources and targets of I/O operations. They also support several\nfeatures not found in the other buffer classes:\n\n- A byte buffer can be allocated as a [*direct*](/reference/java/nio/ByteBuffer#direct) buffer, in which\n case the Java virtual machine will make a best effort to perform\n native I/O operations directly upon it.\n\n- A byte buffer can be created by [*mapping*](/reference/java/nio/channels/FileChannel#map(java.nio.channels.FileChannel.MapMode,%20long,%20long)) a region of a\n file directly into memory, in which case a few additional\n file-related operations defined in the [MappedByteBuffer](/reference/java/nio/MappedByteBuffer) class are available.\n\n- A byte buffer provides access to its content as either a\n heterogeneous or homogeneous sequence of [*binary data*](/reference/java/nio/ByteBuffer#bin) of any\n non-boolean primitive type, in either big-endian or little-endian\n [byte order](/reference/java/nio/ByteOrder).\n\nUnless otherwise noted, passing a `null` argument to a\nconstructor or method in any class or interface in this package\nwill cause a [NullPointerException](/reference/java/lang/NullPointerException) to be thrown.\n\n\nClasses\n-------\n\n|----------------------------------------------------------|-------------------------------------------------------------------------|\n| [Buffer](/reference/java/nio/Buffer) | A container for data of a specific primitive type. |\n| [ByteBuffer](/reference/java/nio/ByteBuffer) | A byte buffer. |\n| [ByteOrder](/reference/java/nio/ByteOrder) | A typesafe enumeration for byte orders. |\n| [CharBuffer](/reference/java/nio/CharBuffer) | A char buffer. |\n| [DoubleBuffer](/reference/java/nio/DoubleBuffer) | A double buffer. |\n| [FloatBuffer](/reference/java/nio/FloatBuffer) | A float buffer. |\n| [IntBuffer](/reference/java/nio/IntBuffer) | An int buffer. |\n| [LongBuffer](/reference/java/nio/LongBuffer) | A long buffer. |\n| [MappedByteBuffer](/reference/java/nio/MappedByteBuffer) | A direct byte buffer whose content is a memory-mapped region of a file. |\n| [ShortBuffer](/reference/java/nio/ShortBuffer) | A short buffer. |\n\nExceptions\n----------\n\n|--------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|\n| [BufferOverflowException](/reference/java/nio/BufferOverflowException) | Unchecked exception thrown when a relative *put* operation reaches the target buffer's limit. |\n| [BufferUnderflowException](/reference/java/nio/BufferUnderflowException) | Unchecked exception thrown when a relative *get* operation reaches the source buffer's limit. |\n| [InvalidMarkException](/reference/java/nio/InvalidMarkException) | Unchecked exception thrown when an attempt is made to reset a buffer when its mark is not defined. |\n| [ReadOnlyBufferException](/reference/java/nio/ReadOnlyBufferException) | Unchecked exception thrown when a content-mutation method such as put or compact is invoked upon a read-only buffer. |\n\n-\n\n Classes\n -------\n\n - [Buffer](/reference/java/nio/Buffer)\n - [ByteBuffer](/reference/java/nio/ByteBuffer)\n - [ByteOrder](/reference/java/nio/ByteOrder)\n - [CharBuffer](/reference/java/nio/CharBuffer)\n - [DoubleBuffer](/reference/java/nio/DoubleBuffer)\n - [FloatBuffer](/reference/java/nio/FloatBuffer)\n - [IntBuffer](/reference/java/nio/IntBuffer)\n - [LongBuffer](/reference/java/nio/LongBuffer)\n - [MappedByteBuffer](/reference/java/nio/MappedByteBuffer)\n - [ShortBuffer](/reference/java/nio/ShortBuffer)\n-\n\n Exceptions\n ----------\n\n - [BufferOverflowException](/reference/java/nio/BufferOverflowException)\n - [BufferUnderflowException](/reference/java/nio/BufferUnderflowException)\n - [InvalidMarkException](/reference/java/nio/InvalidMarkException)\n - [ReadOnlyBufferException](/reference/java/nio/ReadOnlyBufferException)"]]