de.alpharogroup.collections.set.SetExtensions 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;

import java.util.Collection;
import java.util.Set;
import java.util.SortedSet;

import de.alpharogroup.collections.array.ArrayFactory;
import lombok.NonNull;
import lombok.experimental.UtilityClass;

/**
 * Extensions class for use with {@link Set} objects
 */
@UtilityClass
public class SetExtensions
{

	/**
	 * Converts the given {@link Set} to an array
	 *
	 * @param 
	 *            the generic type
	 * @param set
	 *            the set
	 * @return the array from the given {@link Set}
	 */
	@SuppressWarnings("unchecked")
	public static  T[] toArray(final @NonNull Set set)
	{
		if (set.isEmpty())
		{
			throw new IllegalArgumentException("set is empty");
		}
		T[] newArray = (T[])ArrayFactory.newArray(set.iterator().next().getClass(), set.size());
		return set.toArray(newArray);
	}

	/**
	 * Converts the given {@link Collection} to a {@link Set}
	 *
	 * @param 
	 *            the generic type of the elements
	 * @param collection
	 *            the collection
	 * @return A new {@link Set}
	 */
	public static  Set toSet(final Collection collection)
	{
		return SetFactory.newHashSet(collection);
	}

	/**
	 * Converts the given {@link Collection} to a {@link SortedSet}.
	 *
	 * @param 
	 *            the generic type of the elements
	 * @param collection
	 *            the collection
	 * @return A new {@link SortedSet}
	 */
	public static  SortedSet toSortedSet(final Collection collection)
	{
		return SetFactory.newTreeSet(collection);
	}

}