org.eclipse.emf.emfstore.modelmutator/src/org/eclipse/emf/emfstore/modelmutator/intern/attribute/AttributeSetter.java

/*******************************************************************************
 * Copyright 2012 EclipseSource Muenchen GmbH.
 * 
 * All rights reserved. This program and the accompanying materials
 * are made available under the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 ******************************************************************************/
package org.eclipse.emf.emfstore.modelmutator.intern.attribute;

import java.util.Collection;
import java.util.Random;

/**
 * Abstract class that defines methods for creating attributes in order
 * to generate or change Ecore models. Attributes are created
 * using a Random object.
 * 
 * @param <E> the attribute type of the attributes to create
 */
public abstract class AttributeSetter<E> {

	/**
	 * Random object that is used to determine values for attributes created
	 * by {@link #createNewAttribute()} and {@link #createNewAttributes()}.
	 */
	private final Random random;

	/**
	 * The construction of the AttributeSetter with Random object.
	 * 
	 * @param random the random object used for the setters
	 */
	public AttributeSetter(Random random) {
		this.random = random;
	}

	/**
	 * Creates one attribute of type <code>E</code>.
	 * The result is determined by <code>random</code>.
	 * 
	 * @return the created attribute
	 */
	public abstract E createNewAttribute();

	/**
	 * Creates a collection of attributes of type <code>E</code>.
	 * The result is determined by <code>random</code>.
	 * 
	 * @param maxAmount the maximum amount of attributes to create
	 * @return all created attributes as a collection
	 */
	public abstract Collection<E> createNewAttributes(int maxAmount);

	/**
	 * @return the random
	 */
	public Random getRandom() {
		return random;
	}

}