org.apache.datasketches.memory

Class Util

java.lang.Object

org.apache.datasketches.memory.Util

public final class Util
extends Object

Author:

Lee Rhodes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Util.RandomCodePoints Creates random valid Character Code Points (as integers).

Method Summary

Modifier and Type	Method and Description
static long	binarySearchLongs(Memory mem, long fromLongIndex, long toLongIndex, long key) Searches a range of the specified array of longs for the specified value using the binary search algorithm.
static String	characterPad(String s, int fieldLength, char padChar, boolean postpend) Prepend or postpend the given string with the given character to fill the given field length.
static byte[]	getResourceBytes(String shortFileName) Returns a byte array of the contents of the file defined by the given resource file's shortFileName.
static File	getResourceFile(String shortFileName) Gets the file defined by the given resource file's shortFileName.
static String	getResourcePath(String shortFileName) Gets the absolute path of the given resource file's shortName.
static boolean	isAllBitsClear(long value, long bitMask) Return true if all the masked bits of value are zero
static boolean	isAllBitsSet(long value, long bitMask) Return true if all the masked bits of value are one
static boolean	isAnyBitsClear(long value, long bitMask) Return true if any the masked bits of value are zero
static boolean	isAnyBitsSet(long value, long bitMask) Return true if any the masked bits of value are one
static String	zeroPad(String s, int fieldLength) Prepend the given string with zeros.

Methods inherited from class java.lang.Object

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

Method Detail

binarySearchLongs

public static long binarySearchLongs(Memory mem,
                                     long fromLongIndex,
                                     long toLongIndex,
                                     long key)

Searches a range of the specified array of longs for the specified value using the binary search algorithm. The range must be sorted method) prior to making this call. If it is not sorted, the results are undefined. If the range contains multiple elements with the specified value, there is no guarantee which one will be found.

Parameters:

mem - the Memory to be searched

fromLongIndex - the index of the first element (inclusive) to be searched

toLongIndex - the index of the last element (exclusive) to be searched

key - the value to be searched for

Returns:

index of the search key, if it is contained in the array within the specified range; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the array: the index of the first element in the range greater than the key, or toIndex if all elements in the range are less than the specified key. Note that this guarantees that the return value will be ≥ 0 if and only if the key is found.

zeroPad

public static final String zeroPad(String s,
                                   int fieldLength)

Prepend the given string with zeros. If the given string is equal or greater than the given field length, it will be returned without modification.

Parameters:

s - the given string

fieldLength - desired total field length including the given string

Returns:

the given string prepended with zeros.

characterPad

public static final String characterPad(String s,
                                        int fieldLength,
                                        char padChar,
                                        boolean postpend)

Prepend or postpend the given string with the given character to fill the given field length. If the given string is equal or greater than the given field length, it will be returned without modification.

Parameters:

s - the given string

fieldLength - the desired field length

padChar - the desired pad character

postpend - if true append the pacCharacters to the end of the string.

Returns:

prepended or postpended given string with the given character to fill the given field length.

isAllBitsClear

public static final boolean isAllBitsClear(long value,
                                           long bitMask)

Return true if all the masked bits of value are zero

Parameters:

value - the value to be tested

bitMask - defines the bits of interest

Returns:

true if all the masked bits of value are zero

isAllBitsSet

public static final boolean isAllBitsSet(long value,
                                         long bitMask)

Return true if all the masked bits of value are one

Parameters:

value - the value to be tested

bitMask - defines the bits of interest

Returns:

true if all the masked bits of value are one

isAnyBitsClear

public static final boolean isAnyBitsClear(long value,
                                           long bitMask)

Return true if any the masked bits of value are zero

Parameters:

value - the value to be tested

bitMask - defines the bits of interest

Returns:

true if any the masked bits of value are zero

isAnyBitsSet

public static final boolean isAnyBitsSet(long value,
                                         long bitMask)

Return true if any the masked bits of value are one

Parameters:

value - the value to be tested

bitMask - defines the bits of interest

Returns:

true if any the masked bits of value are one

getResourcePath

public static String getResourcePath(String shortFileName)

Gets the absolute path of the given resource file's shortName.

Note that the ClassLoader.getResource(shortName) returns a URL, which can have special characters, e.g., "%20" for spaces. This method obtains the URL, converts it to a URI, then does a uri.getPath(), which decodes any special characters in the URI path. This is required to make obtaining resources operating-system independent.

Parameters:

shortFileName - the last name in the pathname's name sequence.

Returns:

the absolute path of the given resource file's shortName.

getResourceFile

public static File getResourceFile(String shortFileName)

Gets the file defined by the given resource file's shortFileName.

Parameters:

shortFileName - the last name in the pathname's name sequence.

Returns:

the file defined by the given resource file's shortFileName.

getResourceBytes

public static byte[] getResourceBytes(String shortFileName)

Returns a byte array of the contents of the file defined by the given resource file's shortFileName.

Parameters:

shortFileName - the last name in the pathname's name sequence.

Returns:

a byte array of the contents of the file defined by the given resource file's shortFileName.