org.instancio.RandomUnaryOperator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of instancio-core Show documentation

The standalone module of Instancio

There is a newer version: 5.0.2

/*
 * Copyright 2022-2024 the original author or authors.
 *
 * 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
 *
 *      https://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.instancio;

import org.instancio.documentation.ExperimentalApi;

/**
 * Represents a unary operator that produces a result of the same type
 * as its operand. This operator can use an additional {@link Random}
 * parameter for randomising the output, if necessary.
 *
 * @param  the type of the input and output of the function
 * @see RandomFunction
 * @since 5.0.0
 */
@ExperimentalApi
@FunctionalInterface
public interface RandomUnaryOperator extends RandomFunction {

    /**
     * Applies this operator to the given operand,
     * using the provided {@link Random} instance.
     *
     * @param input  the function input
     * @param random instance for randomising the result
     * @return the function result
     * @since 5.0.0
     */
    @Override
    @ExperimentalApi
    T apply(T input, Random random);
}