org.gradle.foundation.common

Class ListReorderer

java.lang.Object

org.gradle.foundation.common.ListReorderer

public class ListReorderer
extends Object

Utility class that allows lists to be reordered.

Author:

Chris Hampton

Constructor Summary

Constructors

Constructor and Description
ListReorderer()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> boolean	allElementsInBack(List<T> sourceList, List<T> checkList)
static <T> boolean	allElementsInFront(List<T> sourceList, List<T> checkList) Returns true if all the elements of the check list are at the end of the source list.
static <T> int[]	getIndices(List<T> sourceList, List<T> objectsToMove) This is mainly used for after doing a move.
static <T> void	moveAfter(List<T> sourceList, List<T> objectsToMove) Moves the objects in the list up one index position in this list while maintaining their relative position.
static <T> boolean	moveAfter(List<T> sourceList, T object) Moves the object up one index position in the list.
static <T> void	moveBefore(List<T> sourceList, List<T> objectsToMove) Moves a list of elements in this list while keeping their relative positions.
static <T> boolean	moveBefore(List<T> sourceList, T object) Moves the object down one position in the group list.
static <T> void	moveTo(List<T> sourceList, List<T> moveList, int index) Moves a list of objects to a new index location.
static <T> void	moveToBack(List<T> sourceList, List<T> objectsToMove) Moves a list of objects to the front of the list.
static <T> boolean	moveToBack(List<T> sourceList, T object) Moves an object to the back of the list.
static <T> void	moveToFront(List<T> sourceList, List<T> objectsToMove) Moves a list of objects to the front of the list.
static <T> boolean	moveToFront(List<T> sourceList, T object) Moves an object to the front of the list.
static <T> void	sortMoveListByRelativeOrder(List<T> parentList, List<T> childList) Sorts a child list by position in a parent list to preserve relative ordering of the elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListReorderer

public ListReorderer()

Method Detail

moveBefore

public static <T> boolean moveBefore(List<T> sourceList,
                     T object)

Moves the object down one position in the group list.

Parameters:

sourceList - The list whose elements we want to reorder.

object - The object to move.

moveBefore

public static <T> void moveBefore(List<T> sourceList,
                  List<T> objectsToMove)

Moves a list of elements in this list while keeping their relative positions. When the first element reaches the beginning it goes no further and the other elements in the list will continue to be shifted on subsequent calls as long as they don't overwrite previously moved elements. This means that elements with other elements between them will continue move with the same distance between them but will 'bunch up' toward the beginning of the list. NOTE: The order of the list of moved elements is important. They have to be added in order from lowest index to highest.

Parameters:

sourceList - The list whose elements we want to reorder.

objectsToMove - List of elements to move.

moveTo

public static <T> void moveTo(List<T> sourceList,
              List<T> moveList,
              int index)

Moves a list of objects to a new index location.

Parameters:

sourceList - The list where the move will occur.

moveList - The objects to move.

index - The object's new location in the list.

moveToFront

public static <T> boolean moveToFront(List<T> sourceList,
                      T object)

Moves an object to the front of the list.

Parameters:

sourceList - The list the object is in.

object - The object to move.

Returns:

True if the object was in the list and it was moved.

moveToFront

public static <T> void moveToFront(List<T> sourceList,
                   List<T> objectsToMove)

Moves a list of objects to the front of the list.

Parameters:

sourceList - The list the object is in.

objectsToMove - The object to move.

moveAfter

public static <T> boolean moveAfter(List<T> sourceList,
                    T object)

Moves the object up one index position in the list.

Parameters:

sourceList - The list whose elements we want to reorder.

object - The object to move.

moveAfter

public static <T> void moveAfter(List<T> sourceList,
                 List<T> objectsToMove)

Moves the objects in the list up one index position in this list while maintaining their relative position. When an element reaches the end of the list it can go no farther, but the other elements continue to move each call without overwriting previously moved elements. This causes moved elements to 'bunch up' at the end of the list. NOTE: The order of the list of moved elements is important. They have to be added in order from lowest index to highest.

Parameters:

sourceList - The list whose elements we want to reorder.

objectsToMove - List of elements to move.

moveToBack

public static <T> boolean moveToBack(List<T> sourceList,
                     T object)

Moves an object to the back of the list.

Parameters:

sourceList - The list the object is in.

object - The object to move.

Returns:

True if the object was in the list and it was moved.

moveToBack

public static <T> void moveToBack(List<T> sourceList,
                  List<T> objectsToMove)

Moves a list of objects to the front of the list.

Parameters:

sourceList - The list the object is in.

objectsToMove - The object to move.

sortMoveListByRelativeOrder

public static <T> void sortMoveListByRelativeOrder(List<T> parentList,
                                   List<T> childList)

Sorts a child list by position in a parent list to preserve relative ordering of the elements.

Parameters:

parentList - .

childList - .

allElementsInFront

public static <T> boolean allElementsInFront(List<T> sourceList,
                             List<T> checkList)

Returns true if all the elements of the check list are at the end of the source list.

Parameters:

sourceList - .

checkList - .

Returns:

.

allElementsInBack

public static <T> boolean allElementsInBack(List<T> sourceList,
                            List<T> checkList)

getIndices

public static <T> int[] getIndices(List<T> sourceList,
                   List<T> objectsToMove)

This is mainly used for after doing a move. It gives you the current index of all the moved elements. This is useful for UIs that need to reselect the new items.

Parameters:

sourceList - the source list

objectsToMove - the elements to move

Returns:

an integer array of the items to select.