/***********************************************************************************************************************
 *
 * Copyright (C) 2010 by the Stratosphere project (http://stratosphere.eu)
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 **********************************************************************************************************************/

package eu.stratosphere.nephele.instance;

/**
 * This factory produces {@link InstanceTypeDescription} objects.
 * <p>
 * This class is thread-safe.
 * 
 * @author warneke
 */
public class InstanceTypeDescriptionFactory {

	/**
	 * Private constructor, so class cannot be instantiated.
	 */
	private InstanceTypeDescriptionFactory() {
	}

	/**
	 * Constructs a new {@link InstaceTypeDescription} object.
	 * 
	 * @param instanceType
	 *        the instance type
	 * @param hardwareDescription
	 *        the hardware description as created by the {@link InstanceManager}
	 * @param numberOfAvailableInstances
	 *        the number of available instances of this type
	 * @return the instance type description
	 */
	public static InstanceTypeDescription construct(InstanceType instanceType, HardwareDescription hardwareDescription,
			int numberOfAvailableInstances) {

		return new InstanceTypeDescription(instanceType, hardwareDescription, numberOfAvailableInstances);
	}
}
