ArrayCache (dataset 8.1.3 API)

java.lang.Object
- de.gsi.dataset.utils.ArrayCache

public final class ArrayCache
extends Object

Simple cache for large recurring primitive arrays, e.g. to be used in functions where often large temporary arrays are needed but that are otherwise outside the function scope not needed. usage example:

 private final static String UNIQUE_IDENTIFIER = "class/app unique name";
 [..]
 
 final double[] localTempBuffer = ArrayCache.getCachedDoubleArray(UNIQUE_IDENTIFIER, 200);
 
 [..] user code [..]
 
 ArrayCache.release(UNIQUE_IDENTIFIER, 100);

N.B. for other simple caching needs see @see Cache

Author:: rstein

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean[]`	`getCachedBooleanArray(String arrayName, int size)` Returns cached large recurring primitive arrays, e.g.
`static byte[]`	`getCachedByteArray(String arrayName, int size)` Returns cached large recurring primitive arrays, e.g.
`static double[]`	`getCachedDoubleArray(String arrayName, int size)` Returns cached large recurring primitive arrays, e.g.
`static float[]`	`getCachedFloatArray(String arrayName, int size)` Returns cached large recurring primitive arrays, e.g.
`static int[]`	`getCachedIntArray(String arrayName, int size)` Returns cached large recurring primitive arrays, e.g.
`static long[]`	`getCachedLongArray(String arrayName, int size)` Returns cached large recurring primitive arrays, e.g.
`static short[]`	`getCachedShortArray(String arrayName, int size)` Returns cached large recurring primitive arrays, e.g.
`static String[]`	`getCachedStringArray(String arrayName, int size)` Returns cached large recurring primitive arrays, e.g.
`static void`	`release(String arrayName, boolean[] cachedArray)` Returns ownership of array to cache
`static void`	`release(String arrayName, byte[] cachedArray)` Returns ownership of array to cache
`static void`	`release(String arrayName, double[] cachedArray)` Returns ownership of array to cache
`static void`	`release(String arrayName, float[] cachedArray)` Returns ownership of array to cache
`static void`	`release(String arrayName, int[] cachedArray)` Returns ownership of array to cache
`static void`	`release(String arrayName, long[] cachedArray)` Returns ownership of array to cache
`static void`	`release(String arrayName, short[] cachedArray)` Returns ownership of array to cache
`static void`	`release(String arrayName, String[] cachedArray)` Returns ownership of array to cache

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

- Method Detail
  - getCachedBooleanArray
```
public static boolean[] getCachedBooleanArray(String arrayName,
                                              int size)
```
    Returns cached large recurring primitive arrays, e.g. to be used in functions where often large temporary arrays are needed but that are otherwise outside the function scope not needed.
    N.B. do not forget to release/return ownership of the array via release(java.lang.String, boolean[])
    
    Parameters:
    
    arrayName - unique array name
    
    size - requested array size
    
    Returns:
    
    cached copy (N.B. removed from internal HashMap)
  - getCachedByteArray
```
public static byte[] getCachedByteArray(String arrayName,
                                        int size)
```
    Returns cached large recurring primitive arrays, e.g. to be used in functions where often large temporary arrays are needed but that are otherwise outside the function scope not needed.
    N.B. do not forget to release/return ownership of the array via release(java.lang.String, boolean[])
    
    Parameters:
    
    arrayName - unique array name
    
    size - requested array size
    
    Returns:
    
    cached copy (N.B. removed from internal HashMap)
  - getCachedDoubleArray
```
public static double[] getCachedDoubleArray(String arrayName,
                                            int size)
```
    Returns cached large recurring primitive arrays, e.g. to be used in functions where often large temporary arrays are needed but that are otherwise outside the function scope not needed.
    N.B. do not forget to release/return ownership of the array via release(java.lang.String, boolean[])
    
    Parameters:
    
    arrayName - unique array name
    
    size - requested array size
    
    Returns:
    
    cached copy (N.B. removed from internal HashMap)
  - getCachedFloatArray
```
public static float[] getCachedFloatArray(String arrayName,
                                          int size)
```
    Returns cached large recurring primitive arrays, e.g. to be used in functions where often large temporary arrays are needed but that are otherwise outside the function scope not needed.
    N.B. do not forget to release/return ownership of the array via release(java.lang.String, boolean[])
    
    Parameters:
    
    arrayName - unique array name
    
    size - requested array size
    
    Returns:
    
    cached copy (N.B. removed from internal HashMap)
  - getCachedIntArray
```
public static int[] getCachedIntArray(String arrayName,
                                      int size)
```
    Returns cached large recurring primitive arrays, e.g. to be used in functions where often large temporary arrays are needed but that are otherwise outside the function scope not needed.
    N.B. do not forget to release/return ownership of the array via release(java.lang.String, boolean[])
    
    Parameters:
    
    arrayName - unique array name
    
    size - requested array size
    
    Returns:
    
    cached copy (N.B. removed from internal HashMap)
  - getCachedLongArray
```
public static long[] getCachedLongArray(String arrayName,
                                        int size)
```
    Returns cached large recurring primitive arrays, e.g. to be used in functions where often large temporary arrays are needed but that are otherwise outside the function scope not needed.
    N.B. do not forget to release/return ownership of the array via release(java.lang.String, boolean[])
    
    Parameters:
    
    arrayName - unique array name
    
    size - requested array size
    
    Returns:
    
    cached copy (N.B. removed from internal HashMap)
  - getCachedShortArray
```
public static short[] getCachedShortArray(String arrayName,
                                          int size)
```
    Returns cached large recurring primitive arrays, e.g. to be used in functions where often large temporary arrays are needed but that are otherwise outside the function scope not needed.
    N.B. do not forget to release/return ownership of the array via release(java.lang.String, boolean[])
    
    Parameters:
    
    arrayName - unique array name
    
    size - requested array size
    
    Returns:
    
    cached copy (N.B. removed from internal HashMap)
  - getCachedStringArray
```
public static String[] getCachedStringArray(String arrayName,
                                            int size)
```
    Returns cached large recurring primitive arrays, e.g. to be used in functions where often large temporary arrays are needed but that are otherwise outside the function scope not needed.
    N.B. do not forget to release/return ownership of the array via release(java.lang.String, boolean[])
    
    Parameters:
    
    arrayName - unique array name
    
    size - requested array size
    
    Returns:
    
    cached copy (N.B. removed from internal HashMap)
  - release
```
public static void release(String arrayName,
                           boolean[] cachedArray)
```
    Returns ownership of array to cache
    
    Parameters:
    
    arrayName - unique array name
    
    cachedArray - the array to be released/return ownership to the cache
  - release
```
public static void release(String arrayName,
                           byte[] cachedArray)
```
    Returns ownership of array to cache
    
    Parameters:
    
    arrayName - unique array name
    
    cachedArray - the array to be released/return ownership to the cache
  - release
```
public static void release(String arrayName,
                           double[] cachedArray)
```
    Returns ownership of array to cache
    
    Parameters:
    
    arrayName - unique array name
    
    cachedArray - the array to be released/return ownership to the cache
  - release
```
public static void release(String arrayName,
                           float[] cachedArray)
```
    Returns ownership of array to cache
    
    Parameters:
    
    arrayName - unique array name
    
    cachedArray - the array to be released/return ownership to the cache
  - release
```
public static void release(String arrayName,
                           int[] cachedArray)
```
    Returns ownership of array to cache
    
    Parameters:
    
    arrayName - unique array name
    
    cachedArray - the array to be released/return ownership to the cache
  - release
```
public static void release(String arrayName,
                           long[] cachedArray)
```
    Returns ownership of array to cache
    
    Parameters:
    
    arrayName - unique array name
    
    cachedArray - the array to be released/return ownership to the cache
  - release
```
public static void release(String arrayName,
                           short[] cachedArray)
```
    Returns ownership of array to cache
    
    Parameters:
    
    arrayName - unique array name
    
    cachedArray - the array to be released/return ownership to the cache
  - release
```
public static void release(String arrayName,
                           String[] cachedArray)
```
    Returns ownership of array to cache
    
    Parameters:
    
    arrayName - unique array name
    
    cachedArray - the array to be released/return ownership to the cache

Class ArrayCache

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCachedBooleanArray

getCachedByteArray

getCachedDoubleArray

getCachedFloatArray

getCachedIntArray

getCachedLongArray

getCachedShortArray

getCachedStringArray

release

release

release

release

release

release

release

release