org.apache.kafka.streams.internals.ApiUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kafka-streams Show documentation
There is a newer version: 3.9.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.kafka.streams.internals;

import org.apache.kafka.streams.kstream.ValueTransformerSupplier;

import java.time.Duration;
import java.time.Instant;
import java.util.function.Supplier;

import static java.lang.String.format;

public final class ApiUtils {

    private static final String MILLISECOND_VALIDATION_FAIL_MSG_FRMT = "Invalid value for parameter \"%s\" (value was: %s). ";
    private static final String VALIDATE_MILLISECOND_NULL_SUFFIX = "It shouldn't be null.";
    private static final String VALIDATE_MILLISECOND_OVERFLOW_SUFFIX = "It can't be converted to milliseconds.";

    private ApiUtils() {
    }

    /**
     * Validates that milliseconds from {@code duration} can be retrieved.
     * @param duration Duration to check.
     * @param messagePrefix Prefix text for an error message.
     * @return Milliseconds from {@code duration}.
     */
    public static long validateMillisecondDuration(final Duration duration, final String messagePrefix) {
        try {
            if (duration == null) {
                throw new IllegalArgumentException(messagePrefix + VALIDATE_MILLISECOND_NULL_SUFFIX);
            }

            return duration.toMillis();
        } catch (final ArithmeticException e) {
            throw new IllegalArgumentException(messagePrefix + VALIDATE_MILLISECOND_OVERFLOW_SUFFIX, e);
        }
    }

    /**
     * Validates that milliseconds from {@code instant} can be retrieved.
     * @param instant Instant to check.
     * @param messagePrefix Prefix text for an error message.
     * @return Milliseconds from {@code instant}.
     */
    public static long validateMillisecondInstant(final Instant instant, final String messagePrefix) {
        try {
            if (instant == null) {
                throw new IllegalArgumentException(messagePrefix + VALIDATE_MILLISECOND_NULL_SUFFIX);
            }

            return instant.toEpochMilli();
        } catch (final ArithmeticException e) {
            throw new IllegalArgumentException(messagePrefix + VALIDATE_MILLISECOND_OVERFLOW_SUFFIX, e);
        }
    }

    /**
     * Generates the prefix message for validateMillisecondXXXXXX() utility
     * @param value Object to be converted to milliseconds
     * @param name Object name
     * @return Error message prefix to use in exception
     */
    public static String prepareMillisCheckFailMsgPrefix(final Object value, final String name) {
        return format(MILLISECOND_VALIDATION_FAIL_MSG_FRMT, name, value);
    }

    /**
     * @throws IllegalArgumentException if the same instance is obtained each time
     */
    public static void checkSupplier(final Supplier supplier) {
        if (supplier.get() == supplier.get()) {
            final String supplierClass = supplier.getClass().getName();
            throw new IllegalArgumentException(String.format("%s generates single reference." +
                    " %s#get() must return a new object each time it is called.", supplierClass, supplierClass));
        }
    }

    /**
     * @throws IllegalArgumentException if the same instance is obtained each time
     */
    public static  void checkSupplier(final ValueTransformerSupplier supplier) {
        if (supplier.get() == supplier.get()) {
            final String supplierClass = supplier.getClass().getName();
            throw new IllegalArgumentException(String.format("%s generates single reference." +
                    " %s#get() must return a new object each time it is called.", supplierClass, supplierClass));
        }
    }
}