li.cil.architect.common.jobs

Enum JobManager

java.lang.Object

java.lang.Enum<JobManager>

li.cil.architect.common.jobs.JobManager

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JobManager>

public enum JobManager
extends java.lang.Enum<JobManager>

Tracks pending block deserialization / placement.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobManager.JobConsumer Utility interface for addJobBatch(EntityPlayer, boolean, Stream).
static interface	JobManager.JobSupplier Utility interface for addJobBatch(EntityPlayer, boolean, Stream).
static interface	JobManager.JobTester Utility interface for getJobTester(World).

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
void	addJobBatch(net.minecraft.entity.player.EntityPlayer player, boolean allowPartial, java.util.stream.Stream<JobManager.JobSupplier> provider) Add a batch of jobs which will be sorted by their respective sort orders amongst each other.
JobManager.JobTester	getJobTester(net.minecraft.world.World world) Get an object for the specified world that can be used to test for the presence of jobs at some position in that world.
void	onChunkLoad(net.minecraftforge.event.world.ChunkDataEvent.Load event)
void	onChunkSave(net.minecraftforge.event.world.ChunkDataEvent.Save event)
void	onChunkUnload(net.minecraftforge.event.world.ChunkEvent.Unload event)
void	onWorldTick(net.minecraftforge.fml.common.gameevent.TickEvent.WorldTickEvent event)
void	onWorldUnload(net.minecraftforge.event.world.WorldEvent.Unload event)
static JobManager	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobManager[]	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

INSTANCE

public static final JobManager INSTANCE

Method Detail

values

public static JobManager[] 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 (JobManager c : JobManager.values())
    System.out.println(c);

Returns:

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

valueOf

public static JobManager valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

addJobBatch

public void addJobBatch(net.minecraft.entity.player.EntityPlayer player,
                        boolean allowPartial,
                        java.util.stream.Stream<JobManager.JobSupplier> provider)

Add a batch of jobs which will be sorted by their respective sort orders amongst each other.

This is a little bit roundabout, as we want to abstract all internal bookkeeping logic needed for the sorting of added jobs. Essentially this is a "for each job you can give me, please tell this object what that job is", with "this object" being the instance with internal bookkeeping.

Parameters:

player - the player creating the jobs.

allowPartial - whether to allow partial placement.

provider - the stream to query for jobs.

getJobTester

public JobManager.JobTester getJobTester(net.minecraft.world.World world)

Get an object for the specified world that can be used to test for the presence of jobs at some position in that world.

This is used as a performance shortcut when batch-adding jobs, as it saves us the manager lookup for each potentially added job.

Parameters:

world - the world to get the tester for.

Returns:

the tester for presence of jobs.

onWorldTick

public void onWorldTick(net.minecraftforge.fml.common.gameevent.TickEvent.WorldTickEvent event)

onWorldUnload

public void onWorldUnload(net.minecraftforge.event.world.WorldEvent.Unload event)

onChunkLoad

public void onChunkLoad(net.minecraftforge.event.world.ChunkDataEvent.Load event)

onChunkSave

public void onChunkSave(net.minecraftforge.event.world.ChunkDataEvent.Save event)

onChunkUnload

public void onChunkUnload(net.minecraftforge.event.world.ChunkEvent.Unload event)