/*
 * (c) Copyright 2009 Hewlett-Packard Development Company, LP
 * All rights reserved.
 * [See end of file]
 */

package structure;

import org.openjena.atlas.io.Printable;

import java.util.Iterator;
import java.util.List;

// May change to allow duplicates -- OrderedBag
public interface OrderedSet<T extends Comparable<? super T>> extends Iterable<T>, Printable
{
    /** Clear all elements */ 
    public void clear() ;
    
    // This could be java.util.SortedSet - except that's quite large.

    public boolean contains(T item);

    public boolean isEmpty();
    
    public T search(T item);
    
    public boolean add(T item);
    
    public boolean remove(T item);
    
    public T max() ;

    public T min() ;
    
    // hashCode
    // equals
    // Comparator<? super T>  comparator() ; 
    // subset
    // headSet
    // tailSet
    
    /** Number of elements in the set */
    public long size() ;
    
    /** Size by actually walking the tree and counting - mainly for testing */
    public long count() ;
    public void checkTree() ;
    public List<T> elements() ;
    
    @Override
    public Iterator<T> iterator() ;
    public Iterator<T> iterator(T startInc, T endExc) ;
}

/*
 * (c) Copyright 2009 Hewlett-Packard Development Company, LP
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */