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.discovery;
18
19 /**
20 * Iterate over resource names.
21 * The semantics are somewhat unusual, for better or worse.
22 * hasNext is presumed to be destructive to the current state,
23 * each call will 'move' the cursor.
24 * nextResourceName() MUST BE non-destructive,
25 * it does not change the state.
26 *
27 * TODO: FIX iterator logic/semantics, possibly add 'currentResourceName()'.
28 */
29 public interface ResourceNameIterator {
30
31 /**
32 * Returns true if the iteration has more elements.
33 *
34 * @return true if the iterator has more elements, false otherwise
35 */
36 boolean hasNext();
37
38 /**
39 * nextResourceName() returns the name of the next resource,
40 * and MUST be non-destructive. Repeated calls
41 *
42 * @return The next resource name in the iteration
43 */
44 String nextResourceName();
45
46 }