IIteratorProducer.java

/*
 * 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.jena.testing_framework;

import java.util.List;

import org.apache.jena.util.iterator.ExtendedIterator;

public interface IIteratorProducer<T> {

	/**
	 * Get a new instance of the iterator.
	 * 
	 * @return ExtendedIterator
	 */
	public ExtendedIterator<T> newInstance();

	/**
	 * Clean up after a test
	 */
	public void cleanUp();

	/**
	 * The list of items found in the iterator. Does not have to be in order.
	 * 
	 * @return List
	 */
	public List<T> getList();

	/**
	 * True if delete is supported by the iterator
	 * 
	 * @return boolean
	 */
	public boolean supportsDelete();

	/**
	 * True if this is an iterator on a copy so that delete works but getting a
	 * new copy for the iterator test will return the original list.
	 * 
	 * @return boolean
	 */
	public boolean isCopy();
}