Package org.spongepowered.api.world.server.storage

Interface ServerWorldProperties.LoadOptions

Enclosing interface:

ServerWorldProperties

public static interface ServerWorldProperties.LoadOptions

Customize the load process of a ServerWorldProperties.

Each load options can define multiple operations at once that will be exhausted until one of them succeeds.

The operations will be consumed in the following order:

• Get
• Load
• Create

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ServerWorldProperties.LoadOptions.Builder	A builder to create ServerWorldProperties.LoadOptions.
static interface	ServerWorldProperties.LoadOptions.CreateOperation
static interface	ServerWorldProperties.LoadOptions.GetOperation
static interface	ServerWorldProperties.LoadOptions.LoadOperation

Method Summary

Modifier and Type	Method	Description
static ServerWorldProperties.LoadOptions.Builder	builder()
static ServerWorldProperties.LoadOptions	create(WorldArchetype worldArchetype)	Create a new ServerWorldProperties with the given WorldArchetype but do not attempt to load it from disk or use the already loaded instance.
static ServerWorldProperties.LoadOptions	create(WorldArchetype worldArchetype, Consumer<ServerWorldProperties> createCallback)	Create a new ServerWorldProperties with the given WorldArchetype but do not attempt to load it from disk or use the already loaded instance.
Optional<ServerWorldProperties.LoadOptions.CreateOperation>	createOperation()	Gets the creation operation for this option.
static ServerWorldProperties.LoadOptions	get()	Get the already loaded ServerWorldProperties instance but do not attempt load it from the disk or create it.
static ServerWorldProperties.LoadOptions	get(Consumer<ServerWorldProperties> getCallback)	Get the already loaded ServerWorldProperties instance but do not attempt load it from the disk or create it.
Optional<ServerWorldProperties.LoadOptions.GetOperation>	getOperation()	Gets the get operation for this option.
static ServerWorldProperties.LoadOptions	getOrLoad()	Get the already loaded ServerWorldProperties or attempt to load it from disk but do not create a new one.
static ServerWorldProperties.LoadOptions	getOrLoad(Consumer<ServerWorldProperties> getCallback, Consumer<ServerWorldProperties> loadCallback)	Get the already loaded ServerWorldProperties or attempt to load it from disk but do not create a new one.
static ServerWorldProperties.LoadOptions	load()	Load a new ServerWorldProperties from disk but do not attempt to use the already loaded instance or to create a new one.
static ServerWorldProperties.LoadOptions	load(Consumer<ServerWorldProperties> loadCallback)	Load a new ServerWorldProperties from disk but do not attempt to use the already loaded instance or to create a new one.
Optional<ServerWorldProperties.LoadOptions.LoadOperation>	loadOperation()	Gets the load operation for this option.

Method Details

builder

static ServerWorldProperties.LoadOptions.Builder builder()

load

static ServerWorldProperties.LoadOptions load()

Load a new ServerWorldProperties from disk but do not attempt to use the already loaded instance or to create a new one.

The operation fails if properties could not be loaded from disk.

Returns:

The load options.

load

static ServerWorldProperties.LoadOptions load(Consumer<ServerWorldProperties> loadCallback)

Load a new ServerWorldProperties from disk but do not attempt to use the already loaded instance or to create a new one.

The operation fails if properties could not be loaded from disk.

Parameters:

loadCallback - The consumer to call after successful load operation for additional configuration.

Returns:

The load options.

get

static ServerWorldProperties.LoadOptions get()

Get the already loaded ServerWorldProperties instance but do not attempt load it from the disk or create it.

The operation fails if properties were not already loaded.

Returns:

The load options.

get

static ServerWorldProperties.LoadOptions get(Consumer<ServerWorldProperties> getCallback)

Get the already loaded ServerWorldProperties instance but do not attempt load it from the disk or create it.

The operation fails if properties were not already loaded.

Parameters:

getCallback - The consumer to call after successful get operation for additional configuration.

Returns:

The load options.

getOrLoad

static ServerWorldProperties.LoadOptions getOrLoad()

Get the already loaded ServerWorldProperties or attempt to load it from disk but do not create a new one.

The operation fails if properties were not loaded nor could it be loaded from disk.

Returns:

The load options.

getOrLoad

static ServerWorldProperties.LoadOptions getOrLoad(Consumer<ServerWorldProperties> getCallback,
 Consumer<ServerWorldProperties> loadCallback)

Get the already loaded ServerWorldProperties or attempt to load it from disk but do not create a new one.

The operation fails if properties were not loaded nor could it be loaded from disk.

Parameters:

getCallback - The consumer to call after successful get operation for additional configuration.

loadCallback - The consumer to call after successful load operation for additional configuration.

Returns:

The load options.

create

static ServerWorldProperties.LoadOptions create(WorldArchetype worldArchetype)

Create a new ServerWorldProperties with the given WorldArchetype but do not attempt to load it from disk or use the already loaded instance.

The operation fails if properties could not be created.

Parameters:

worldArchetype - The archetype to use.

Returns:

The load options.

create

static ServerWorldProperties.LoadOptions create(WorldArchetype worldArchetype,
 Consumer<ServerWorldProperties> createCallback)

Create a new ServerWorldProperties with the given WorldArchetype but do not attempt to load it from disk or use the already loaded instance.

The operation fails if properties could not be created.

Parameters:

worldArchetype - The archetype to use.

createCallback - The consumer to call after successful creation for additional configuration.

Returns:

The load options.

getOperation

Optional<ServerWorldProperties.LoadOptions.GetOperation> getOperation()

Gets the get operation for this option.

If not present, the operation should fail on get.

Returns:

The option when found, if present.

loadOperation

Optional<ServerWorldProperties.LoadOptions.LoadOperation> loadOperation()

Gets the load operation for this option.

If not present, the operation should fail on load.

Returns:

The option when found, if present.

createOperation

Optional<ServerWorldProperties.LoadOptions.CreateOperation> createOperation()

Gets the creation operation for this option.

If not present, the operation should fail on creation.

Returns:

The operation when created, if present.