IPartitionData.java

/*******************************************************************************
 * Copyright (c) 2015
 *
 * 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 jsettlers.common.map.partition;

import jsettlers.common.material.EMaterialType;

/**
 * This interface provides access to the settings of a partition.
 * 
 * @author Andreas Eberle
 * 
 */
public interface IPartitionData {

	/**
	 * Returns the settings of this partition.
	 * 
	 * @return An instance of {@link IPartitionSettings} providing the settings of the partition.
	 */
	IPartitionSettings getPartitionSettings();

	/**
	 * Returns the number of materials of the given type, available in the respective partition.
	 * 
	 * @param materialType
	 *            Type of material.
	 * @return Available amount of that material.
	 */
	int getAmountOf(EMaterialType materialType);

	/**
	 * Returns the number of buildings in the partition and of the player over all.
	 * 
	 * @return An instance of {@link IBuildingCounts} providing the number of buildings.
	 */
	IBuildingCounts getBuildingCounts();
}