001/*
002 * ModeShape (http://www.modeshape.org)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *       http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.modeshape.common.collection.ring;
018
019/**
020 * An interface that defines methods to add and remove dependent {@link Pointer}s.
021 * 
022 * @author Randall Hauch (rhauch@redhat.com)
023 */
024public interface DependentOnPointers {
025
026    /**
027     * Ensure that this cursor always remains behind the specified pointer.
028     * 
029     * @param pointers the pointers that this cursor may not run past in the ring buffer
030     */
031    void stayBehind( Pointer... pointers );
032
033    /**
034     * Ignore the specified pointer that cursor had previously {@link #stayBehind(Pointer[]) stayed behind}. This should be called
035     * when the supplied pointer is removed from the ring buffer.
036     * 
037     * @param pointer the pointer that this cursor may no longer depend upon
038     * @return true if this cursor did depend on the supplied pointer and now no longer does, or false if this cursor never
039     *         dependent upon the supplied pointer
040     */
041    boolean ignore( Pointer pointer );
042}