com.jogamp.common.nio

Class MappedByteBufferOutputStream

java.lang.Object

java.io.OutputStream

com.jogamp.common.nio.MappedByteBufferOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class MappedByteBufferOutputStream
extends OutputStream

An OutputStream implementation based on an underlying FileChannel's memory mapped ByteBuffer.

Implementation is based on MappedByteBufferInputStream, using it as its parent instance.

An instance maybe created via its parent MappedByteBufferInputStream.getOutputStream(FileResizeOp) or directly #MappedByteBufferOutputStream(FileChannel, MapMode, CacheMode, int, FileResizeOp).

Since:

2.3.0

Constructor Summary

Constructors

Constructor and Description
MappedByteBufferOutputStream(FileChannel fileChannel, FileChannel.MapMode mmode, MappedByteBufferInputStream.CacheMode cmode, int sliceShift, MappedByteBufferInputStream.FileResizeOp fileResizeOp) Creates a new instance using the given FileChannel.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	flush()
void	flush(boolean metaData) See MappedByteBufferInputStream.flush(boolean).
boolean	getSynchronous() See MappedByteBufferInputStream.getSynchronous().
long	length() See MappedByteBufferInputStream.length().
void	notifyLengthChange(long newTotalSize) See MappedByteBufferInputStream.notifyLengthChange(long).
long	position() See MappedByteBufferInputStream.position().
MappedByteBufferInputStream	position(long newPosition) See MappedByteBufferInputStream.position(long).
long	remaining() See MappedByteBufferInputStream.remaining().
void	setLength(long newTotalSize) See MappedByteBufferInputStream.setLength(long).
void	setSynchronous(boolean s) See MappedByteBufferInputStream.setSynchronous(boolean).
long	skip(long n) See MappedByteBufferInputStream.skip(long).
void	write(byte[] b, int off, int len)
void	write(ByteBuffer b, int len) Perform similar to write(byte[], int, int) with ByteBuffer instead of byte array.
void	write(int b)
void	write(MappedByteBufferInputStream b, long len) Perform similar to write(ByteBuffer, int) with MappedByteBufferInputStream instead of byte array.

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MappedByteBufferOutputStream

public MappedByteBufferOutputStream(FileChannel fileChannel,
                            FileChannel.MapMode mmode,
                            MappedByteBufferInputStream.CacheMode cmode,
                            int sliceShift,
                            MappedByteBufferInputStream.FileResizeOp fileResizeOp)
                             throws IOException

Creates a new instance using the given FileChannel.

The ByteBuffer slices will be mapped lazily at first usage.

Parameters:

fileChannel - the file channel to be mapped lazily.

mmode - the map mode, default is FileChannel.MapMode#READ_WRITE.

cmode - the caching mode, default is MappedByteBufferInputStream.CacheMode.FLUSH_PRE_SOFT.

sliceShift - the pow2 slice size, default is MappedByteBufferInputStream.DEFAULT_SLICE_SHIFT.

fileResizeOp - MappedByteBufferInputStream.FileResizeOp as described on MappedByteBufferInputStream.setFileResizeOp(FileResizeOp).

Throws:

IOException

Method Detail

setSynchronous

public final void setSynchronous(boolean s)

See MappedByteBufferInputStream.setSynchronous(boolean).

getSynchronous

public final boolean getSynchronous()

See MappedByteBufferInputStream.getSynchronous().

setLength

public final void setLength(long newTotalSize)
                     throws IOException

See MappedByteBufferInputStream.setLength(long).

Throws:

IOException

notifyLengthChange

public final void notifyLengthChange(long newTotalSize)
                              throws IOException

See MappedByteBufferInputStream.notifyLengthChange(long).

Throws:

IOException

length

public final long length()

See MappedByteBufferInputStream.length().

remaining

public final long remaining()
                     throws IOException

See MappedByteBufferInputStream.remaining().

Throws:

IOException

position

public final long position()
                    throws IOException

See MappedByteBufferInputStream.position().

Throws:

IOException

position

public final MappedByteBufferInputStream position(long newPosition)
                                           throws IOException

See MappedByteBufferInputStream.position(long).

Throws:

IOException

skip

public final long skip(long n)
                throws IOException

See MappedByteBufferInputStream.skip(long).

Throws:

IOException

flush

public final void flush()
                 throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

flush

public final void flush(boolean metaData)
                 throws IOException

See MappedByteBufferInputStream.flush(boolean).

Throws:

IOException

close

public final void close()
                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

write

public final void write(int b)
                 throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public final void write(byte[] b,
         int off,
         int len)
                 throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public final void write(ByteBuffer b,
         int len)
                 throws IOException

Perform similar to write(byte[], int, int) with ByteBuffer instead of byte array.

Parameters:

b - the ByteBuffer source, data is read from current Buffer.position()

len - the number of bytes to write

Throws:

IOException - if a buffer slice operation failed or stream has been closed.

write

public final void write(MappedByteBufferInputStream b,
         long len)
                 throws IOException

Perform similar to write(ByteBuffer, int) with MappedByteBufferInputStream instead of byte array.

Method directly copies memory mapped ByteBuffer'ed data from the given input stream to this stream without extra data copy.

Parameters:

b - the ByteBuffer source, data is read from current MappedByteBufferInputStream.position()

len - the number of bytes to write

Throws:

IOException - if a buffer slice operation failed or stream has been closed.