MappedByteBuffer

Class Overview

MappedByteBuffer is a special kind of direct byte buffer which maps a region of file to memory.

MappedByteBuffer can be created by calling FileChannel.map. Once created, the mapping between the byte buffer and the file region remains valid until the byte buffer is garbage collected.

All or part of a MappedByteBuffer's content may change or become inaccessible at any time, since the mapped file region can be modified by another thread or process at any time. If this happens, the behavior of the MappedByteBuffer is undefined.

Summary

[Expand] Inherited Methods
From class java.nio.ByteBuffer static ByteBuffer allocate(int capacity) Creates a byte buffer based on a newly allocated byte array. static ByteBuffer allocateDirect(int capacity) Creates a direct byte buffer based on a newly allocated memory block. final byte[] array() Returns the byte array which this buffer is based on, if there is one. final int arrayOffset() Returns the offset of the byte array which this buffer is based on, if there is one. abstract CharBuffer asCharBuffer() Returns a char buffer which is based on the remaining content of this byte buffer. abstract DoubleBuffer asDoubleBuffer() Returns a double buffer which is based on the remaining content of this byte buffer. abstract FloatBuffer asFloatBuffer() Returns a float buffer which is based on the remaining content of this byte buffer. abstract IntBuffer asIntBuffer() Returns a int buffer which is based on the remaining content of this byte buffer. abstract LongBuffer asLongBuffer() Returns a long buffer which is based on the remaining content of this byte buffer. abstract ByteBuffer asReadOnlyBuffer() Returns a read-only buffer that shares its content with this buffer. abstract ShortBuffer asShortBuffer() Returns a short buffer which is based on the remaining content of this byte buffer. abstract ByteBuffer compact() Compacts this byte buffer. int compareTo(ByteBuffer otherBuffer) Compares the remaining bytes of this buffer to another byte buffer's remaining bytes. abstract ByteBuffer duplicate() Returns a duplicated buffer that shares its content with this buffer. boolean equals(Object other) Checks whether this byte buffer is equal to another object. abstract byte get() Returns the byte at the current position and increases the position by 1. ByteBuffer get(byte[] dst, int dstOffset, int byteCount) Reads bytes from the current position into the specified byte array, starting at the specified offset, and increases the position by the number of bytes read. ByteBuffer get(byte[] dst) Reads bytes from the current position into the specified byte array and increases the position by the number of bytes read. abstract byte get(int index) Returns the byte at the specified index and does not change the position. abstract char getChar() Returns the char at the current position and increases the position by 2. abstract char getChar(int index) Returns the char at the specified index. abstract double getDouble() Returns the double at the current position and increases the position by 8. abstract double getDouble(int index) Returns the double at the specified index. abstract float getFloat(int index) Returns the float at the specified index. abstract float getFloat() Returns the float at the current position and increases the position by 4. abstract int getInt() Returns the int at the current position and increases the position by 4. abstract int getInt(int index) Returns the int at the specified index. abstract long getLong() Returns the long at the current position and increases the position by 8. abstract long getLong(int index) Returns the long at the specified index. abstract short getShort(int index) Returns the short at the specified index. abstract short getShort() Returns the short at the current position and increases the position by 2. final boolean hasArray() Returns true if array and arrayOffset won't throw. int hashCode() Calculates this buffer's hash code from the remaining chars. abstract boolean isDirect() Indicates whether this buffer is direct. final ByteBuffer order(ByteOrder byteOrder) Sets the byte order of this buffer. final ByteOrder order() Returns the byte order used by this buffer when converting bytes from/to other primitive types. abstract ByteBuffer put(byte b) Writes the given byte to the current position and increases the position by 1. ByteBuffer put(byte[] src, int srcOffset, int byteCount) Writes bytes in the given byte array, starting from the specified offset, to the current position and increases the position by the number of bytes written. abstract ByteBuffer put(int index, byte b) Write a byte to the specified index of this buffer without changing the position. final ByteBuffer put(byte[] src) Writes bytes in the given byte array to the current position and increases the position by the number of bytes written. ByteBuffer put(ByteBuffer src) Writes all the remaining bytes of the src byte buffer to this buffer's current position, and increases both buffers' position by the number of bytes copied. abstract ByteBuffer putChar(int index, char value) Writes the given char to the specified index of this buffer. abstract ByteBuffer putChar(char value) Writes the given char to the current position and increases the position by 2. abstract ByteBuffer putDouble(int index, double value) Writes the given double to the specified index of this buffer. abstract ByteBuffer putDouble(double value) Writes the given double to the current position and increases the position by 8. abstract ByteBuffer putFloat(int index, float value) Writes the given float to the specified index of this buffer. abstract ByteBuffer putFloat(float value) Writes the given float to the current position and increases the position by 4. abstract ByteBuffer putInt(int value) Writes the given int to the current position and increases the position by 4. abstract ByteBuffer putInt(int index, int value) Writes the given int to the specified index of this buffer. abstract ByteBuffer putLong(long value) Writes the given long to the current position and increases the position by 8. abstract ByteBuffer putLong(int index, long value) Writes the given long to the specified index of this buffer. abstract ByteBuffer putShort(int index, short value) Writes the given short to the specified index of this buffer. abstract ByteBuffer putShort(short value) Writes the given short to the current position and increases the position by 2. abstract ByteBuffer slice() Returns a sliced buffer that shares its content with this buffer. static ByteBuffer wrap(byte[] array) Creates a new byte buffer by wrapping the given byte array. static ByteBuffer wrap(byte[] array, int start, int byteCount) Creates a new byte buffer by wrapping the given byte array.
From class java.nio.Buffer abstract Object array() Returns the array that backs this buffer (optional operation). abstract int arrayOffset() Returns the offset into the array returned by array of the first element of the buffer (optional operation). final int capacity() Returns the capacity of this buffer. final Buffer clear() Clears this buffer. final Buffer flip() Flips this buffer. abstract boolean hasArray() Returns true if array and arrayOffset won't throw. final boolean hasRemaining() Indicates if there are elements remaining in this buffer, that is if position < limit. abstract boolean isDirect() Returns true if this is a direct buffer. abstract boolean isReadOnly() Indicates whether this buffer is read-only. final int limit() Returns the limit of this buffer. final Buffer limit(int newLimit) Sets the limit of this buffer. final Buffer mark() Marks the current position, so that the position may return to this point later by calling reset(). final Buffer position(int newPosition) Sets the position of this buffer. final int position() Returns the position of this buffer. final int remaining() Returns the number of remaining elements in this buffer, that is limit - position. final Buffer reset() Resets the position of this buffer to the mark. final Buffer rewind() Rewinds this buffer. String toString() Returns a string describing this buffer.
From class java.lang.Object Object clone() Creates and returns a copy of this Object. boolean equals(Object o) Compares this instance with the specified object and indicates if they are equal. void finalize() Invoked when the garbage collector has detected that this instance is no longer reachable. final Class<?> getClass() Returns the unique instance of Class that represents this object's class. int hashCode() Returns an integer hash code for this object. final void notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. final void notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. String toString() Returns a string containing a concise, human-readable description of this object. final void wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object. final void wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires. final void wait(long millis) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
From interface java.lang.Comparable abstract int compareTo(T another) Compares this object to the specified object to determine their relative order.