org.d2ab.function.chars.CharUnaryOperator Maven / Gradle / Ivy
Show all versions of sequence Show documentation
/*
* 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.Objects;
import java.util.function.UnaryOperator;
/**
* Represents an operation on a single {@code char}-valued operand that produces an {@code char}-valued result. This is
* the primitive type specialization of {@link UnaryOperator} for {@code char}.
*
*
This is a functional interface whose functional method is {@link #applyAsChar(char)}.
*
* @see UnaryOperator
*/
@FunctionalInterface
public interface CharUnaryOperator {
/**
* Returns a unary operator that always returns its input argument.
*
* @return a unary operator that always returns its input argument
*/
static CharUnaryOperator identity() {
return t -> t;
}
/**
* Returns a composed operator that first applies the {@code before} operator to its input, and then applies this
* operator to the result. If evaluation of either operator throws an exception, it is relayed to the caller of the
* composed operator.
*
* @param before the operator to apply before this operator is applied
*
* @return a composed operator that first applies the {@code before} operator and then applies this operator
*
* @throws NullPointerException if before is null
* @see #andThen(CharUnaryOperator)
*/
default CharUnaryOperator compose(CharUnaryOperator before) {
Objects.requireNonNull(before);
return (char v) -> applyAsChar(before.applyAsChar(v));
}
/**
* Applies this operator to the given operand.
*
* @param operand the operand
*
* @return the operator result
*/
char applyAsChar(char operand);
/**
* Returns a composed operator that first applies this operator to its input, and then applies the {@code after}
* operator to the result. If evaluation of either operator throws an exception, it is relayed to the caller of the
* composed operator.
*
* @param after the operator to apply after this operator is applied
*
* @return a composed operator that first applies this operator and then applies the {@code after} operator
*
* @throws NullPointerException if after is null
* @see #compose(CharUnaryOperator)
*/
default CharUnaryOperator andThen(CharUnaryOperator after) {
Objects.requireNonNull(after);
return (char t) -> after.applyAsChar(applyAsChar(t));
}
}