org.eu.zajc.ef.binary.CharBinaryOperator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of extended-functions Show documentation

Specializations and support utilities for functional interfaces that are missing from the standard library

The newest version!

// SPDX-License-Identifier: Apache-2.0
/*
 * extended-functions
 * Copyright 2021-2024 Marko Zajc
 *
 * 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.eu.zajc.ef.binary;

import java.util.function.BinaryOperator;

import org.eu.zajc.ef.unary.CharUnaryOperator;

/**
 * Represents an operation upon two {@code char}-valued operands and producing a
 * {@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
 *
 * @author Marko Zajc
 */
@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);

}