All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amit.api.compiler.model.UniqueCollection Maven / Gradle / Ivy

The newest version!
/******************************************************************************
 * Copyright 2014-2018 Alexandru Motriuc                                      *
 *                                                                            *
 ******************************************************************************
 * 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 com.amit.api.compiler.model;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

/**
 * collection that ensures unique by name list of the ProjectElements
 */
public class UniqueCollection implements Iterable {
	private Map elements = new HashMap();
	private List elementList = new ArrayList();
	private String typeName;

	public UniqueCollection(String typeName) {
		if (typeName == null || typeName.isEmpty()) {
			throw new IllegalArgumentException(
					"typeName must be not null or empty");
		}

		this.typeName = typeName;
	}

	/**
	 * adds a element to the collection and exception is thrown when element
	 * 
	 * @param element
	 *            element
	 * @throws ModuleElementException
	 *             thrown on error
	 */
	public void add(T element) throws ModuleElementException {
		if (element == null) {
			throw new IllegalArgumentException("type must not be null");
		}

		if (elements.containsKey(element.getName())) {
			throw new ModuleElementException(String.format("%s name is in use",
					typeName), element);
		}

		elements.put(element.getName(), element);
		elementList.add(element);
	}

	/**
	 * gets the element by name
	 * 
	 * @param name
	 *            element name
	 * @return element
	 */
	public T get(String name) {
		if (name == null || name.isEmpty()) {
			throw new IllegalArgumentException("name must be not null or empty");
		}

		return elements.get(name);
	}

	/**
	 * returns the read only list
	 * 
	 * @return read only element list
	 */
	public List readonlyList() {
		return Collections.unmodifiableList(elementList);
	}

	/**
	 * {@inheritDoc}
	 */
	public Iterator iterator() {
		return elementList.iterator();
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy