001/*
002 *  Copyright 2001-2010 Stephen Colebourne
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 */
016package org.joda.primitives.listiterator;
017
018import org.joda.primitives.iterator.IntIterator;
019
020/**
021 * Defines a list iterator over primitive <code>int</code> values.
022 * 
023 * @author Stephen Colebourne
024 * @author Jason Tiscione
025 * @version CODE GENERATED
026 * @since 1.0
027 */
028public interface IntListIterator extends IntIterator, PrimitiveListIterator<Integer> {
029    // This file is CODE GENERATED. Do not change manually.
030
031    // Mandatory operations
032    //-----------------------------------------------------------------------
033    /**
034     * Gets the previous value from the iterator.
035     *
036     * @return the previous available value
037     * @throws NoSuchElementException if there are no more values available
038     */
039    int previousInt();
040
041    // Optional operations
042    //-----------------------------------------------------------------------
043    /**
044     * Adds the specified value to the list underlying the iterator at the
045     * current iteration index (optional operation).
046     *
047     * @param value  the value to add
048     * @throws IllegalStateException if the iterator cannot be added to at present
049     * @throws UnsupportedOperationException if not supported by this collection
050     */
051    void add(int value);
052
053    /**
054     * Sets the last retrieved value from the iterator (optional operation).
055     *
056     * @param value  the value to set
057     * @throws IllegalStateException if the iterator cannot be set to at present
058     * @throws UnsupportedOperationException if not supported by this collection
059     */
060    void set(int value);
061
062}