IntStreams.java

  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. import java.util.stream.IntStream;

  19. /**
  20.  * Factory for {@link IntStream}.
  21.  * <p>
  22.  * <small> Only a factory for now but could hold other functionality.</small>
  23.  * </p>
  24.  *
  25.  * @since 3.13.0
  26.  */
  27. public class IntStreams {

  28.     /**
  29.      * Null-safe version of {@link IntStream#of(int[])}.
  30.      *
  31.      * @param values the elements of the new stream, may be {@code null}.
  32.      * @return the new stream on {@code values} or {@link IntStream#empty()}.
  33.      * @since 3.18.0
  34.      */
  35.     @SafeVarargs // Creating a stream from an array is safe
  36.     public static IntStream of(final int... values) {
  37.         return values == null ? IntStream.empty() : IntStream.of(values);
  38.     }

  39.     /**
  40.      * Shorthand for {@code IntStream.range(0, i)}.
  41.      *
  42.      * @param endExclusive the exclusive upper bound.
  43.      * @return a sequential {@link IntStream} for the range of {@code int} elements.
  44.      */
  45.     public static IntStream range(final int endExclusive) {
  46.         return IntStream.range(0, endExclusive);
  47.     }

  48.     /**
  49.      * Shorthand for {@code IntStream.rangeClosed(0, i)}.
  50.      *
  51.      * @param endInclusive the inclusive upper bound.
  52.      * @return a sequential {@link IntStream} for the range of {@code int} elements.
  53.      */
  54.     public static IntStream rangeClosed(final int endInclusive) {
  55.         return IntStream.rangeClosed(0, endInclusive);
  56.     }

  57.     /**
  58.      * Make private in 4.0.
  59.      *
  60.      * @deprecated TODO Make private in 4.0.
  61.      */
  62.     @Deprecated
  63.     public IntStreams() {
  64.         // empty
  65.     }
  66. }