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