001: /*
002: * $Header: /home/cvs/jakarta-commons/primitives/src/java/org/apache/commons/collections/primitives/FloatListIterator.java,v 1.3 2003/10/16 20:49:35 scolebourne Exp $
003: * ====================================================================
004: * The Apache Software License, Version 1.1
005: *
006: * Copyright (c) 2003 The Apache Software Foundation. All rights
007: * reserved.
008: *
009: * Redistribution and use in source and binary forms, with or without
010: * modification, are permitted provided that the following conditions
011: * are met:
012: *
013: * 1. Redistributions of source code must retain the above copyright
014: * notice, this list of conditions and the following disclaimer.
015: *
016: * 2. Redistributions in binary form must reproduce the above copyright
017: * notice, this list of conditions and the following disclaimer in
018: * the documentation and/or other materials provided with the
019: * distribution.
020: *
021: * 3. The end-user documentation included with the redistribution, if
022: * any, must include the following acknowledgement:
023: * "This product includes software developed by the
024: * Apache Software Foundation (http://www.apache.org/)."
025: * Alternately, this acknowledgement may appear in the software itself,
026: * if and wherever such third-party acknowledgements normally appear.
027: *
028: * 4. The names "The Jakarta Project", "Commons", and "Apache Software
029: * Foundation" must not be used to endorse or promote products derived
030: * from this software without prior written permission. For written
031: * permission, please contact apache@apache.org.
032: *
033: * 5. Products derived from this software may not be called "Apache"
034: * nor may "Apache" appear in their names without prior written
035: * permission of the Apache Software Foundation.
036: *
037: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
038: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
039: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
040: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
041: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
042: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
043: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
044: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
045: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
046: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
047: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
048: * SUCH DAMAGE.
049: * ====================================================================
050: *
051: * This software consists of voluntary contributions made by many
052: * individuals on behalf of the Apache Software Foundation. For more
053: * information on the Apache Software Foundation, please see
054: * <http://www.apache.org/>.
055: *
056: */
057:
058: package org.apache.commons.collections.primitives;
059:
060: /**
061: * A bi-directional iterator over <code>float</code> values.
062: *
063: * @see org.apache.commons.collections.primitives.adapters.FloatListIteratorListIterator
064: * @see org.apache.commons.collections.primitives.adapters.ListIteratorFloatListIterator
065: *
066: * @since Commons Primitives 1.0
067: * @version $Revision: 1.3 $ $Date: 2003/10/16 20:49:35 $
068: *
069: * @author Rodney Waldhoff
070: */
071: public interface FloatListIterator extends FloatIterator {
072: /**
073: * Inserts the specified element into my underlying collection
074: * (optional operation).
075: * The element is inserted immediately before the next element
076: * that would have been returned by {@link #next}, if any,
077: * and immediately after the next element that would have been
078: * returned by {@link #previous}, if any.
079: * <p/>
080: * The new element is inserted immediately before the implied
081: * cursor. A subsequent call to {@link #previous} will return
082: * the added element, a subsequent call to {@link #next} will
083: * be unaffected. This call increases by one the value that
084: * would be returned by a call to {@link #nextIndex} or
085: * {@link #previousIndex}.
086: *
087: * @param element the value to be inserted
088: *
089: * @throws UnsupportedOperationException when this operation is not
090: * supported
091: * @throws IllegalArgumentException if some aspect of the specified element
092: * prevents it from being added
093: */
094: void add(float element);
095:
096: /**
097: * Returns <code>true</code> iff I have more elements
098: * when traversed in the forward direction.
099: * (In other words, returns <code>true</code> iff
100: * a call to {@link #next} will return an element
101: * rather than throwing an exception.
102: *
103: * @return <code>true</code> iff I have more elements when
104: * traversed in the forward direction
105: */
106: boolean hasNext();
107:
108: /**
109: * Returns <code>true</code> iff I have more elements
110: * when traversed in the reverse direction.
111: * (In other words, returns <code>true</code> iff
112: * a call to {@link #previous} will return an element
113: * rather than throwing an exception.
114: *
115: * @return <code>true</code> iff I have more elements when
116: * traversed in the reverse direction
117: */
118: boolean hasPrevious();
119:
120: /**
121: * Returns the next element in me when traversed in the
122: * forward direction.
123: *
124: * @return the next element in me
125: * @throws NoSuchElementException if there is no next element
126: */
127: float next();
128:
129: /**
130: * Returns the index of the element that would be returned
131: * by a subsequent call to {@link #next}, or the number
132: * of elements in my iteration if I have no next element.
133: *
134: * @return the index of the next element in me
135: */
136: int nextIndex();
137:
138: /**
139: * Returns the next element in me when traversed in the
140: * reverse direction.
141: *
142: * @return the previous element in me
143: * @throws NoSuchElementException if there is no previous element
144: */
145: float previous();
146:
147: /**
148: * Returns the index of the element that would be returned
149: * by a subsequent call to {@link #previous}, or
150: * <code>-1</code> if I have no previous element.
151: *
152: * @return the index of the previous element in me
153: */
154: int previousIndex();
155:
156: /**
157: * Removes from my underlying collection the last
158: * element returned by {@link #next} or {@link #previous}
159: * (optional operation).
160: *
161: * @throws UnsupportedOperationException if this operation is not
162: * supported
163: * @throws IllegalStateException if neither {@link #next} nor
164: * {@link #previous} has yet been called, or
165: * {@link #remove} or {@link #add} has already been called since
166: * the last call to {@link #next} or {@link #previous}.
167: */
168: void remove();
169:
170: /**
171: * Replaces in my underlying collection the last
172: * element returned by {@link #next} or {@link #previous}
173: * with the specified value (optional operation).
174: *
175: * @param element the value to replace the last returned element with
176: * @throws UnsupportedOperationException if this operation is not
177: * supported
178: * @throws IllegalStateException if neither {@link #next} nor
179: * {@link #previous} has yet been called, or
180: * {@link #remove} or {@link #add} has already been called since
181: * the last call to {@link #next} or {@link #previous}.
182: * @throws IllegalArgumentException if some aspect of the specified element
183: * prevents it from being added
184: */
185: void set(float element);
186: }
|