com.jogamp.common.nio

Enum MappedByteBufferInputStream.CacheMode

java.lang.Object

java.lang.Enum<MappedByteBufferInputStream.CacheMode>

com.jogamp.common.nio.MappedByteBufferInputStream.CacheMode

All Implemented Interfaces:

Serializable, Comparable<MappedByteBufferInputStream.CacheMode>

Enclosing class:

MappedByteBufferInputStream

public static enum MappedByteBufferInputStream.CacheMode
extends Enum<MappedByteBufferInputStream.CacheMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLUSH_NONE Keep all previous lazily cached buffer slices alive, useful for hopping readers, i.e.
FLUSH_PRE_HARD Hard flush the previous lazily cached buffer slice when caching the next buffer slice, useful for sequential forward readers.
FLUSH_PRE_SOFT Soft flush the previous lazily cached buffer slice when caching the next buffer slice, useful for sequential forward readers, as well as for hopping readers like FLUSH_NONE in case of relatively short periods between hopping across slices.

Method Summary

Methods

Modifier and Type	Method and Description
static MappedByteBufferInputStream.CacheMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static MappedByteBufferInputStream.CacheMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FLUSH_NONE

public static final MappedByteBufferInputStream.CacheMode FLUSH_NONE

Keep all previous lazily cached buffer slices alive, useful for hopping readers, i.e. random access via position(p) or reset().

Note that without flushing, the platform may fail memory mapping due to virtual address space exhaustion.
In such case an OutOfMemoryError may be thrown directly, or encapsulated as the the cause of a thrown IOException.

FLUSH_PRE_SOFT

public static final MappedByteBufferInputStream.CacheMode FLUSH_PRE_SOFT

Soft flush the previous lazily cached buffer slice when caching the next buffer slice, useful for sequential forward readers, as well as for hopping readers like FLUSH_NONE in case of relatively short periods between hopping across slices.

Implementation clears the buffer slice reference while preserving a WeakReference to allow its resurrection if not yet garbage collected.

FLUSH_PRE_HARD

public static final MappedByteBufferInputStream.CacheMode FLUSH_PRE_HARD

Hard flush the previous lazily cached buffer slice when caching the next buffer slice, useful for sequential forward readers.

Besides clearing the buffer slice reference, implementation attempts to hard flush the mapped buffer using a sun.misc.Cleaner by reflection. In case such method does not exist nor works, implementation falls back to FLUSH_PRE_SOFT.

This is the default.

Method Detail

values

public static MappedByteBufferInputStream.CacheMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MappedByteBufferInputStream.CacheMode c : MappedByteBufferInputStream.CacheMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MappedByteBufferInputStream.CacheMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null