jdbm.helper.ExplicitList Maven / Gradle / Ivy

Go to download
/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package jdbm.helper;


/**
 * A simple doubly linked list implementation that can be used when fast remove operations are desired.
 * Objects are inserted into the list through an anchor (Link). When object is to be removed from the
 * list, this anchor is provided by the client again and this class can do the remove operation in O(1)
 * using the given anchor.
 *
 * @author Apache Directory Project
 */
public class ExplicitList
{

    private Link head = new Link( null );

    private int listSize = 0;

    public static class Link
    {
        private V element;
        private Link next;
        private Link prev;


        public Link( V element )
        {
            this.element = element;
            this.reset();
        }


        public Link getNext()
        {
            return next;
        }


        public void setNext( Link next )
        {
            this.next = next;
        }


        public Link getPrev()
        {
            return prev;
        }


        public void setPrev( Link prev )
        {
            this.prev = prev;
        }


        public void remove()
        {
            if ( isLinked() == false )
            {
                throw new IllegalStateException( "Trying to remove from list an unlinked link" );
            }

            this.getPrev().setNext( this.getNext() );
            this.getNext().setPrev( this.getPrev() );
            this.reset();
        }


        public void addAfter( Link after )
        {
            if ( this.isUnLinked() == false )
            {
                throw new IllegalStateException( "Trying to add to list already linked link: " + this );
            }

            after.getNext().setPrev( this );
            this.setNext( after.getNext() );
            after.setNext( this );
            this.setPrev( after );
        }


        public void addBefore( Link before )
        {
            if ( this.isUnLinked() == false )
            {
                throw new IllegalStateException( "Trying to add to list already linked link: " + this );
            }

            before.getPrev().setNext( this );
            this.setPrev( before.getPrev() );
            before.setPrev( this );
            this.setNext( before );
        }


        /**
         * Splices the given list by making this link as the new head.
         *
         * @param listHead head of the existing list
         */
        public void splice( Link listHead )
        {
            Link prevLink = listHead.getPrev();
            listHead.setPrev( this );
            prevLink.setNext( this );
            this.setNext( listHead );
            this.setPrev( prevLink );
        }


        public boolean isUnLinked()
        {
            return ( ( prev == this ) && ( next == this ) );
        }


        public boolean isLinked()
        {
            return ( !this.isUnLinked() );
        }


        public void reset()
        {
            next = this;
            prev = this;
        }


        public void uninit()
        {
            if ( this.isUnLinked() == false )
            {
                throw new IllegalStateException( " Unitializing a still linked entry" + this );
            }

            element = null;
        }


        public V getElement()
        {
            return this.element;
        }


        @Override
        public String toString()
        {
            StringBuilder sb = new StringBuilder();
            sb.append( "Link: " ).append( this ).append( " " );
            sb.append( "(next: " ).append( next );
            sb.append( ",prev: " ).append( prev ).append( ")" );
            sb.append( "\n" );

            return sb.toString();
        }
    }


    public void remove( Link link )
    {
        if ( listSize <= 0 )
        {
            throw new IllegalStateException( "Trying to remove link " + link + " from a list with no elements" );
        }

        listSize--;
        link.remove();
    }


    public void addFirst( Link link )
    {
        listSize++;
        link.addAfter( head );
    }


    public void addLast( Link link )
    {
        listSize++;
        link.addBefore( head );
    }


    public Link begin()
    {
        return ( head.getNext() );
    }


    public Link end()
    {
        return head;
    }


    public int size()
    {
        return listSize;
    }


    @Override
    public String toString()
    {
        StringBuilder sb = new StringBuilder();
        sb.append( "List: " );
        sb.append( "(size: " ).append( listSize ).append( ")" );
        sb.append( "\n" );

        return sb.toString();
    }

}