1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 package org.apache.river.discovery;
20
21 import java.io.IOException;
22 import java.net.DatagramPacket;
23
24 /**
25 * Iterator for performing multicast encode operations on (potentially)
26 * multiple discovery format providers.
27 *
28 * @author Sun Microsystems, Inc.
29 * @since 2.0
30 */
31 public interface EncodeIterator {
32
33 /**
34 * Performs a single multicast encode operation using the next encoder
35 * provider of a {@link Discovery} instance, returning the resulting
36 * datagram packets or throwing the resulting exception.
37 *
38 * @return datagram packets resulting from an encode operation
39 * @throws IOException if the encode operation failed
40 * @throws net.jini.io.UnsupportedConstraintException if the encode
41 * operation is unable to satisfy its constraints
42 * @throws java.util.NoSuchElementException if there are no more encoders
43 * for this iterator
44 */
45 DatagramPacket[] next() throws IOException;
46
47 /**
48 * Returns <code>true</code> if this iterator has additional encoders, or
49 * <code>false</code> otherwise.
50 *
51 * @return <code>true</code> if this iterator has additional encoders, or
52 * <code>false</code> otherwise
53 */
54 boolean hasNext();
55 }