01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: * @author Richard A. Sitze
30: */
31: public interface ResourceNameIterator {
32: /**
33: * hasNext()
34: */
35: public boolean hasNext();
36:
37: /**
38: * nextResourceName() returns the name of the next resource,
39: * and MUST be non-destructive. Repeated calls
40: */
41: public String nextResourceName();
42: }
|