| /* |
| * 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 org.apache.directory.server.core.avltree; |
| |
| |
| import org.apache.directory.api.ldap.model.constants.Loggers; |
| import org.apache.directory.api.ldap.model.cursor.AbstractCursor; |
| import org.apache.directory.api.ldap.model.cursor.CursorException; |
| import org.apache.directory.api.ldap.model.cursor.InvalidCursorPositionException; |
| import org.apache.directory.api.ldap.model.exception.LdapException; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| |
| /** |
| * A Cursor for an ArrayTree. |
| * |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| */ |
| public class ArrayTreeCursor<E> extends AbstractCursor<E> |
| { |
| /** A dedicated log for cursors */ |
| private static final Logger LOG_CURSOR = LoggerFactory.getLogger( Loggers.CURSOR_LOG.getName() ); |
| |
| /** Speedup for logs */ |
| private static final boolean IS_DEBUG = LOG_CURSOR.isDebugEnabled(); |
| |
| /** The underlying ArrayTree */ |
| private ArrayTree<E> array; |
| |
| /** The current position/index in the array */ |
| private int current; |
| |
| /** The current position of this cursor, relative to the node */ |
| private Position position; |
| |
| |
| /** |
| * Create a cursor on an ArrayTree |
| * @param array The array we want a cursor for |
| */ |
| public ArrayTreeCursor( ArrayTree<E> array ) |
| { |
| if ( IS_DEBUG ) |
| { |
| LOG_CURSOR.debug( "Creating ArrayTreeCursor {}", this ); |
| } |
| |
| this.array = array; |
| position = Position.BEFORE_FIRST; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void after( E element ) throws LdapException, CursorException |
| { |
| checkNotClosed( "after" ); |
| |
| if ( element == null ) |
| { |
| afterLast(); |
| return; |
| } |
| |
| current = array.getAfterPosition( element ); |
| |
| if ( current == -1 ) |
| { |
| // As the element has not been found, we move after the last position |
| position = Position.AFTER_LAST; |
| } |
| else |
| { |
| // the cursor should be positioned after the given element |
| // we just fetched the next greater element so the cursor |
| // is positioned before the fetched element |
| position = Position.BEFORE_NODE; |
| } |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void afterLast() throws LdapException, CursorException |
| { |
| checkNotClosed( "afterLast" ); |
| |
| current = -1; |
| position = Position.AFTER_LAST; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public boolean available() |
| { |
| return position == Position.ON_NODE; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void before( E element ) throws LdapException, CursorException |
| { |
| checkNotClosed( "before" ); |
| |
| if ( element == null ) |
| { |
| beforeFirst(); |
| return; |
| } |
| |
| current = array.getBeforePosition( element ); |
| |
| if ( current == -1 ) |
| { |
| // If the element has not been found, move to thea first position |
| position = Position.BEFORE_FIRST; |
| } |
| else |
| { |
| // the cursor should be positioned before the given element |
| // we just fetched the next less element so the cursor |
| // is positioned after the fetched element |
| position = Position.AFTER_NODE; |
| } |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void beforeFirst() throws LdapException, CursorException |
| { |
| checkNotClosed( "beforeFirst" ); |
| |
| current = -1; |
| position = Position.BEFORE_FIRST; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public boolean first() throws LdapException, CursorException |
| { |
| checkNotClosed( "first" ); |
| |
| if ( array.isEmpty() ) |
| { |
| current = -1; |
| position = Position.BEFORE_FIRST; |
| return false; |
| } |
| else |
| { |
| current = 0; |
| position = Position.ON_NODE; |
| return true; |
| } |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public E get() throws CursorException |
| { |
| checkNotClosed( "get" ); |
| |
| if ( position == Position.ON_NODE ) |
| { |
| return array.get( current ); |
| } |
| |
| throw new InvalidCursorPositionException(); |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public boolean last() throws LdapException, CursorException |
| { |
| checkNotClosed( "last" ); |
| |
| if ( array.isEmpty() ) |
| { |
| current = -1; |
| position = Position.AFTER_LAST; |
| return false; |
| } |
| else |
| { |
| current = array.size() - 1; |
| position = Position.ON_NODE; |
| return true; |
| } |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public boolean next() throws LdapException, CursorException |
| { |
| checkNotClosed( "next" ); |
| |
| // If the array is empty, return false |
| if ( array.size() == 0 ) |
| { |
| return false; |
| } |
| |
| switch ( position ) |
| { |
| case BEFORE_FIRST: |
| return first(); |
| |
| case BEFORE_NODE: |
| position = Position.ON_NODE; |
| return true; |
| |
| case ON_NODE: |
| case AFTER_NODE: |
| current++; |
| if ( current > array.size() - 1 ) |
| { |
| afterLast(); |
| return false; |
| } |
| else |
| { |
| position = Position.ON_NODE; |
| return true; |
| } |
| |
| case AFTER_LAST: |
| return false; |
| |
| default: |
| throw new IllegalStateException( "Unexpected position " + position ); |
| } |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public boolean previous() throws LdapException, CursorException |
| { |
| checkNotClosed( "previous" ); |
| |
| if ( array.size() == 0 ) |
| { |
| return false; |
| } |
| |
| switch ( position ) |
| { |
| case BEFORE_FIRST: |
| return false; |
| |
| case BEFORE_NODE: |
| case ON_NODE: |
| current--; |
| if ( current < 0 ) |
| { |
| beforeFirst(); |
| return false; |
| } |
| else |
| { |
| position = Position.ON_NODE; |
| return true; |
| } |
| |
| case AFTER_NODE: |
| position = Position.ON_NODE; |
| return true; |
| |
| case AFTER_LAST: |
| return last(); |
| |
| default: |
| throw new IllegalStateException( "Unexpected position " + position ); |
| } |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void close() |
| { |
| if ( IS_DEBUG ) |
| { |
| LOG_CURSOR.debug( "Closing ArrayTreeCursor {}", this ); |
| } |
| |
| super.close(); |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void close( Exception reason ) |
| { |
| if ( IS_DEBUG ) |
| { |
| LOG_CURSOR.debug( "Closing ArrayTreeCursor {}", this ); |
| } |
| |
| super.close( reason ); |
| } |
| |
| |
| /** |
| * @see Object#toString() |
| */ |
| public String toString( String tabs ) |
| { |
| StringBuilder sb = new StringBuilder(); |
| |
| sb.append( tabs ).append( "ArrayTreeCursor (" ); |
| |
| if ( available() ) |
| { |
| sb.append( "available)" ); |
| sb.append( "#<" ).append( current ).append( ":" ).append( array.get( current ) ).append( ">" ); |
| } |
| else |
| { |
| sb.append( "absent)" ); |
| } |
| |
| return sb.toString(); |
| } |
| |
| |
| /** |
| * @see Object#toString() |
| */ |
| public String toString() |
| { |
| return toString( "" ); |
| } |
| } |