javolution.util.FastSortedTable Maven / Gradle / Ivy

Go to download
/*
 * Javolution - Java(TM) Solution for Real-Time and Embedded Systems
 * Copyright (C) 2012 - Javolution (http://javolution.org/)
 * All rights reserved.
 * 
 * Permission to use, copy, modify, and distribute this software is
 * freely granted, provided that this notice is preserved.
 */
package javolution.util;

import static javolution.lang.Realtime.Limit.LOG_N;

import java.util.Collection;
import java.util.Comparator;

import javolution.lang.Realtime;
import javolution.util.function.Equalities;
import javolution.util.internal.table.sorted.AtomicSortedTableImpl;
import javolution.util.internal.table.sorted.FastSortedTableImpl;
import javolution.util.internal.table.sorted.SharedSortedTableImpl;
import javolution.util.internal.table.sorted.UnmodifiableSortedTableImpl;
import javolution.util.service.SortedTableService;

/**
 *  A high-performance sorted table with {@link Realtime real-time} behavior.
 *      Sorted table have significantly faster {@link #contains}, 
 *     {@link #indexOf} and {@link #remove} methods).
 *     
 * This class is comparable to {@link FastSortedSet} in performance, 
 *    but it allows for duplicate and implements the {@link java.util.List}
 *    interface.
 *     
 * @author  Jean-Marie Dautelle
 * @version 6.0, July 21, 2013
 */
public class FastSortedTable extends FastTable {

    private static final long serialVersionUID = 0x600L; // Version.

    /**
     * Returns a new sorted table holding the specified elements
     * (convenience method).
     */
    public static  FastSortedTable of(E... elements) {
    	FastSortedTable table = new FastSortedTable();
    	for (E e : elements) table.add(e);
        return table;
    }
    
    /**
     * Returns a new sorted table holding the same elements as the specified 
     * collection (convenience method).
     */
    public static  FastSortedTable of(Collection that) {
    	FastSortedTable table = new FastSortedTable();
    	table.addAll(that);
        return table;
    }
    
    /**
      * Creates an empty table sorted using its elements natural order.     
     */
    public FastSortedTable() {
        this(Equalities.STANDARD);
    }

    /**
     * Creates an empty table sorted using the specified element comparator.
     */
    public FastSortedTable(Comparator comparator) {
        super(new FastSortedTableImpl(comparator));
    }

    /**
     * Creates a sorted table backed up by the specified service implementation.
     */
    protected FastSortedTable(SortedTableService service) {
        super(service);
    }

    ////////////////////////////////////////////////////////////////////////////
    // Views.
    //

    @Override
    public FastSortedTable atomic() {
        return new FastSortedTable(new AtomicSortedTableImpl(service()));
    }

    @Override
    public FastSortedTable shared() {
        return new FastSortedTable(new SharedSortedTableImpl(service()));
    }

    @Override
    public FastSortedTable unmodifiable() {
        return new FastSortedTable(new UnmodifiableSortedTableImpl(
                service()));
    }

    ////////////////////////////////////////////////////////////////////////////
    // Change in time limit behavior.
    //

    @Realtime(limit = LOG_N)
    public boolean contains(Object obj) {
        return service().contains(obj);
    }

    @Realtime(limit = LOG_N)
    public boolean remove(Object obj) {
        return service().remove(obj);
    }

    @Override
    @Realtime(limit = LOG_N)
    public int indexOf(final Object obj) {
        return service().indexOf(obj);
    }

    ////////////////////////////////////////////////////////////////////////////
    // Misc.
    //

    /** 
     * Adds the specified element only if not already present.
     *  
     * @return {@code true} if the element has been added; 
     *         {@code false} otherwise.
     */
    @Realtime(limit = LOG_N)
    public boolean addIfAbsent(E element) {
        return service().addIfAbsent(element);
    }

    /** 
     * Returns the index of the specified element if present; or a negative 
     * number equals to {@code -n} with {@code n} being the index next to 
     * the "would be" index of the specified element if the specified element 
     * was to be added.
     */
    @Realtime(limit = LOG_N)
    public int positionOf(E element) {
        return service().positionOf(element);
    }

    @Override
    protected SortedTableService service() {
        return (SortedTableService) super.service();
    }

}