craterdog.collections.interfaces.Ordered 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.interfaces;

import java.util.Comparator;


/**
 * This interface defines the methods that must be implemented by each collection that
 * supports an implicit ordering of its elements.
 *
 * @author Derk Norton
 * @param  The type of element managed by the collection.
 */
public interface Ordered {

    /**
     * This method returns the comparator that is used to order the elements in this collection.
     *
     * @return The comparator that is used to order the elements in this collection.
     */
    Comparator getComparator();

}