ArrayUtils (mps_java_client 1.1.0 API)

java.lang.Object
- com.mathworks.mps.client.internal.ArrayUtils

```
public class ArrayUtils
extends Object
```
Utility class with various static helper functions that deal with Java arrays and lists.

Constructor Summary

Constructors
Constructor and Description

ArrayUtils()

Constructors
Constructor and Description
`ArrayUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`coerceDimsList(List<Long> dimsListIn, int numOutputDims)` Either grow or shrink the input list, containing the dimensions of an array, to match the target size passed as the second input using the rules set by Java MATLAB Interface (JMI) for dimension coercion.
`static <T> T[]`	`convertToArray(List<?> list, Class<T> c)` Converts a list of any type into an Array of Type T
`static List<Integer>`	`convertToIntegerList(int[] src)` Converts an array of primitive int's into a List of java.lang.Integer's
`static List<Short>`	`convertToShortList(List<Integer> src)` Converts a list of java.lang.Integer into a list of java.lang.Short
`static Map<Class,Class>`	`createBoxedToUnBoxedTypeMap()` Creates a Map of JAVA boxed types to their corresponsing primitive types.
`static Class`	`getArrayElementType(Object arr)` Returns the type of an element in an array.
`static String`	`getCamelCasedClassName(Class cls)` Returns camelcased version of a class name.
`static List<Integer>`	`getDimsArray(Object obj)` Return the dimensions of an array.
`static int`	`getNumberOfDimensions(Object input)` Get number of dimensions of input object.
`static List<Integer>`	`getStrides(List<Integer> len)` Returns the numeric value of the stride required to jump across dimensions in an array e.g a {4,3,2} dimension array will have {1,4,12,24} as the strides array
`static boolean`	`isOneDimArray(Object obj)` Determines if the passed in Object is an array and of one dimension
`static Byte[]`	`toBoxedArray(byte[] src)` Coverts an array of byte into array of java.lang.Byte
`static Character[]`	`toCharacterArray(Integer[] array)` Coverts an array of java.lang.Integer into array of java.lang.Character
`static char[]`	`toCharArray(Integer[] array)` Coverts an array of java.lang.Integer into array of char
`static int[]`	`toIntArray(Long[] array)` Coverts an array of java.lang.Long into array of int
`static <T> Object`	`toPrimitiveArray(Object[] array, Class<T> c)` Generic definition of toPrimitiveArray Converts an array of boxed type to primitive type
`static Class`	`unBoxIfBoxedType(Class inClass)` Returns class of a JAVA primitive type corresponding to a JAVA boxed type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArrayUtils
```
public ArrayUtils()
```
- Method Detail
  - getArrayElementType
```
public static Class getArrayElementType(Object arr)
```
    Returns the type of an element in an array. For non-array input, returns the type of the input
    
    Parameters:
    
    arr - An array
    
    Returns:
    
    Type of element in the input array. Returns null for null input.
  - getDimsArray
```
public static List<Integer> getDimsArray(Object obj)
```
    Return the dimensions of an array. If the input array has 0 as one of the dimensions, the output contains dimensions upto the 0 including 0. The users of this function should check to see if the returned dimension List has a zero and act appropriately.
    
    Parameters:
    
    obj - An array
    
    Returns:
    
    A List containing the array dimensions
  - getStrides
```
public static List<Integer> getStrides(List<Integer> len)
```
    Returns the numeric value of the stride required to jump across dimensions in an array e.g a {4,3,2} dimension array will have {1,4,12,24} as the strides array
    
    Parameters:
    
    len - Dimension array
    
    Returns:
    
    A List containing stride values
  - isOneDimArray
```
public static boolean isOneDimArray(Object obj)
```
    Determines if the passed in Object is an array and of one dimension
    
    Parameters:
    
    obj - An array
    
    Returns:
    
    true if the input array is one dimensional else false
  - getCamelCasedClassName
```
public static String getCamelCasedClassName(Class cls)
```
    Returns camelcased version of a class name. e.g for java.lang.String, output will be JavaLangString or double will be Double.
    
    Parameters:
    
    cls - Class of the type that needs to be camelcased.
    
    Returns:
    
    Camelcased version of the class name
  - unBoxIfBoxedType
```
public static Class unBoxIfBoxedType(Class inClass)
```
    Returns class of a JAVA primitive type corresponding to a JAVA boxed type.
    
    Parameters:
    
    inClass - Class of a JAVA type
    
    Returns:
    
    JAVA primitive type for boxed types. For all other types, returns back the input
  - createBoxedToUnBoxedTypeMap
```
public static Map<Class,Class> createBoxedToUnBoxedTypeMap()
```
    Creates a Map of JAVA boxed types to their corresponsing primitive types. *
    
    Returns:
    
    Map of JAVA boxed types to their corresponsing primitive types
  - convertToIntegerList
```
public static List<Integer> convertToIntegerList(int[] src)
```
    Converts an array of primitive int's into a List of java.lang.Integer's
    
    Parameters:
    
    src - Array of primitive int's
    
    Returns:
    
    List of java.lang.Integer
  - convertToShortList
```
public static List<Short> convertToShortList(List<Integer> src)
```
    Converts a list of java.lang.Integer into a list of java.lang.Short
    
    Parameters:
    
    src - List of java.lang.Integer
    
    Returns:
    
    List of java.lang.Short
  - convertToArray
```
public static <T> T[] convertToArray(List<?> list,
                                     Class<T> c)
```
    Converts a list of any type into an Array of Type T
    
    Returns:
    
    Array of type T
  - toPrimitiveArray
```
public static <T> Object toPrimitiveArray(Object[] array,
                                          Class<T> c)
```
    Generic definition of toPrimitiveArray Converts an array of boxed type to primitive type
  - toIntArray
```
public static int[] toIntArray(Long[] array)
```
    Coverts an array of java.lang.Long into array of int
    
    Parameters:
    
    array - array of java.lang.Long
    
    Returns:
    
    array of int
  - toCharArray
```
public static char[] toCharArray(Integer[] array)
```
    Coverts an array of java.lang.Integer into array of char
    
    Parameters:
    
    array - array of java.lang.Integer
    
    Returns:
    
    array of char
  - toCharacterArray
```
public static Character[] toCharacterArray(Integer[] array)
```
    Coverts an array of java.lang.Integer into array of java.lang.Character
    
    Parameters:
    
    array - array of java.lang.Integer
    
    Returns:
    
    array of java.lang.Character
  - toBoxedArray
```
public static Byte[] toBoxedArray(byte[] src)
```
    Coverts an array of byte into array of java.lang.Byte
    
    Parameters:
    
    src - array of byte
    
    Returns:
    
    array of java.lang.Byte
  - coerceDimsList
```
public static boolean coerceDimsList(List<Long> dimsListIn,
                                     int numOutputDims)
```
    Either grow or shrink the input list, containing the dimensions of an array, to match the target size passed as the second input using the rules set by Java MATLAB Interface (JMI) for dimension coercion. Returns true if successful in changing the size of input list. Following are the dimension coercion rules for data marshaling between Java and MATLAB: 1. When Java method's return type has more number of dimensions than MATLAB's response, MATLAB's dimensions array will be padded with 1's to match the required number of output dimensions in Java. 2. When Java method's return type has fewer number of dimensions. This case is possible only when extra dimensions for MATLAB array have value of 1 only. To compute number of dimensions in Java, we will need to remove excess 1's, first from the end, then from the beginning and then from the middle of the array (scan front-to-back) until the target size is reached.
    
    Parameters:
    
    dimsListIn - Input list containing dimensions of an array
    
    numOutputDims - target size for the input list
    
    Returns:
    
    true if successful in changing the size of input list
  - getNumberOfDimensions
```
public static int getNumberOfDimensions(Object input)
```
    Get number of dimensions of input object. The input can also be an instance of java.lang.Class
    
    Parameters:
    
    input - A Java object
    
    Returns:
    
    Number of dimensions of the input object

Class ArrayUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArrayUtils

Method Detail

getArrayElementType

getDimsArray

getStrides

isOneDimArray

getCamelCasedClassName

unBoxIfBoxedType

createBoxedToUnBoxedTypeMap

convertToIntegerList

convertToShortList

convertToArray

toPrimitiveArray

toIntArray

toCharArray

toCharacterArray

toBoxedArray

coerceDimsList

getNumberOfDimensions