001/*
002 * Copyright 2014 Alex Kasko (alexkasko.com)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.alexkasko.unsafe.offheap;
018
019import java.util.Iterator;
020
021/**
022 * Interface for iterators over off-heap collections those can be disposed manually
023 *
024 * @author alexkasko
025 * Date: 11/29/13
026 */
027public interface OffHeapDisposableIterator<T> extends Iterator<T>, OffHeapDisposable {
028    /**
029     * Optional method, should return size of the underlying collections,
030     * if such size is known on iterator creation or {@code -1} otherwise
031     *
032     * @return number of elements in iterator
033     */
034    long size();
035}