org.d2ab.collection.Lists Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sequence Show documentation

A lightweight alternative to Java 8 sequential Stream

There is a newer version: 2.3.0

/*
 * Copyright 2016 Daniel Skogquist Åborg
 *
 * 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 org.d2ab.collection;

import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Random;

/**
 * Utility methods for {@link List}s.
 */
public class Lists {
	/**
	 * A pass-through version of {@link Collections#shuffle(List)}.
	 *
	 * @return the given list shuffled using {@link Collections#shuffle(List)}.
	 */
	public static  List shuffle(List list) {
		Collections.shuffle(list);
		return list;
	}

	/**
	 * A pass-through version of {@link Collections#shuffle(List, Random)}.
	 *
	 * @return the given list shuffled using {@link Collections#shuffle(List, Random)}.
	 */
	public static  List shuffle(List list, Random random) {
		Collections.shuffle(list, random);
		return list;
	}

	/**
	 * A pass-through version of {@link List#sort(Comparator)} sorted using
	 * {@link Comparator#naturalOrder()}.
	 *
	 * @return the given list sorted using {@link List#sort(Comparator)} with
	 * {@link Comparator#naturalOrder()}.
	 */
	public static > List sort(List list) {
		return sort(list, Comparator.naturalOrder());
	}

	/**
	 * A pass-through version of {@link List#sort(Comparator)} sorted using
	 * {@link Comparator#naturalOrder()}.
	 *
	 * @return the given list sorted using {@link List#sort(Comparator)} with
	 * {@link Comparator#naturalOrder()}.
	 */
	public static  List sort(List list, Comparator comparator) {
		list.sort(comparator);
		return list;
	}
}