diff --git a/src/changes/changes.xml b/src/changes/changes.xml index b9930b0d2..a9d493949 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -216,6 +216,7 @@ The type attribute can be add,update,fix,remove. Add and ExceptionUtils.isChecked() and isUnchecked() #1069 Add and use ExceptionUtils.throwUnchecked(throwable). Add LockingVisitors.create(O, ReadWriteLock). + Add IntToIntFunction. Bump actions/cache from 2.1.4 to 3.0.10 #742, #752, #764, #833, #867, #959, #964. Bump actions/checkout from 2 to 3.1.0 #819, #825, #859, #963. diff --git a/src/main/java/org/apache/commons/lang3/function/IntToIntFunction.java b/src/main/java/org/apache/commons/lang3/function/IntToIntFunction.java new file mode 100644 index 000000000..45f309743 --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/function/IntToIntFunction.java @@ -0,0 +1,52 @@ +/* + * 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.commons.lang3.function; + +import java.util.function.Function; + +/** + * Represents a function that accepts an int-valued argument and produces an int-valued result. This is the {@code int}-to-{@code int} primitive specialization + * for {@link Function}. + * + *

+ * This is a functional interface whose functional method is {@link #applyAsInt(int)}. + *

+ * + * @see Function + * @since 3.13.0 + */ +@FunctionalInterface +public interface IntToIntFunction { + + /** + * Returns a function that always returns its input argument. + * + * @return a function that always returns its input argument + */ + static IntToIntFunction identity() { + return i -> i; + } + + /** + * Applies this function to the given argument. + * + * @param value the function argument + * @return the function result + */ + int applyAsInt(int value); +} diff --git a/src/test/java/org/apache/commons/lang3/function/IntToIntFunctionTest.java b/src/test/java/org/apache/commons/lang3/function/IntToIntFunctionTest.java new file mode 100644 index 000000000..d8d11ae07 --- /dev/null +++ b/src/test/java/org/apache/commons/lang3/function/IntToIntFunctionTest.java @@ -0,0 +1,40 @@ +/* + * 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.commons.lang3.function; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import org.apache.commons.lang3.AbstractLangTest; +import org.junit.jupiter.api.Test; + +/** + * Tests {@link IntToIntFunction}. + */ +public class IntToIntFunctionTest extends AbstractLangTest { + + @Test + public void testApply() { + final IntToIntFunction func = i -> i + 1; + assertEquals(66, func.applyAsInt(65)); + } + + @Test + public void testIdentity() { + assertEquals(65, IntToIntFunction.identity().applyAsInt(65)); + } +}