Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
BooleanIterator |
|
| 1.0;1 |
1 | /* | |
2 | * Licensed to the Apache Software Foundation (ASF) under one or more | |
3 | * contributor license agreements. See the NOTICE file distributed with | |
4 | * this work for additional information regarding copyright ownership. | |
5 | * The ASF licenses this file to You under the Apache License, Version 2.0 | |
6 | * (the "License"); you may not use this file except in compliance with | |
7 | * the License. You may obtain a copy of the License at | |
8 | * | |
9 | * http://www.apache.org/licenses/LICENSE-2.0 | |
10 | * | |
11 | * Unless required by applicable law or agreed to in writing, software | |
12 | * distributed under the License is distributed on an "AS IS" BASIS, | |
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
14 | * See the License for the specific language governing permissions and | |
15 | * limitations under the License. | |
16 | */ | |
17 | package org.apache.commons.collections.primitives; | |
18 | ||
19 | /** | |
20 | * An iterator over <code>boolean</code> values. | |
21 | * | |
22 | * @see org.apache.commons.collections.primitives.adapters.BooleanIteratorIterator | |
23 | * @see org.apache.commons.collections.primitives.adapters.IteratorBooleanIterator | |
24 | * | |
25 | * @since Commons Primitives 1.1 | |
26 | * @version $Revision: 480460 $ $Date: 2006-11-29 03:14:21 -0500 (Wed, 29 Nov 2006) $ | |
27 | */ | |
28 | public interface BooleanIterator { | |
29 | /** | |
30 | * Returns <code>true</code> iff I have more elements. (In other words, | |
31 | * returns <code>true</code> iff a subsequent call to {@link #next next} | |
32 | * will return an element rather than throwing an exception.) | |
33 | * | |
34 | * @return <code>true</code> iff I have more elements | |
35 | */ | |
36 | boolean hasNext(); | |
37 | ||
38 | /** | |
39 | * Returns the next element in me. | |
40 | * | |
41 | * @return the next element in me | |
42 | * @throws java.util.NoSuchElementException if there is no next element | |
43 | */ | |
44 | boolean next(); | |
45 | ||
46 | /** | |
47 | * Removes from my underlying collection the last element {@link #next | |
48 | * returned} by me (optional operation). | |
49 | * | |
50 | * @throws UnsupportedOperationException if this operation is not supported | |
51 | * @throws IllegalStateException if {@link #next} has not yet been called, | |
52 | * or {@link #remove} has already been called since the last call | |
53 | * to {@link #next}. | |
54 | */ | |
55 | void remove(); | |
56 | } |