blob: 38fba8ec9d4e1765ec2588e6600223e74532922b [file] [log] [blame]
/*
* 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.kafka.common.utils;
import java.io.Closeable;
import java.util.Iterator;
/**
* Iterators that need to be closed in order to release resources should implement this interface.
*
* Warning: before implementing this interface, consider if there are better options. The chance of misuse is
* a bit high since people are used to iterating without closing.
*/
public interface CloseableIterator<T> extends Iterator<T>, Closeable {
void close();
}