Fred Quintana | 6a8d533 | 2009-05-07 17:35:38 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2009 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.content; |
| 18 | |
Fred Quintana | d5e4fdc | 2010-03-30 15:16:21 -0700 | [diff] [blame] | 19 | import java.util.Iterator; |
Fred Quintana | 6a8d533 | 2009-05-07 17:35:38 -0700 | [diff] [blame] | 20 | |
Fred Quintana | d5e4fdc | 2010-03-30 15:16:21 -0700 | [diff] [blame] | 21 | /** |
| 22 | * A specialization of {@link Iterator} that allows iterating over a collection of |
| 23 | * {@link Entity} objects. In addition to the iteration functionality it also allows |
| 24 | * resetting the iterator back to the beginning and provides for an explicit {@link #close()} |
| 25 | * method to indicate that the iterator is no longer needed and that its resources |
| 26 | * can be released. |
| 27 | */ |
| 28 | public interface EntityIterator extends Iterator<Entity> { |
Fred Quintana | 6a8d533 | 2009-05-07 17:35:38 -0700 | [diff] [blame] | 29 | /** |
Fred Quintana | d5e4fdc | 2010-03-30 15:16:21 -0700 | [diff] [blame] | 30 | * Reset the iterator back to the beginning. |
Fred Quintana | 6a8d533 | 2009-05-07 17:35:38 -0700 | [diff] [blame] | 31 | */ |
Fred Quintana | d5e4fdc | 2010-03-30 15:16:21 -0700 | [diff] [blame] | 32 | public void reset(); |
Fred Quintana | 7770975 | 2009-08-20 17:18:58 -0700 | [diff] [blame] | 33 | |
Fred Quintana | 6a8d533 | 2009-05-07 17:35:38 -0700 | [diff] [blame] | 34 | /** |
| 35 | * Indicates that this iterator is no longer needed and that any associated resources |
| 36 | * may be released (such as a SQLite cursor). |
| 37 | */ |
| 38 | public void close(); |
| 39 | } |