Package org.spongepowered.api.world.volume.stream

Enum Class StreamOptions.LoadingStyle

java.lang.Object

java.lang.Enum<StreamOptions.LoadingStyle>

org.spongepowered.api.world.volume.stream.StreamOptions.LoadingStyle

All Implemented Interfaces:

Serializable, Comparable<StreamOptions.LoadingStyle>, Constable

Enclosing interface:

StreamOptions

public static enum StreamOptions.LoadingStyle
extends Enum<StreamOptions.LoadingStyle>

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
FORCED_GENERATED	Forces the loading of the entire area to calculate the exact available sections to fetch the predefined stream of elements to populate the VolumeStream.
FORCED_UNGENERATED	Forces the loading of the entire area to calculate the exact available sections to fetch the predefined stream of elements to populate the VolumeStream.
LAZILY_GENERATED	Ensures that sections within the area are loaded during stream execution, but unlike FORCED_GENERATED, sections will only be loaded during VolumeStream execution if and when the section is iterated over, and not pre-loaded beforehand.
LAZILY_UNGENERATED	Ensures that sections within the area are loaded during stream execution, but unlike FORCED_GENERATED, sections will only be loaded during VolumeStream execution if and when the section is iterated over, and not pre-loaded beforehand.
NONE	Only requests the available sections of the Volume without incurring any loading of sections costs, useful for building streams of available elements.

Method Summary

Modifier and Type	Method	Description
abstract boolean	generateArea()	Whether areas are to be requested to be generated prior to streaming over them, somewhat in tandem with StreamOptions.LoadingStyle, a section can potentially be un-generated and having never been visited before, may be requested to be generated in order for the stream's element type to be operated on.
abstract boolean	immediateLoading()
static StreamOptions.LoadingStyle	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StreamOptions.LoadingStyle[]	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

FORCED_GENERATED

public static final StreamOptions.LoadingStyle FORCED_GENERATED

Forces the loading of the entire area to calculate the exact available sections to fetch the predefined stream of elements to populate the VolumeStream. This will incur an initial cost of World.loadChunk(Vector3i, boolean) with shouldGenerate = generateArea().

FORCED_UNGENERATED

public static final StreamOptions.LoadingStyle FORCED_UNGENERATED

Forces the loading of the entire area to calculate the exact available sections to fetch the predefined stream of elements to populate the VolumeStream. This will incur an initial cost of World.loadChunk(Vector3i, boolean) with shouldGenerate = generateArea().

LAZILY_UNGENERATED

public static final StreamOptions.LoadingStyle LAZILY_UNGENERATED

Ensures that sections within the area are loaded during stream execution, but unlike FORCED_GENERATED, sections will only be loaded during VolumeStream execution if and when the section is iterated over, and not pre-loaded beforehand.

In the case of a World, this will still issue a request for a World.loadChunk(int, int, int, boolean) with shouldGenerate = generateArea().

LAZILY_GENERATED

public static final StreamOptions.LoadingStyle LAZILY_GENERATED

Ensures that sections within the area are loaded during stream execution, but unlike FORCED_GENERATED, sections will only be loaded during VolumeStream execution if and when the section is iterated over, and not pre-loaded beforehand.

In the case of a World, this will still issue a request for a World.loadChunk(int, int, int, boolean) with shouldGenerate = generateArea().

NONE

public static final StreamOptions.LoadingStyle NONE

Only requests the available sections of the Volume without incurring any loading of sections costs, useful for building streams of available elements.

Method Details

values

public static StreamOptions.LoadingStyle[] 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 StreamOptions.LoadingStyle 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

generateArea

public abstract boolean generateArea()

Whether areas are to be requested to be generated prior to streaming over them, somewhat in tandem with StreamOptions.LoadingStyle, a section can potentially be un-generated and having never been visited before, may be requested to be generated in order for the stream's element type to be operated on. This should incur an additional cost of the stream setup, based on the StreamOptions.LoadingStyle's request such as FORCED_GENERATED, or LAZILY_GENERATED.

Returns:

Whether sections that are previously empty, should be generated

immediateLoading

public abstract boolean immediateLoading()