Package net.algart.matrices.maps.pyramids.io.api

Enum Class PlanePyramidSource.FlushMode

java.lang.Object

java.lang.Enum<PlanePyramidSource.FlushMode>

net.algart.matrices.maps.pyramids.io.api.PlanePyramidSource.FlushMode

All Implemented Interfaces:

Serializable, Comparable<PlanePyramidSource.FlushMode>, Constable

Enclosing interface:

PlanePyramidSource

public static enum PlanePyramidSource.FlushMode
extends Enum<PlanePyramidSource.FlushMode>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FLUSH_LONG_TERM_RESOURCES	Forces strong freeing any resources, associated with this object and with a group of similar objects.
QUICK_WITH_POSSIBLE_LOSS_OF_DATA	Like STANDARD, but permits loss of some data.
STANDARD	Usual flushing, suitable for close() and similar methods.

Method Summary

Modifier and Type	Method	Description
abstract boolean	dataMustBeFlushed()
abstract boolean	flushLongTermResources()
abstract boolean	forcePhysicalWriting()
static PlanePyramidSource.FlushMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlanePyramidSource.FlushMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

QUICK_WITH_POSSIBLE_LOSS_OF_DATA

public static final PlanePyramidSource.FlushMode QUICK_WITH_POSSIBLE_LOSS_OF_DATA

Like STANDARD, but permits loss of some data. Can be useful, for example, if you want to cancel long-time operation that writes some large object.

STANDARD

public static final PlanePyramidSource.FlushMode STANDARD

Usual flushing, suitable for close() and similar methods. Should close associated files, flush non-written data to disk etc.

FLUSH_LONG_TERM_RESOURCES

public static final PlanePyramidSource.FlushMode FLUSH_LONG_TERM_RESOURCES

Forces strong freeing any resources, associated with this object and with a group of similar objects. If some buffers are not written yet to disk, should enforce physical flushing them to disk by means of corresponding OS calls. If there are some service threads, necessary for correct work with this type of sources and created automatically while using this source, should try to stop these threads. However, next usage of this kind of sources after such flushing may require additional time.

This mode is suitable if the user wants to finish working with his task, for example, closes the window or stops an application. Note: pyramid sources, based on SCIFIO library (until version 0.44 including), must use this flushing mode, in other case that library will prevent closing the application.

Method Details

values

public static PlanePyramidSource.FlushMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PlanePyramidSource.FlushMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

dataMustBeFlushed

public abstract boolean dataMustBeFlushed()

forcePhysicalWriting

public abstract boolean forcePhysicalWriting()

flushLongTermResources

public abstract boolean flushLongTermResources()