This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
The following commit(s) were added to refs/heads/master by this push:
new be5ff9f Add BooleanConsumer.
be5ff9f is described below
commit be5ff9f9c1dad2067cd6971931d7361f928cd23e
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Mon Aug 23 10:51:10 2021 -0400
Add BooleanConsumer.
---
src/changes/changes.xml | 1 +
.../commons/lang3/function/BooleanConsumer.java | 68 ++++++++++++++++++++++
.../lang3/function/BooleanConsumerTest.java | 61 +++++++++++++++++++
3 files changed, 130 insertions(+)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 917a620..516e155 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -67,6 +67,7 @@ The <action> type attribute can be add,update,fix,remove.
<action type="add" dev="ggregory" due-to="Gary
Gregory">Add and use ThreadUtils.sleepQuietly(long).</action>
<action type="add" dev="ggregory" due-to="Gary
Gregory">Add and use ArrayUtils.setAll(T[], IntFunction).</action>
<action type="add" dev="ggregory" due-to="Gary
Gregory">Add and use ArrayUtils.setAll(T[], Supplier).</action>
+ <action type="add" dev="ggregory" due-to="Gary
Gregory">Add BooleanConsumer.</action>
<!-- UPDATE -->
<action type="update" dev="ggregory" due-to="Dependabot,
Gary Gregory">Bump spotbugs-maven-plugin from 4.2.0 to 4.2.3 #735.</action>
<action type="update" dev="ggregory" due-to="Dependabot,
XenoAmess">Bump Bump actions/cache from v2.1.4 to v2.1.6 #742, #752,
#764.</action>
diff --git
a/src/main/java/org/apache/commons/lang3/function/BooleanConsumer.java
b/src/main/java/org/apache/commons/lang3/function/BooleanConsumer.java
new file mode 100644
index 0000000..ad4421e
--- /dev/null
+++ b/src/main/java/org/apache/commons/lang3/function/BooleanConsumer.java
@@ -0,0 +1,68 @@
+/*
+ * 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.Objects;
+import java.util.function.IntConsumer;
+
+/**
+ * A functional interface like {@link IntConsumer} but for {@code boolean}.
+ *
+ * @see IntConsumer
+ * @since 3.13.0
+ */
+@FunctionalInterface
+public interface BooleanConsumer {
+
+ /** NOP singleton */
+ BooleanConsumer NOP = t -> {/* NOP */};
+
+ /**
+ * Returns The NOP singleton.
+ *
+ * @return The NOP singleton.
+ */
+ static BooleanConsumer nop() {
+ return NOP;
+ }
+
+ /**
+ * Performs this operation on the given argument.
+ *
+ * @param value the input argument
+ */
+ void accept(boolean value);
+
+ /**
+ * Returns a composed {@code BooleanConsumer} that performs, in sequence,
this operation followed by the {@code after}
+ * operation. If performing either operation throws an exception, it is
relayed to the caller of the composed operation.
+ * If performing this operation throws an exception, the {@code after}
operation will not be performed.
+ *
+ * @param after the operation to perform after this operation
+ * @return a composed {@code BooleanConsumer} that performs in sequence
this operation followed by the {@code after}
+ * operation
+ * @throws NullPointerException if {@code after} is null
+ */
+ default BooleanConsumer andThen(final BooleanConsumer after) {
+ Objects.requireNonNull(after);
+ return (final boolean t) -> {
+ accept(t);
+ after.accept(t);
+ };
+ }
+}
diff --git
a/src/test/java/org/apache/commons/lang3/function/BooleanConsumerTest.java
b/src/test/java/org/apache/commons/lang3/function/BooleanConsumerTest.java
new file mode 100644
index 0000000..e86b7e0
--- /dev/null
+++ b/src/test/java/org/apache/commons/lang3/function/BooleanConsumerTest.java
@@ -0,0 +1,61 @@
+/*
+ * 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.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.util.concurrent.atomic.AtomicBoolean;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * Tests {@link BooleanConsumer}.
+ */
+public class BooleanConsumerTest {
+
+ private BooleanConsumer accept(final BooleanConsumer consumer, final
boolean expected) {
+ consumer.accept(expected);
+ return consumer;
+ }
+
+ @Test
+ public void testAccept() {
+ final AtomicBoolean aBool = new AtomicBoolean();
+ accept(aBool::lazySet, true);
+ assertTrue(aBool.get());
+ accept(aBool::lazySet, false);
+ assertFalse(aBool.get());
+ }
+
+ @Test
+ public void testAndThen() throws Throwable {
+ final BooleanConsumer nop = BooleanConsumer.nop();
+ nop.andThen(nop);
+ // Documented in Javadoc edge-case.
+ assertThrows(NullPointerException.class, () -> nop.andThen(null));
+ //
+ final AtomicBoolean aBool1 = new AtomicBoolean();
+ final AtomicBoolean aBool2 = new AtomicBoolean();
+ accept(aBool1::lazySet, true).andThen(aBool2::lazySet);
+ accept(aBool1::lazySet, true);
+ accept(aBool2::lazySet, true);
+ }
+
+}
