001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.discovery;
018
019/**
020 * Iterate over resource names.
021 * The semantics are somewhat unusual, for better or worse.
022 * hasNext is presumed to be destructive to the current state,
023 * each call will 'move' the cursor.
024 * nextResourceName() MUST BE non-destructive,
025 * it does not change the state.
026 *
027 * TODO: FIX iterator logic/semantics, possibly add 'currentResourceName()'.
028 */
029public interface ResourceNameIterator {
030
031    /**
032     * Returns true if the iteration has more elements.
033     *
034     * @return true if the iterator has more elements, false otherwise
035     */
036    boolean hasNext();
037
038    /**
039     * nextResourceName() returns the name of the next resource,
040     * and MUST be non-destructive.  Repeated calls
041     *
042     * @return The next resource name in the iteration
043     */
044    String nextResourceName();
045
046}