1 /*
2 * $Header: /home/cvs/jakarta-commons/primitives/src/java/org/apache/commons/collections/primitives/CharIterator.java,v 1.3 2003/10/16 20:49:36 scolebourne Exp $
3 * ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2003 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution, if
22 * any, must include the following acknowledgement:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgement may appear in the software itself,
26 * if and wherever such third-party acknowledgements normally appear.
27 *
28 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
29 * Foundation" must not be used to endorse or promote products derived
30 * from this software without prior written permission. For written
31 * permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache"
34 * nor may "Apache" appear in their names without prior written
35 * permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 *
56 */
57
58 package org.apache.commons.collections.primitives;
59
60 /**
61 * An iterator over <code>char</code> values.
62 *
63 * @see org.apache.commons.collections.primitives.adapters.CharIteratorIterator
64 * @see org.apache.commons.collections.primitives.adapters.IteratorCharIterator
65 *
66 * @since Commons Primitives 1.0
67 * @version $Revision: 1.3 $ $Date: 2003/10/16 20:49:36 $
68 *
69 * @author Rodney Waldhoff
70 */
71 public interface CharIterator {
72 /**
73 * Returns <code>true</code> iff I have more elements.
74 * (In other words, returns <code>true</code> iff
75 * a subsequent call to {@link #next next} will return
76 * an element rather than throwing an exception.)
77 *
78 * @return <code>true</code> iff I have more elements
79 */
80 boolean hasNext();
81
82 /**
83 * Returns the next element in me.
84 *
85 * @return the next element in me
86 * @throws NoSuchElementException if there is no next element
87 */
88 char next();
89
90 /**
91 * Removes from my underlying collection the last
92 * element {@link #next returned} by me
93 * (optional operation).
94 *
95 * @throws UnsupportedOperationException if this operation is not supported
96 * @throws IllegalStateException if {@link #next} has not yet been
97 * called, or {@link #remove} has already been called since
98 * the last call to {@link #next}.
99 */
100 void remove();
101 }
Save This Page