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    *      https://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  package org.apache.commons.lang3.stream;
18  
19  import java.util.stream.IntStream;
20  
21  /**
22   * Factory for {@link IntStream}.
23   * <p>
24   * <small> Only a factory for now but could hold other functionality.</small>
25   * </p>
26   *
27   * @since 3.13.0
28   */
29  public class IntStreams {
30  
31      /**
32       * Null-safe version of {@link IntStream#of(int[])}.
33       *
34       * @param values the elements of the new stream, may be {@code null}.
35       * @return the new stream on {@code values} or {@link IntStream#empty()}.
36       * @since 3.18.0
37       */
38      @SafeVarargs // Creating a stream from an array is safe
39      public static IntStream of(final int... values) {
40          return values == null ? IntStream.empty() : IntStream.of(values);
41      }
42  
43      /**
44       * Shorthand for {@code IntStream.range(0, i)}.
45       *
46       * @param endExclusive the exclusive upper bound.
47       * @return a sequential {@link IntStream} for the range of {@code int} elements.
48       */
49      public static IntStream range(final int endExclusive) {
50          return IntStream.range(0, endExclusive);
51      }
52  
53      /**
54       * Shorthand for {@code IntStream.rangeClosed(0, i)}.
55       *
56       * @param endInclusive the inclusive upper bound.
57       * @return a sequential {@link IntStream} for the range of {@code int} elements.
58       */
59      public static IntStream rangeClosed(final int endInclusive) {
60          return IntStream.rangeClosed(0, endInclusive);
61      }
62  
63      /**
64       * Make private in 4.0.
65       *
66       * @deprecated TODO Make private in 4.0.
67       */
68      @Deprecated
69      public IntStreams() {
70          // empty
71      }
72  }