IMaterialsDistributionSettings.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.buildings.EBuildingType;
import jsettlers.common.material.EMaterialType;

/**
 * Interface to supply distribution informations. Instances of this interface are used to get the distribution probabilitys for the buildings that can
 * receive a specific {@link EMaterialType}.
 * 
 * @author Andreas Eberle
 * 
 */
public interface IMaterialsDistributionSettings {
	/**
	 * 
	 * @return Returns the number of buildings that can request the material this setting is used for.
	 */
	int getNumberOfBuildingTypes();

	/**
	 * 
	 * @param index
	 *            Index in the interval [0, {@link #getNumberOfBuildingTypes()} - 1].
	 * @return Returns the {@link EBuildingType} represented by the given index.
	 */
	EBuildingType getBuildingType(int index);

	/**
	 * 
	 * @param index
	 *            Index of the {@link EBuildingType}. The index has to be in the interval [0, {@link #getNumberOfBuildingTypes()} - 1]. <br>
	 *            To get the {@link EBuildingType} call {@link #getBuildingType(index)}
	 * @return Returns the probability that a material should be send to a requester of the {@link EBuildingType} represented by the given index. <br>
	 * 
	 * @see #getBuildingType(int)
	 */
	float getProbablity(int index);

	/**
	 * 
	 * @return Returns the {@link EMaterialType} this settings are used for.
	 */
	EMaterialType getMaterialType();
}