net.tridentsdk.server.chunk

Class ChunkHandler

java.lang.Object

net.tridentsdk.server.chunk.ChunkHandler

@ThreadSafe
public class ChunkHandler
extends Object

Manages the chunks stored in memory per world

Author:

The TridentSDK Team

Constructor Summary

Constructors

Constructor and Description
ChunkHandler(TridentWorld world) Creates a new chunk handler to manage the chunks of the provided world

Method Summary

Modifier and Type	Method and Description
boolean	apply(ChunkLocation location, java.util.function.Consumer<CRefCounter> consumer) Obtains the chunk reference counter and applies a transformation function
CRefCounter	get(ChunkLocation location) Obtains the chunk reference counter at the specified location
TridentChunk	get(ChunkLocation location, boolean gen) Obtains the chunk at the given location in the world, generating if given to do so
Set<ChunkLocation>	keys() Obtains the set of chunk locations that have already been loaded
void	put(TridentChunk chunk) Places a chunk into the collection of in-memory chunks
void	releaseReferences(ChunkLocationSet chunkSet) Releases the reference counters associated with the chunks that are specified in the set given
void	remove(ChunkLocation location) Manually removes the chunk from the collection without running any cleanup code
int	size() Obtains the amount of loaded chunks
boolean	tryRemove(ChunkLocation location) Attempts to remove the chunk from memory and save it
Collection<TridentChunk>	values() Obtains the chunks that have been loaded into memory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChunkHandler

public ChunkHandler(TridentWorld world)

Creates a new chunk handler to manage the chunks of the provided world

Parameters:

world - the world to manage chunks for

Method Detail

put

public void put(TridentChunk chunk)

Places a chunk into the collection of in-memory chunks

Parameters:

chunk - the chunk to add

get

public TridentChunk get(ChunkLocation location,
                        boolean gen)

Obtains the chunk at the given location in the world, generating if given to do so

Parameters:

location - the location to obtain the chunk

gen - true to generate a new chunk if no chunk exists

Returns:

the chunk at the given location, or null if it doesn't exist and gen is false

get

public CRefCounter get(ChunkLocation location)

Obtains the chunk reference counter at the specified location

Parameters:

location - the location to obtain the counter

Returns:

the counter at the location, or null if it doesn't exist

apply

public boolean apply(ChunkLocation location,
                     java.util.function.Consumer<CRefCounter> consumer)

Obtains the chunk reference counter and applies a transformation function

Parameters:

location - the location or obtain the chunk reference counter

consumer - the transformation function

Returns:

true to indicate that the chunk was successfully retrieved and transformed

tryRemove

public boolean tryRemove(ChunkLocation location)

Attempts to remove the chunk from memory and save it

This method returns false if:

• The chunk is not loaded
• The chunk still has strong references

Parameters:

location - the location to remove the chunk

Returns:

true to signify that the collection was modified as a result of this operation

releaseReferences

public void releaseReferences(ChunkLocationSet chunkSet)

Releases the reference counters associated with the chunks that are specified in the set given

Parameters:

chunkSet - the set of chunks to release references to, given that they exist in this cache

remove

public void remove(ChunkLocation location)

Manually removes the chunk from the collection without running any cleanup code

Parameters:

location - the location to remove the chunk from

keys

public Set<ChunkLocation> keys()

Obtains the set of chunk locations that have already been loaded

Returns:

the set of loaded chunk locations

values

public Collection<TridentChunk> values()

Obtains the chunks that have been loaded into memory

Returns:

the collection of loaded in-memory chunks

size

public int size()

Obtains the amount of loaded chunks

Returns:

the amount of loaded chunks