Package com.illumon.iris.libs.primitives

Class CharacterPrimitives

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

  • Constructor Summary

    Constructors 
    Constructor Description
    CharacterPrimitives()  

  • Method Summary

    Modifier and Type Method Description
    static DbCharArray array​(char[] values)
    Converts a primitive array to a DB array.
    static char[] concat​(char[]... values)
    Returns the concatenation of multiple arrays into a single array.
    static char[] concat​(DbCharArray... values)
    Returns the concatenation of multiple arrays into a single array.
    static int count​(char[] values)
    Counts the number of non-null values.
    static int count​(DbCharArray values)
    Counts the number of non-null values.
    static int count​(Character[] values)
    Counts the number of non-null values.
    static long countDistinct​(char[] values)
    Counts the number of distinct elements in the array.
    static long countDistinct​(char[] values, boolean countNull)
    Counts the number of distinct elements in the array.
    static long countDistinct​(DbCharArray values)
    Counts the number of distinct elements in the array.
    static long countDistinct​(DbCharArray values, boolean countNull)
    Counts the number of distinct elements in the array.
    static char[] distinct​(char[] values)
    Returns an array containing only the distinct values from the input.
    static char[] distinct​(char[] values, boolean includeNull, boolean sort)
    Returns an array containing only the distinct values from the input.
    static DbCharArray distinct​(DbCharArray values)
    Returns an array containing only the distinct values from the input.
    static DbCharArray distinct​(DbCharArray values, boolean includeNull, boolean sort)
    Returns an array containing only the distinct values from the input.
    static char[] enlist​(char... values)
    Returns a list containing its arguments.
    static char first​(char[] values)
    Returns the first value from an array.
    static char first​(DbCharArray values)
    Returns the first value from an array.
    static char[] forwardFill​(char[] values)  
    static boolean in​(char testedValues, char... possibleValues)
    Checks if a value is within a discrete set of possible values.
    static boolean inRange​(char testedValue, char lowInclusiveValue, char highInclusiveValue)
    Checks if a value is within a range.
    static boolean isNull​(char value)
    Determines if a value is null.
    static char last​(char[] values)
    Returns the last value from an array.
    static char last​(DbCharArray values)
    Returns the last value from an array.
    static char nth​(int index, char[] values)
    Returns the nth value from an array.
    static char nth​(int index, DbCharArray values)
    Returns the nth value from an array.
    static char[] nullToValue​(char[] values, char defaultValue)
    Replaces null values with a default value.
    static char nullToValue​(char value, char defaultValue)
    Replaces null values with a default value.
    static char[] nullToValue​(DbCharArray values, char defaultValue)
    Replaces null values with a default value.
    static char[] repeat​(char value, int size)
    Returns an array with a value repeated.
    static char[] reverse​(char... values)
    Returns an array with the values reversed.
    static char[] reverse​(DbCharArray values)
    Returns an array with the values reversed.
    static char[] unbox​(Character... values)
    Unboxes a array of values.
    static char uniqueValue​(DbCharArray 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 char[] vec​(DbCharArray 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

  • Method Details

    • unbox

      public static char[] unbox​(Character... values)
      Unboxes a array of values.
      Parameters:
      values - values.
      Returns:
      unboxed array of values.

    • isNull

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

    • nullToValue

      public static char nullToValue​(char value, char 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 char[] nullToValue​(char[] values, char 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 char[] nullToValue​(DbCharArray values, char 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​(Character[] values)
      Counts the number of non-null values.
      Parameters:
      values - values.
      Returns:
      number of non-null values.

    • count

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

    • count

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

    • last

      public static char last​(DbCharArray values)
      Returns the last value from an array.
      Parameters:
      values - values.
      Returns:
      last value from the array.

    • last

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

    • first

      public static char first​(DbCharArray values)
      Returns the first value from an array.
      Parameters:
      values - values.
      Returns:
      first value from the array.

    • first

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

    • nth

      public static char nth​(int index, DbCharArray 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 char nth​(int index, char[] 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 char[] vec​(DbCharArray values)
      Converts a DB array to a primitive array.
      Parameters:
      values - DB array
      Returns:
      primitive array.

    • array

      public static DbCharArray array​(char[] values)
      Converts a primitive array to a DB array.
      Parameters:
      values - primitive array
      Returns:
      DB array.

    • inRange

      public static boolean inRange​(char testedValue, char lowInclusiveValue, char 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​(char testedValues, char... 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​(char[] 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​(DbCharArray 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​(char[] 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​(DbCharArray 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 char uniqueValue​(DbCharArray 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 char[] distinct​(char[] 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 DbCharArray distinct​(DbCharArray 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 char[] distinct​(char[] 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 DbCharArray distinct​(DbCharArray 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 char[] repeat​(char 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 char[] enlist​(char... values)
      Returns a list containing its arguments.
      Parameters:
      values - values.
      Returns:
      list containing values.

    • concat

      public static char[] concat​(char[]... 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 char[] concat​(DbCharArray... 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 char[] reverse​(char... values)
      Returns an array with the values reversed.
      Parameters:
      values - values.
      Returns:
      array with the values reversed.

    • reverse

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

    • forwardFill

      public static char[] forwardFill​(char[] values)