drv.ListIterator.drv Maven / Gradle / Ivy
Show all versions of fastutil-core Show documentation
/*
* Copyright (C) 2002-2022 Sebastiano Vigna
*
* Licensed 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 PACKAGE;
import java.util.ListIterator;
/** A type-specific bidirectional iterator that is also a {@link ListIterator}.
*
* This interface merges the methods provided by a {@link ListIterator} and
* a type-specific {@link it.unimi.dsi.fastutil.BidirectionalIterator}. Moreover, it provides
* type-specific versions of {@link ListIterator#add(Object) add()}
* and {@link ListIterator#set(Object) set()}.
*
* @see java.util.ListIterator
* @see it.unimi.dsi.fastutil.BidirectionalIterator
*/
public interface KEY_LIST_ITERATOR KEY_GENERIC extends KEY_BIDI_ITERATOR KEY_GENERIC, ListIterator {
/**
* Replaces the last element returned by {@link #next} or
* {@link #previous} with the specified element (optional operation).
* @param k the element used to replace the last element returned.
*
* This default implementation just throws an {@link UnsupportedOperationException}.
* @see ListIterator#set(Object)
*/
#if KEYS_REFERENCE
@Override
#endif
default void set(final KEY_GENERIC_TYPE k) { throw new UnsupportedOperationException(); }
/**
* Inserts the specified element into the list (optional operation).
*
*
This default implementation just throws an {@link UnsupportedOperationException}.
* @param k the element to insert.
* @see ListIterator#add(Object)
*/
#if KEYS_REFERENCE
@Override
#endif
default void add(final KEY_GENERIC_TYPE k) { throw new UnsupportedOperationException(); }
/**
* Removes from the underlying collection the last element returned
* by this iterator (optional operation).
*
*
This default implementation just throws an {@link UnsupportedOperationException}.
* @see ListIterator#remove()
*/
@Override
default void remove() { throw new UnsupportedOperationException(); }
#if KEYS_PRIMITIVE
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
default void set(final KEY_CLASS k) { set(k.KEY_VALUE()); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
default void add(final KEY_CLASS k) { add(k.KEY_VALUE()); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
default KEY_GENERIC_CLASS next() { return KEY_BIDI_ITERATOR.super.next(); }
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
default KEY_GENERIC_CLASS previous() { return KEY_BIDI_ITERATOR.super.previous(); }
#endif
}