org.github.evenjn.yarn.CursorRingMap Maven / Gradle / Ivy

Go to download
/**
 *
 * Copyright 2017 Marco Trevisan
 *
 * Licensed 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.github.evenjn.yarn;

import org.github.evenjn.lang.Rook;

/**
 * CursorRingMap
 * 
 * 
 * A {@code CursorRingMap} is a {@linkplain org.github.evenjn.yarn.YarnRingMap
 * YarnRingMap} that provides access to output objects via
 * {@link org.github.evenjn.yarn.Cursor Cursor} containers.
 * 
 * 
 * 
 * This class is part of package {@link org.github.evenjn.yarn Yarn}.
 * 
 * 
 * @param 
 *          The type of input objects.
 * @param 
 *          The type of output objects.
 * @since 1.0
 */
@FunctionalInterface
public interface CursorRingMap extends
		YarnRingMap> {

	/**
	 * 
	 * Returns a {@link org.github.evenjn.yarn.Cursor Cursor} with output objects
	 * associated to the argument input after transferring the responsiblity of
	 * closing any associated resources to the argument
	 * {@link org.github.evenjn.lang.Rook Rook}.
	 * 
	 * 
	 * @param rook
	 *          A {@link org.github.evenjn.lang.Rook Rook}.
	 * @param input
	 *          An input object.
	 * @return A {@link org.github.evenjn.yarn.Cursor Cursor} of output objects.
	 * @since 1.0
	 */
	@Override
	Cursor get( Rook rook, I input );
}