craterdog.collections.abstractions.Sorter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-collection-framework Show documentation

A set of interfaces and classes that define a Java collection framework.

There is a newer version: 3.18

Show newest version

/************************************************************************
 * 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.utils.NaturalComparator;
import java.util.Comparator;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;


/**
 * This abstract class defines a framework for each concrete sorter class
 * that sorts the elements in a collection using a specific algorithm and
 * comparator function.
 *
 * @author Derk Norton
 * @param  The type of element being sorted.
 */
public abstract class Sorter {

    static private final XLogger logger = XLoggerFactory.getXLogger(Sorter.class);


    /**
     * This method sorts the elements of its collection using a specific
     * sorting algorithm.  The natural comparator is used to compare
     * each pair of elements during sorting.
     *
     * @param collection The collection to be sorted.
     */
    public final void sortCollection(SortableCollection collection) {
        logger.entry(collection);
        Comparator comparator = new NaturalComparator<>();
        sortCollection(collection, comparator);
        logger.exit();
    }


    /**
     * This method sorts the elements of its collection using a specific
     * sorting algorithm.  The specified comparator is used to compare
     * each pair of elements during sorting.
     *
     * @param collection The collection to be sorted.
     * @param comparator The comparison function to be used during sorting.
     */
    public abstract void sortCollection(SortableCollection collection, Comparator comparator);

}