org.d2ab.function.chars.CharBinaryOperator Maven / Gradle / Ivy

Go to download

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

A lightweight alternative to Java 8 sequential Stream

There is a newer version: 2.3.0

/*
 * Copyright 2015 Daniel Skogquist Åborg
 *
 * 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.d2ab.function.chars;

import java.util.function.BinaryOperator;

/**
 * Represents an operation upon two {@code char}-valued operands and producing an {@code char}-valued result.   This is
 * the primitive type specialization of {@link BinaryOperator} for {@code char}.
 * 
 * This is a functional interface whose functional method is {@link
 * #applyAsChar(char, char)}.
 *
 * @see BinaryOperator
 * @see CharUnaryOperator
 * @since 1.8
 */
@FunctionalInterface
public interface CharBinaryOperator {
	/**
	 * Applies this operator to the given operands.
	 *
	 * @param left  the first operand
	 * @param right the second operand
	 *
	 * @return the operator result
	 */
	char applyAsChar(char left, char right);
}