flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/CloseableIterator.scala

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.flink.streaming.api.scala

import org.apache.flink.util.{CloseableIterator => JCloseableIterator}

/**
 * This interface represents an [[Iterator]] that is also [[AutoCloseable]]. A typical use-case
 * for this interface are iterators that are based on native-resources such as files, network, or
 * database connections. Clients must call close after using the iterator.
 */
trait CloseableIterator[T] extends Iterator[T] with AutoCloseable {

}

object CloseableIterator {

  def fromJava[T](iterator: JCloseableIterator[T]): CloseableIterator[T] =
    new CloseableIterator[T] {
    override def hasNext: Boolean = iterator.hasNext

    override def next(): T = iterator.next

    override def close(): Unit = iterator.close()
  }
}