001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.lang3.function;
019
020import java.util.function.Function;
021
022/**
023 * Represents a function that accepts an int-valued argument and produces a char-valued result. This is the {@code int}-to-{@code char} primitive specialization
024 * for {@link Function}.
025 *
026 * <p>
027 * This is a <a href="package-summary.html">functional interface</a> whose functional method is {@link #applyAsChar(int)}.
028 * </p>
029 *
030 * @see Function
031 * @since 3.13.0
032 */
033@FunctionalInterface
034public interface IntToCharFunction {
035
036    /**
037     * Applies this function to the given argument.
038     *
039     * @param value the function argument.
040     * @return the function result.
041     */
042    char applyAsChar(int value);
043}