de.alpharogroup.collections.set.IndexableSet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of silly-collections Show documentation

Utility library for collections, comparators and iterator classes

There is a newer version: 8.4

/**
 * The MIT License
 *
 * Copyright (C) 2015 Asterios Raptis
 *
 * 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 de.alpharogroup.collections.set;

/**
 * The class {@link IndexableSet}
 *
 * @param 
 *            the element type
 */
public class IndexableSet extends InsertionOrderSet
{

	/**
	 * The serialVersionUID.
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * Gets the element of the given index 

	 * 

	 * Note: use with caution
	 *
	 * @param index
	 *            the index
	 * @return the element of the given index or throws an IndexOutOfBoundsException
	 * @throws IndexOutOfBoundsException
	 *             if the index is out of range (index < 0 || index >= size())
	 */
	public E get(int index)
	{
		int size = this.size();
		int count = 0;
		for (E entry : this)
		{
			if (index >= size || index < 0)
			{
				break;
			}
			if (index == count)
			{
				return entry;
			}
			count++;
		}
		throw new IndexOutOfBoundsException("Index: " + index + ", Size: " + size);
	}

	/**
	 * Gets the index of the given element
	 *
	 * @param element
	 *            the element
	 * @return the index of the element or -1 if its not exists
	 */
	public int getIndex(E element)
	{
		int index = 0;
		for (E entry : this)
		{
			if (entry.equals(element))
			{
				return index;
			}
			index++;
		}
		return -1;
	}

}