craterdog.collections.abstractions.SortableCollection Maven / Gradle / Ivy
/************************************************************************
* Copyright (c) Crater Dog Technologies(TM). All Rights Reserved. *
************************************************************************
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. *
* *
* This code is free software; you can redistribute it and/or modify it *
* under the terms of The MIT License (MIT), as published by the Open *
* Source Initiative. (See http://opensource.org/licenses/MIT) *
************************************************************************/
package craterdog.collections.abstractions;
import craterdog.collections.List;
import craterdog.collections.interfaces.Sortable;
import craterdog.collections.primitives.MergeSorter;
import craterdog.collections.primitives.RandomSorter;
import craterdog.utils.NaturalComparator;
import java.util.Comparator;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/**
* This abstract class defines the invariant methods that all sortable collections must inherit.
* A sortable collection allows the order of its elements to be determined externally. By
* default, the elements will be placed in the order in which they were added to the collection.
* Additionally, the elements can be sorted in various ways depending on a specified sorting
* algorithm and comparison function.
*
* @author Derk Norton
* @param The type of element managed by the collection.
*/
public abstract class SortableCollection extends OpenCollection implements Sortable {
static private final XLogger logger = XLoggerFactory.getXLogger(SortableCollection.class);
@Override
public void shuffleElements() {
logger.entry();
Sorter sorter = new RandomSorter<>();
sorter.sortCollection(this);
logger.exit();
}
@Override
public void sortElements() {
logger.entry();
Sorter sorter = new MergeSorter<>();
Comparator comparator = new NaturalComparator<>();
sorter.sortCollection(this, comparator);
logger.exit();
}
@Override
public void sortElements(Comparator comparator) {
logger.entry(comparator);
Sorter sorter = new MergeSorter<>();
sorter.sortCollection(this, comparator);
logger.exit();
}
@Override
public void sortElements(Sorter sorter, Comparator comparator) {
logger.entry(sorter, comparator);
sorter.sortCollection(this, comparator);
logger.exit();
}
/**
* This method returns a new collection that is the concatenation of this collection with
* the specified collection.
*
* @param The type of element contained in the collections.
* @param collection1 The first collection to be concatenated.
* @param collection2 The second collection to be concatenated.
* @return The resulting collection.
*/
static public SortableCollection concatenate(SortableCollection collection1, SortableCollection collection2) {
logger.entry(collection1, collection2);
List result = new List<>(collection1);
result.addElements(collection2);
logger.exit(result);
return result;
}
}