io.github.opencubicchunks.cubicchunks.api.world

Enum ICubeProviderServer.Requirement

java.lang.Object

java.lang.Enum<ICubeProviderServer.Requirement>

io.github.opencubicchunks.cubicchunks.api.world.ICubeProviderServer.Requirement

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ICubeProviderServer.Requirement>

Enclosing interface:

ICubeProviderServer

public static enum ICubeProviderServer.Requirement
extends java.lang.Enum<ICubeProviderServer.Requirement>

The effort made to retrieve a cube or column. Any further work should not be done, and returning null is acceptable in those cases

Enum Constant Summary

Enum Constants

Enum Constant and Description
GENERATE Generate the cube/column, if necessary
GET_CACHED Only retrieve the cube/column if it is already cached
LIGHT Generate lighting information for the cube, if necessary
LOAD Load the cube/column from disk, if necessary
POPULATE Populate the cube/column, if necessary

Method Summary

Modifier and Type	Method and Description
static ICubeProviderServer.Requirement	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ICubeProviderServer.Requirement[]	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

GET_CACHED

public static final ICubeProviderServer.Requirement GET_CACHED

Only retrieve the cube/column if it is already cached

LOAD

public static final ICubeProviderServer.Requirement LOAD

Load the cube/column from disk, if necessary

GENERATE

public static final ICubeProviderServer.Requirement GENERATE

Generate the cube/column, if necessary

POPULATE

public static final ICubeProviderServer.Requirement POPULATE

Populate the cube/column, if necessary

LIGHT

public static final ICubeProviderServer.Requirement LIGHT

Generate lighting information for the cube, if necessary

Method Detail

values

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

Returns:

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

valueOf

public static ICubeProviderServer.Requirement 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