1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.federatedcompute.services.examplestore;
18 
19 import com.android.federatedcompute.services.common.ErrorStatusException;
20 
21 import java.io.Closeable;
22 
23 /** The interface of ExampleIterator. */
24 public interface ExampleIterator extends Closeable {
25 
26     /** Called to check if next example is available. */
hasNext()27     boolean hasNext() throws InterruptedException, ErrorStatusException;
28 
29     /** Called when federated computation job needs another example. */
next()30     byte[] next() throws InterruptedException, ErrorStatusException;
31 
32     /** Called when it is done using this iterator instance. */
33     @Override
close()34     void close();
35 }
36