Package com.illumon.iris.libs.primitives

Class IntegerPrimitives

java.lang.Object
com.illumon.iris.libs.primitives.IntegerPrimitives
public class IntegerPrimitives extends Object
A set of commonly used functions that can be applied to Integer types.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IntegerPrimitives()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static DbIntArray
    array(int[] values)
    Converts a primitive array to a DB array.
    static int[]
    concat(int[]... values)
    Returns the concatenation of multiple arrays into a single array.
    static int[]
    concat(DbIntArray... values)
    Returns the concatenation of multiple arrays into a single array.
    static int
    count(int[] values)
    Counts the number of non-null values.
    static int
    count(DbIntArray values)
    Counts the number of non-null values.
    static int
    count(Integer[] values)
    Counts the number of non-null values.
    static long
    countDistinct(int[] values)
    Counts the number of distinct elements in the array.
    static long
    countDistinct(int[] values, boolean countNull)
    Counts the number of distinct elements in the array.
    static long
    countDistinct(DbIntArray values)
    Counts the number of distinct elements in the array.
    static long
    countDistinct(DbIntArray values, boolean countNull)
    Counts the number of distinct elements in the array.
    static int[]
    distinct(int[] values)
    Returns an array containing only the distinct values from the input.
    static int[]
    distinct(int[] values, boolean includeNull, boolean sort)
    Returns an array containing only the distinct values from the input.
    static DbIntArray
    distinct(DbIntArray values)
    Returns an array containing only the distinct values from the input.
    static DbIntArray
    distinct(DbIntArray values, boolean includeNull, boolean sort)
    Returns an array containing only the distinct values from the input.
    static int[]
    enlist(int... values)
    Returns a list containing its arguments.
    static int
    first(int[] values)
    Returns the first value from an array.
    static int
    first(DbIntArray values)
    Returns the first value from an array.
    static int[]
    forwardFill(int[] values)
     
    static boolean
    in(int testedValues, int... possibleValues)
    Checks if a value is within a discrete set of possible values.
    static boolean
    inRange(int testedValue, int lowInclusiveValue, int highInclusiveValue)
    Checks if a value is within a range.
    static boolean
    isNull(int value)
    Determines if a value is null.
    static int
    last(int[] values)
    Returns the last value from an array.
    static int
    last(DbIntArray values)
    Returns the last value from an array.
    static int
    nth(int index, int[] values)
    Returns the nth value from an array.
    static int
    nth(int index, DbIntArray values)
    Returns the nth value from an array.
    static int[]
    nullToValue(int[] values, int defaultValue)
    Replaces null values with a default value.
    static int
    nullToValue(int value, int defaultValue)
    Replaces null values with a default value.
    static int[]
    nullToValue(DbIntArray values, int defaultValue)
    Replaces null values with a default value.
    static int[]
    repeat(int value, int size)
    Returns an array with a value repeated.
    static int[]
    reverse(int... values)
    Returns an array with the values reversed.
    static int[]
    reverse(DbIntArray values)
    Returns an array with the values reversed.
    static int[]
    unbox(Integer... values)
    Unboxes a array of values.
    static int
    uniqueValue(DbIntArray arr, boolean countNull)
    Get the single unique value in the array, or null if there are none, or there are more than 1 distinct values.
    static int[]
    vec(DbIntArray values)
    Converts a DB array to a primitive array.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • IntegerPrimitives

      public IntegerPrimitives()

  • Method Details

    • unbox

      public static int[] unbox(Integer... values)
      Unboxes a array of values.
      Parameters:
      values - values.
      Returns:
      unboxed array of values.

    • isNull

      public static boolean isNull(int value)
      Determines if a value is null.
      Parameters:
      value - value.
      Returns:
      true if the value is null, and false otherwise.

    • nullToValue

      public static int nullToValue(int value, int defaultValue)
      Replaces null values with a default value.
      Parameters:
      value - value.
      defaultValue - default value to return for null values.
      Returns:
      value, if value is not null, and defaultValue if value is null.

    • nullToValue

      public static int[] nullToValue(int[] values, int defaultValue)
      Replaces null values with a default value.
      Parameters:
      values - values.
      defaultValue - default value to return for null values.
      Returns:
      values with nulls replaced by defaultValue.

    • nullToValue

      public static int[] nullToValue(DbIntArray values, int defaultValue)
      Replaces null values with a default value.
      Parameters:
      values - values.
      defaultValue - default value to return for null values.
      Returns:
      values with nulls replaced by defaultValue.

    • count

      public static int count(Integer[] values)
      Counts the number of non-null values.
      Parameters:
      values - values.
      Returns:
      number of non-null values.

    • count

      public static int count(int[] values)
      Counts the number of non-null values.
      Parameters:
      values - values.
      Returns:
      number of non-null values.

    • count

      public static int count(DbIntArray values)
      Counts the number of non-null values.
      Parameters:
      values - values.
      Returns:
      number of non-null values.

    • last

      public static int last(DbIntArray values)
      Returns the last value from an array.
      Parameters:
      values - values.
      Returns:
      last value from the array.

    • last

      public static int last(int[] values)
      Returns the last value from an array.
      Parameters:
      values - values.
      Returns:
      last value from the array.

    • first

      public static int first(DbIntArray values)
      Returns the first value from an array.
      Parameters:
      values - values.
      Returns:
      first value from the array.

    • first

      public static int first(int[] values)
      Returns the first value from an array.
      Parameters:
      values - values.
      Returns:
      first value from the array.

    • nth

      public static int nth(int index, DbIntArray values)
      Returns the nth value from an array.
      Parameters:
      index - index of the value to return.
      values - values.
      Returns:
      nth value from the array or null, if the index is outside of the array's index range.

    • nth

      public static int nth(int index, int[] values)
      Returns the nth value from an array.
      Parameters:
      index - index of the value to return.
      values - values.
      Returns:
      nth value from the array or null, if the index is outside of the array's index range.

    • vec

      public static int[] vec(DbIntArray values)
      Converts a DB array to a primitive array.
      Parameters:
      values - DB array
      Returns:
      primitive array.

    • array

      public static DbIntArray array(int[] values)
      Converts a primitive array to a DB array.
      Parameters:
      values - primitive array
      Returns:
      DB array.

    • inRange

      public static boolean inRange(int testedValue, int lowInclusiveValue, int highInclusiveValue)
      Checks if a value is within a range.
      Parameters:
      testedValue - tested value.
      lowInclusiveValue - lower inclusive bound of the range.
      highInclusiveValue - upper inclusive bound of the range.
      Returns:
      true if the tested value is within the range, and false if the tested value is not in the range or is null.

    • in

      public static boolean in(int testedValues, int... possibleValues)
      Checks if a value is within a discrete set of possible values.
      Parameters:
      testedValues - tested value.
      possibleValues - possible values.
      Returns:
      true if the tested value is contained in the possible values, and false otherwise.

    • countDistinct

      public static long countDistinct(int[] values)
      Counts the number of distinct elements in the array.
      Parameters:
      values - values.
      Returns:
      number of distinct non-null values.

    • countDistinct

      public static long countDistinct(DbIntArray values)
      Counts the number of distinct elements in the array.
      Parameters:
      values - values.
      Returns:
      number of distinct non-null values.

    • countDistinct

      public static long countDistinct(int[] values, boolean countNull)
      Counts the number of distinct elements in the array.
      Parameters:
      values - values.
      countNull - true to count null values, and false to exclude null values.
      Returns:
      number of distinct values.

    • countDistinct

      public static long countDistinct(DbIntArray values, boolean countNull)
      Counts the number of distinct elements in the array.
      Parameters:
      values - values.
      countNull - true to count null values, and false to exclude null values.
      Returns:
      number of distinct values.

    • uniqueValue

      public static int uniqueValue(DbIntArray arr, boolean countNull)
      Get the single unique value in the array, or null if there are none, or there are more than 1 distinct values.
      Parameters:
      arr - the array
      countNull - if nulls should count as values
      Returns:
      the single unique value in the array, or null.

    • distinct

      public static int[] distinct(int[] values)
      Returns an array containing only the distinct values from the input.
      Parameters:
      values - values.
      Returns:
      unsorted array containing only distinct non-null items from arr.

    • distinct

      public static DbIntArray distinct(DbIntArray values)
      Returns an array containing only the distinct values from the input.
      Parameters:
      values - values.
      Returns:
      unsorted array containing only distinct non-null items from arr.

    • distinct

      public static int[] distinct(int[] values, boolean includeNull, boolean sort)
      Returns an array containing only the distinct values from the input.
      Parameters:
      values - values.
      includeNull - true to include null values, and false to exclude null values.
      sort - true to sort the resultant array
      Returns:
      array containing only distinct items from arr.

    • distinct

      public static DbIntArray distinct(DbIntArray values, boolean includeNull, boolean sort)
      Returns an array containing only the distinct values from the input.
      Parameters:
      values - values.
      includeNull - true to include null values, and false to exclude null values.
      sort - true to sort the resultant array
      Returns:
      array containing only distinct items from arr.

    • repeat

      public static int[] repeat(int value, int size)
      Returns an array with a value repeated.
      Parameters:
      value - value.
      size - number of times to repeat the value.
      Returns:
      array of repeated values. If size is less than zero, an empty array is returned.

    • enlist

      public static int[] enlist(int... values)
      Returns a list containing its arguments.
      Parameters:
      values - values.
      Returns:
      list containing values.

    • concat

      public static int[] concat(int[]... values)
      Returns the concatenation of multiple arrays into a single array.
      Parameters:
      values - values.
      Returns:
      concatenation of multiple arrays into a single array.

    • concat

      public static int[] concat(DbIntArray... values)
      Returns the concatenation of multiple arrays into a single array.
      Parameters:
      values - values.
      Returns:
      concatenation of multiple arrays into a single array.

    • reverse

      public static int[] reverse(int... values)
      Returns an array with the values reversed.
      Parameters:
      values - values.
      Returns:
      array with the values reversed.

    • reverse

      public static int[] reverse(DbIntArray values)
      Returns an array with the values reversed.
      Parameters:
      values - values.
      Returns:
      array with the values reversed.

    • forwardFill

      public static int[] forwardFill(int[] values)