ICubeProvider.java

/*
 *  This file is part of Cubic Chunks Mod, licensed under the MIT License (MIT).
 *
 *  Copyright (c) 2015 contributors
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *  THE SOFTWARE.
 */
package cubicchunks.world;

import javax.annotation.Nullable;

import cubicchunks.util.CubePos;
import cubicchunks.world.column.Column;
import cubicchunks.world.cube.Cube;

public interface ICubeProvider {

	@Nullable
	Cube getLoadedCube(int cubeX, int cubeY, int cubeZ);

	@Nullable
	Cube getLoadedCube(CubePos coords);

	Cube getCube(int cubeX, int cubeY, int cubeZ);

	Cube getCube(CubePos coords);

	/**
	 * Retrieve a column, if it exists and is loaded
	 *
	 * @param x The x position of the column
	 * @param z The z position of the column
	 *
	 * @return The column, if loaded. Null, otherwise.
	 */
	@Nullable
	Column getLoadedColumn(int x, int z); // more strictly define the return type

	Column provideColumn(int x, int z);   // more strictly define the return type
}