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.training.jni;
18 
19 import java.io.Closeable;
20 
21 /** This class offers a task environment to C++ code. */
22 public interface JavaExampleIterator extends Closeable {
23     /**
24      * Returns the next training example which is typically a serialized tf.Example, but can really
25      * be any sort of serialized data that the TensorFlow graph can process in batches of DT_STRING
26      * tensors.
27      */
next()28     byte[] next() throws Exception;
29 
30     /**
31      * Called by C++ when the iterator is no longer used and can be closed. May be called multiple
32      * times, by C++ and Java.
33      */
34     @Override
close()35     void close();
36 }
37