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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yarn Show documentation

Interfaces that enable folding and unfolding with state and resources.

The newest version!

/**
 *
 * 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;

/**
 * ArrayMap
 * 
 * 
 * An {@code ArrayMap} is a {@link org.github.evenjn.yarn.YarnMap YarnMap} that
 * provides access to output objects via arrays.
 * 
 * 
 * 
 * This interface 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 ArrayMap extends
		YarnMap {

	/**
	 * 
	 * {@code get} returns an array with the output objects associated to the
	 * argument {@code input}.
	 * 
	 * 
	 * @param input
	 *          An input object.
	 * @return An array of output objects.
	 * @since 1.0
	 */
	@Override
	O[] get( I input );
}