org.snmp4j.agent.request.SubRequestIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of snmp4j-agent Show documentation

SNMP-Agent API for Java

There is a newer version: 3.8.1

/*_############################################################################
  _## 
  _##  SNMP4J-Agent 3 - SubRequestIterator.java  
  _## 
  _##  Copyright (C) 2005-2021  Frank Fock (SNMP4J.org)
  _##  
  _##  Licensed under the Apache License, Version 2.0 (the "License");
  _##  you may not use this file except in compliance with the License.
  _##  You may obtain a copy of the License at
  _##  
  _##      http://www.apache.org/licenses/LICENSE-2.0
  _##  
  _##  Unless required by applicable law or agreed to in writing, software
  _##  distributed under the License is distributed on an "AS IS" BASIS,
  _##  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  _##  See the License for the specific language governing permissions and
  _##  limitations under the License.
  _##  
  _##########################################################################*/


package org.snmp4j.agent.request;

import java.util.Iterator;
import java.util.NoSuchElementException;

/**
 * The {@code SubRequestIterator} interface implements
 * the Iterator interface for {@link SubRequest} instances.
 *
 * @author Frank Fock
 * @version 3.1.0
 */

public interface SubRequestIterator extends Iterator {

    /**
     * Gets the next sub-request that is pending.
     * @return
     *    an unprocessed {@code SubRequest} instance.
     * @throws java.util.NoSuchElementException
     *    if there are no more elements available.
     */
    S next() throws NoSuchElementException;

    /**
     * Returns {@code true} if there are more sub-requests to process.
     * In other words, returns {@code true} if next would return an element
     * rather than throwing an exception.
     * @return
     *    {@code true} if there are more sub-requests.
     */
    boolean hasNext();

}