View Javadoc
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.Consumer;
21  import java.util.function.Function;
22  
23  /**
24   * Provides {@link Consumer} instances.
25   *
26   * @since 3.13.0
27   */
28  public class Consumers {
29  
30      /** NOP singleton. */
31      @SuppressWarnings("rawtypes")
32      private static final Consumer NOP = Function.identity()::apply;
33  
34      /**
35       * Gets the NOP Consumer singleton.
36       *
37       * @param <T> type type to consume.
38       * @return the NOP Consumer singleton..
39       */
40      @SuppressWarnings("unchecked")
41      public static <T> Consumer<T> nop() {
42          return NOP;
43      }
44  
45      private Consumers() {
46          // No instances.
47      }
48  
49  }