Utils

java.lang.Object
- eve.util.Utils

```
public class Utils
extends Object
```

Constructor Summary

Constructors
Constructor and Description

Utils()

Constructors
Constructor and Description
`Utils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Object`	`appendArray(Object original, Object toAppend)` Join two arrays together to form a new array which contains the elements of the first followed by the elements of the second.
`static boolean`	`canIterate(Object dataSource)` Returns if the object can be used to provide an Iterator or Enumeration.
`static int`	`compare(Object one, Object two)` This attempts to compare two objects which may or may not implement the Comparable interface.
`static String`	`decodeJavaUtf8String(byte[] bytes, int start, int length)` Decode a String encoded as Java Utf8 bytes.
`static char[]`	`decodeJavaUtf8String(byte[] data, int start, int numberOfBytes, char[] buffer, int offset)` Convert a Java Utf8 byte encoded string into a string of characters.
`static int`	`encodeJavaUtf8String(char[] toEncode, int offset, int length, byte[] destination, int destOffset)` Encode a String of characters a Java Utf8 encoded bytes.
`static byte[]`	`encodeJavaUtf8String(String str)` Encodes a String as Java Utf8 bytes.
`static Object`	`getCopy(Object toCopy)` This attempts to get a copy of an object.
`static void`	`getIntSequence(int[] sequence, int first)` This fills the int array with an increasing sequence of integers starting with first.
`static void`	`getIntSequence(int[] sequence, int destOffset, int first, int step, int length)` This puts a sequence of integers into a int array.
`static int`	`indexOf(Object array, long lookingFor, int minIndex, int maxIndex, boolean backwards)` Find the index of a value within an array.
`static int`	`makeHashCode(byte[] data, int start, int length)` Creates a hashCode from a sequence of bytes.
`static int`	`makeHashCode(char[] data, int start, int length)` Creates a hashCode from a sequence of chars.
`static void`	`primitiveArrayFromString(Object obj, String data)` Decode an array of primitive values, encoded as a String.
`static String`	`primitiveArrayToString(Object obj)` Encode the array of primitive Java values as a String.
`static void`	`putAll(Map src, Map dest)` Put all items from src into dest using the same keys.
`static int`	`readInt(byte[] source, int offset, int numBytes)` This reads an integer value from a byte array with the specified number of bytes.
`static long`	`readLong(byte[] source, int offset)` This reads a long value from a byte array as an 8 byte sequence - high byte first.
`static void`	`reorder(Object[] values, int[] newIndexes)` Reorder the items in values to match the indexes in newIndexes.
`static void`	`reverse(int[] data, int offset, int length)`
`static int`	`sizeofJavaUtf8String(byte[] data, int start, int numberOfBytes)` Returns the number of characters needed to store a string which has been encoded in the Java UTF8 format.
`static int`	`sizeofJavaUtf8String(char[] toEncode, int start, int length)` Returns the number of bytes needed to encode a String in the Java UTF8 format.
`static boolean`	`sort(Handle h, int[] what, int length, CompareInts comparer, boolean descending)` This sorts the array in place.
`static boolean`	`sort(Handle h, Object[] values, Comparer comparer, boolean descending)` This sorts the objects in place.
`static void`	`sort(Handle h, Vector v, Comparer comparer, boolean descending)`
`static void`	`sort(int[] what, int length, CompareInts comparer, boolean descending)` This sorts the array in place.
`static void`	`sort(Object[] values, Comparer comparer, boolean descending)` This sorts the objects in place.
`static void`	`sort(Vector v, boolean descending)`
`static int[]`	`sortIndexes(Handle h, Object[] values, Comparer comparer, boolean descending)` This method sorts the indexes of the values array and returns the indexes as a new array of ints.
`static void`	`textDecode(Encodable obj, String data)` Encode the fields of the Encodable object.
`static String`	`textEncode(Encodable obj)` Encode the fields of the Encodable object.
`static ByteArray`	`toBytes(int[] src, int offset, int length, ByteArray dest)` Convert a sequence of ints to a sequence of bytes where each integer is represented as a sequence of 4 bytes - high order byte first.
`static Enumeration`	`toEnumeration(Object dataSource)` This provides an Enumeration of items provided in dataSource, which may itself be a Vector, Iterator, or an Enumeration itself.
`static IntArray`	`toInts(byte[] src, int offset, int length, IntArray dest)` Convert a sequence of bytes to a sequence of ints where each integer is represented as a sequence of 4 bytes - high order byte first.
`static Iterator`	`toIterator(Object dataSource)` This provides an Iterator of items provided in dataSource, which may itself be a java.util.Vector, java.util.Iterator, java.util.Enumeration or an eve.util.Iterator itself.
`static void`	`writeInt(int val, byte[] dest, int offset, int numBytes)` This writes an integer value to a byte array with the specified number of bytes.
`static void`	`writeLong(long value, byte[] dest, int offset)` This writes a long value to a byte array as an 8 byte sequence - high byte first.
`static void`	`zeroArrayRegion(Object array, int offset, int length)`

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

- Constructor Detail
  - Utils
```
public Utils()
```
- Method Detail
  - compare
```
public static int compare(Object one,
                          Object two)
```
    This attempts to compare two objects which may or may not implement the Comparable interface. If they do, then it is used, otherwise the equals method is used.
    
    Parameters:
    
    one - The first object.
    
    two - The second object
    
    Returns:
    
    less than 1 if one is considered less than two, greater than 1 if one is considered greater than two, 0 if they are considered equal.
  - getCopy
```
public static Object getCopy(Object toCopy)
```
    This attempts to get a copy of an object. If the object implements Copyable then a copy of that object is returned, otherwise the object itself is returned.
    
    Parameters:
    
    toCopy - The object to copy.
  - zeroArrayRegion
```
public static void zeroArrayRegion(Object array,
                                   int offset,
                                   int length)
```
  - makeHashCode
```
public static int makeHashCode(byte[] data,
                               int start,
                               int length)
```
    Creates a hashCode from a sequence of bytes.
  - makeHashCode
```
public static int makeHashCode(char[] data,
                               int start,
                               int length)
```
    Creates a hashCode from a sequence of chars.
  - decodeJavaUtf8String
```
public static final char[] decodeJavaUtf8String(byte[] data,
                                                int start,
                                                int numberOfBytes,
                                                char[] buffer,
                                                int offset)
```
    Convert a Java Utf8 byte encoded string into a string of characters.
    
    Parameters:
    
    data - The encoded data bytes.
    
    start - The start index of the data bytes.
    
    numberOfBytes - The number of bytes of encoded data.
    
    chars - The destination array.
    
    offset - The start index of the destination to place the characters.
    
    Returns:
    
    The destination array.
  - encodeJavaUtf8String
```
public static int encodeJavaUtf8String(char[] toEncode,
                                       int offset,
                                       int length,
                                       byte[] destination,
                                       int destOffset)
```
    Encode a String of characters a Java Utf8 encoded bytes.
    
    Parameters:
    
    toEncode - The characters to encode.
    
    offset - The start index of the character.
    
    length - The number of characters to encode.
    
    destination - The destination for the bytes.
    
    destOffset - The offset for the destination bytes
    
    Returns:
    
    the number of bytes used to encode the String.
  - encodeJavaUtf8String
```
public static byte[] encodeJavaUtf8String(String str)
```
    Encodes a String as Java Utf8 bytes.
    
    Parameters:
    
    str - the String to encode.
    
    Returns:
    
    the encoded bytes.
  - sizeofJavaUtf8String
```
public static final int sizeofJavaUtf8String(byte[] data,
                                             int start,
                                             int numberOfBytes)
```
    Returns the number of characters needed to store a string which has been encoded in the Java UTF8 format.
    
    Parameters:
    
    data - the encoded data.
    
    start - the start location in the data.
    
    numberOfBytes - the number of bytes of encoded data.
    
    Returns:
    
    the number of characters for the String.
  - sizeofJavaUtf8String
```
public static final int sizeofJavaUtf8String(char[] toEncode,
                                             int start,
                                             int length)
```
    Returns the number of bytes needed to encode a String in the Java UTF8 format.
    
    Parameters:
    
    toEncode - The characters to encode.
    
    start - The start index of the character.
    
    length - The number of characters to encode.
    
    Returns:
    
    the number of bytes needed to encode a String in the Java UTF8 format.
  - decodeJavaUtf8String
```
public static String decodeJavaUtf8String(byte[] bytes,
                                          int start,
                                          int length)
```
    Decode a String encoded as Java Utf8 bytes.
    
    Parameters:
    
    bytes - The encoded bytes.
    
    start - The start index of the encoded bytes.
    
    length - The number of encoded bytes.
    
    Returns:
    
    The decoded String.
  - writeInt
```
public static final void writeInt(int val,
                                  byte[] dest,
                                  int offset,
                                  int numBytes)
```
    This writes an integer value to a byte array with the specified number of bytes. It always writes out the high byte first.
    
    Parameters:
    
    val - The byte, short or integer value to write.
    
    dest - The destination array.
    
    offset - The location in the destination to write to.
    
    numBytes - The number of bytes 1, 2 or 4 to write out.
  - readInt
```
public static final int readInt(byte[] source,
                                int offset,
                                int numBytes)
```
    This reads an integer value from a byte array with the specified number of bytes. It always reads in the high byte first.
    
    Parameters:
    
    source - The source of the bytes.
    
    offset - The location in the source.
    
    numBytes - The number of bytes 1, 2 or 4 to read in.
    
    Returns:
    
    the integer value read in.
  - readLong
```
public static final long readLong(byte[] source,
                                  int offset)
```
    This reads a long value from a byte array as an 8 byte sequence - high byte first.
    
    Parameters:
    
    source - The source of the bytes.
    
    offset - The location in the source.
    
    Returns:
    
    The long value read in.
  - writeLong
```
public static final void writeLong(long value,
                                   byte[] dest,
                                   int offset)
```
    This writes a long value to a byte array as an 8 byte sequence - high byte first.
    
    Parameters:
    
    value - The long value to write.
    
    dest - The destination for the bytes.
    
    offset - The location in the destination to write to.
  - getIntSequence
```
public static void getIntSequence(int[] sequence,
                                  int destOffset,
                                  int first,
                                  int step,
                                  int length)
```
    This puts a sequence of integers into a int array.
    
    Parameters:
    
    sequence - The destination for the integers.
    
    destOffset - The index in the destination to start placing the values.
    
    first - The first value.
    
    step - The value to add to each value to get the next value.
    
    length - The number of values to place.
  - getIntSequence
```
public static void getIntSequence(int[] sequence,
                                  int first)
```
    This fills the int array with an increasing sequence of integers starting with first. This calls: getIntSequence(sequence,0,first,1,sequence.length);
  - canIterate
```
public static boolean canIterate(Object dataSource)
```
    Returns if the object can be used to provide an Iterator or Enumeration. The criteria for this is if dataSource is a Vector or Enumeration or Iterator.
    
    Parameters:
    
    dataSource - the data source to check.
    
    Returns:
    
    true if the dataSource can be converted to an Iterator or Enumeration.
  - toEnumeration
```
public static Enumeration toEnumeration(Object dataSource)
```
    This provides an Enumeration of items provided in dataSource, which may itself be a Vector, Iterator, or an Enumeration itself. If it is not any of these, a Enumeration will be returned which enumerates through zero elements.
    
    Parameters:
    
    dataSource - the data source to convert.
    
    Returns:
    
    an Enumeration for the dataSource.
  - toIterator
```
public static Iterator toIterator(Object dataSource)
```
    This provides an Iterator of items provided in dataSource, which may itself be a java.util.Vector, java.util.Iterator, java.util.Enumeration or an eve.util.Iterator itself.
  - appendArray
```
public static Object appendArray(Object original,
                                 Object toAppend)
```
    Join two arrays together to form a new array which contains the elements of the first followed by the elements of the second.
    
    Parameters:
    
    original - The first array. Can be null, in which case only the elements of toAdd will go into the new array.
    
    toAppend - The second array. Can be null, in which case only the elements of original will go into the new array.
    
    Returns:
    
    a new array representing original + toAppend. If both original and toAppend are null, this will return null.
  - primitiveArrayToString
```
public static String primitiveArrayToString(Object obj)
```
    Encode the array of primitive Java values as a String. The length of the array is not encoded along with this data, nor is the type of the data. You will have to store these yourself.
    See the TextEncoder/TextDecoder objects for how to do this.
    
    Parameters:
    
    obj - An array of any Java type except Object or array.
    
    Returns:
    
    The String encoded data.
  - primitiveArrayFromString
```
public static void primitiveArrayFromString(Object obj,
                                            String data)
```
    Decode an array of primitive values, encoded as a String.
    
    Parameters:
    
    obj - The array of the correct type and length.
    
    data - The encoded data.
  - textEncode
```
public static String textEncode(Encodable obj)
```
    Encode the fields of the Encodable object.
    
    Parameters:
    
    obj - The object to encode.
    
    Returns:
    
    A simple encoded string for the object.
  - textDecode
```
public static void textDecode(Encodable obj,
                              String data)
```
    Encode the fields of the Encodable object.
    
    Parameters:
    
    obj - The object to encode.
  - indexOf
```
public static int indexOf(Object array,
                          long lookingFor,
                          int minIndex,
                          int maxIndex,
                          boolean backwards)
```
    Find the index of a value within an array. The value should be converted to an appropriate integer/long value and passed to the method. The type of the array will determine the how the lookingFor value will be used.
    Searching begins from the startIndex and will continue either forwards or backwards as specified. A return value of -1 indicates that the value was not found.
  - toBytes
```
public static ByteArray toBytes(int[] src,
                                int offset,
                                int length,
                                ByteArray dest)
```
    Convert a sequence of ints to a sequence of bytes where each integer is represented as a sequence of 4 bytes - high order byte first. The bytes are appended to a ByteArray.
    
    Parameters:
    
    src - the source of the int values.
    
    offset - the start of the int values.
    
    length - the number of int values.
    
    dest - an optional destination ByteArray. If it is null a new one is allocated and returned.
    
    Returns:
    
    the destination ByteArray or a new one if the destination is null.
  - toInts
```
public static IntArray toInts(byte[] src,
                              int offset,
                              int length,
                              IntArray dest)
```
    Convert a sequence of bytes to a sequence of ints where each integer is represented as a sequence of 4 bytes - high order byte first. The ints are appended to an IntArray.
    
    Parameters:
    
    src - the source of the bytes values.
    
    offset - the start of the byte values.
    
    length - the number of byte values.
    
    dest - an optional destination IntArray. If it is null a new one is allocated and returned.
    
    Returns:
    
    the destination IntArray or a new one if the destination is null.
  - reverse
```
public static void reverse(int[] data,
                           int offset,
                           int length)
```
  - putAll
```
public static void putAll(Map src,
                          Map dest)
```
    Put all items from src into dest using the same keys.
    
    Parameters:
    
    src - a source Map which may be null, in which case nothing is copied.
    
    dest - a non-null destination Map.
  - sort
```
public static boolean sort(Handle h,
                           int[] what,
                           int length,
                           CompareInts comparer,
                           boolean descending)
```
    This sorts the array in place. If the handle is not null then the sort will yield occasionally to let other threads operate. The handle will be updated to show the progress but the handle Handle.Stopped bit will never be set. If this returns false this indicates that stop() was called on the handle.
  - sortIndexes
```
public static int[] sortIndexes(Handle h,
                                Object[] values,
                                Comparer comparer,
                                boolean descending)
```
    This method sorts the indexes of the values array and returns the indexes as a new array of ints. It does not modify the values array.
    
    Parameters:
    
    h - a handle that can be used to monitor and stop the sorting.
    
    values - the values to compare.
    
    comparer - a Comparer to compare the Objects in values. If this is null a StandardComparer is used.
    
    descending - set true to sort in descending order.
    
    Returns:
    
    an int[] on success, or null if the handle was stopped.
  - sort
```
public static boolean sort(Handle h,
                           Object[] values,
                           Comparer comparer,
                           boolean descending)
```
    This sorts the objects in place. If the handle is not null then the sort will yield occasionally to let other threads operate. The handle will be updated to show the progress but the handle Handle.Stopped bit will never be set.
  - sort
```
public static void sort(int[] what,
                        int length,
                        CompareInts comparer,
                        boolean descending)
```
    This sorts the array in place.
  - sort
```
public static void sort(Object[] values,
                        Comparer comparer,
                        boolean descending)
```
    This sorts the objects in place.
  - sort
```
public static void sort(Handle h,
                        Vector v,
                        Comparer comparer,
                        boolean descending)
```
  - sort
```
public static void sort(Vector v,
                        boolean descending)
```
  - reorder
```
public static void reorder(Object[] values,
                           int[] newIndexes)
```
    Reorder the items in values to match the indexes in newIndexes.
    
    Parameters:
    
    values -
    
    newIndexes -

Class Utils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Utils

Method Detail

compare

getCopy

zeroArrayRegion

makeHashCode

makeHashCode

decodeJavaUtf8String

encodeJavaUtf8String

encodeJavaUtf8String

sizeofJavaUtf8String

sizeofJavaUtf8String

decodeJavaUtf8String

writeInt

readInt

readLong

writeLong

getIntSequence

getIntSequence

canIterate

toEnumeration

toIterator

appendArray

primitiveArrayToString

primitiveArrayFromString

textEncode

textDecode

indexOf

toBytes

toInts

reverse

putAll

sort

sortIndexes

sort

sort

sort

sort

sort

reorder