1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.lang3.function;
19
20 import java.util.function.Function;
21
22 /**
23 * 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
24 * for {@link Function}.
25 *
26 * <p>
27 * This is a <a href="package-summary.html">functional interface</a> whose functional method is {@link #applyAsChar(int)}.
28 * </p>
29 *
30 * @see Function
31 * @since 3.13.0
32 */
33 @FunctionalInterface
34 public interface IntToCharFunction {
35
36 /**
37 * Applies this function to the given argument.
38 *
39 * @param value the function argument.
40 * @return the function result.
41 */
42 char applyAsChar(int value);
43 }