public class DataHelper extends Object
Modifier and Type | Field and Description |
---|---|
static byte |
BOOLEAN_FALSE
deprecated - used only in DatabaseLookupMessage
|
static int |
BOOLEAN_LENGTH
Deprecated.
unused
|
static byte |
BOOLEAN_TRUE
deprecated - used only in DatabaseLookupMessage
|
static byte |
BOOLEAN_UNKNOWN
Deprecated.
unused
|
static int |
DATE_LENGTH |
static int |
MAX_COMPRESSION |
static int |
MAX_UNCOMPRESSED |
static int |
NO_COMPRESSION |
Constructor and Description |
---|
DataHelper() |
Modifier and Type | Method and Description |
---|---|
static int |
compareTo(byte[] lhs,
byte[] rhs)
Big endian compare, treats bytes as unsigned.
|
static byte[] |
compress(byte[] orig)
Compress the data and return a new GZIP compressed byte array.
|
static byte[] |
compress(byte[] orig,
int offset,
int size)
Compress the data and return a new GZIP compressed byte array.
|
static byte[] |
compress(byte[] orig,
int offset,
int size,
int level)
Compress the data and return a new GZIP compressed byte array.
|
static void |
copy(InputStream in,
OutputStream out)
Copy in to out.
|
static byte[] |
decompress(byte[] orig)
Decompress the GZIP compressed data (returning null on error).
|
static byte[] |
decompress(byte[] orig,
int offset,
int length)
Decompress the GZIP compressed data (returning null on error).
|
static boolean |
eq(byte[] lhs,
byte[] rhs)
Run a comparison on the byte arrays, byte by byte.
|
static boolean |
eq(byte[] lhs,
int offsetLeft,
byte[] rhs,
int offsetRight,
int length)
Unlike eq(byte[], byte[]), this returns false if either lhs or rhs is null.
|
static boolean |
eq(byte lhs,
byte rhs)
Deprecated.
inefficient
|
static boolean |
eq(Collection<?> lhs,
Collection<?> rhs)
Run a deep comparison across the two collections.
|
static boolean |
eq(int lhs,
int rhs)
Deprecated.
inefficient
|
static boolean |
eq(long lhs,
long rhs)
Deprecated.
inefficient
|
static boolean |
eq(Object lhs,
Object rhs)
Helper util to compare two objects, including null handling.
|
static boolean |
eqCT(byte[] lhs,
int offsetLeft,
byte[] rhs,
int offsetRight,
int length)
Unlike eq(), this throws NPE if either lhs or rhs is null.
|
static String |
escapeHTML(String unescaped)
Escape a string for inclusion in HTML
|
static String |
formatDuration(long ms)
NOTE: formatDuration2() recommended in most cases for readability
|
static String |
formatDuration2(double ms)
Like formatDuration2(long) but with microsec and nanosec also.
|
static String |
formatDuration2(long ms)
Like formatDuration but with a non-breaking space after the number,
0 is unitless, and the unit is translated.
|
static String |
formatSize(long bytes)
Caller should append 'B' or 'b' as appropriate
NOTE: formatDuration2() recommended in most cases for readability
|
static String |
formatSize2(long bytes)
Like formatSize but with a non-breaking space after the number
This seems consistent with most style guides out there.
|
static Boolean |
fromBoolean(byte[] data,
int offset)
Deprecated.
unused
|
static Date |
fromDate(byte[] src,
int offset) |
static byte[] |
fromHexString(String val)
Deprecated.
unused
|
static long |
fromLong(byte[] src,
int offset,
int numBytes)
Big endian.
|
static long |
fromLongLE(byte[] src,
int offset,
int numBytes)
Little endian, i.e.
|
static int |
fromProperties(byte[] source,
int offset,
Properties target)
Reads the props from the byte array and puts them in the Properties target
See readProperties() for the format.
|
static byte[] |
getASCII(String orig)
Roughly the same as orig.getBytes("ISO-8859-1") but much faster and
will not throw an exception.
|
static String |
getUTF8(byte[] orig)
Same as new String(orig, "UTF-8") but throws an unchecked RuntimeException
instead of an UnsupportedEncodingException if no UTF-8, for ease of use.
|
static String |
getUTF8(byte[] orig,
int offset,
int len)
Same as new String(orig, "UTF-8") but throws an unchecked RuntimeException
instead of an UnsupportedEncodingException if no UTF-8, for ease of use.
|
static byte[] |
getUTF8(String orig)
Same as orig.getBytes("UTF-8") but throws an unchecked RuntimeException
instead of an UnsupportedEncodingException if no UTF-8, for ease of use.
|
static byte[] |
getUTF8(StringBuffer orig)
Deprecated.
unused
|
static int |
hashCode(byte[] b)
Calculate the hashcode of the byte array, using 0 for null
|
static int |
hashCode(Collection<?> col)
Calculate the hashcode of the collection, using 0 for null
|
static int |
hashCode(Date obj)
Calculate the hashcode of the date, using 0 for null
|
static int |
hashCode(Object obj)
Calculate the hashcode of the object, using 0 for null
|
static void |
loadProps(Properties props,
File file)
A more efficient Properties.load
Some of the other differences:
- UTF-8 encoding, not ISO-8859-1
- No escaping! This does not process or drop backslashes
- '#' or ';' starts a comment line, but '!' does not
- Leading whitespace is not trimmed
- '=' is the only key-termination character (not ':' or whitespace)
As of 0.9.10, an empty value is allowed.
|
static void |
loadProps(Properties props,
File file,
boolean forceLowerCase) |
static void |
loadProps(Properties props,
InputStream inStr) |
static void |
loadProps(Properties props,
InputStream inStr,
boolean forceLowerCase) |
static int |
read(InputStream in,
byte[] target)
This is different than InputStream.read(target), in that it
does repeated reads until the full data is received.
|
static int |
read(InputStream in,
byte[] target,
int offset,
int length)
WARNING - This is different than InputStream.read(target, offset, length)
for a nonzero offset, in that it
returns the new offset (== old offset + length).
|
static Boolean |
readBoolean(InputStream in)
Deprecated.
unused
|
static Date |
readDate(InputStream in)
Read in a date from the stream as specified by the I2P data structure spec.
|
static String |
readLine(InputStream in)
Read a newline delimited line from the stream, returning the line (without
the newline), or null if EOF reached on an empty line
Warning - strips \n but not \r
Warning - 8KB line length limit as of 0.7.13, @throws IOException if exceeded
Warning - not UTF-8
|
static String |
readLine(InputStream in,
MessageDigest hash)
update the hash along the way
Warning - strips \n but not \r
Warning - 8KB line length limit as of 0.7.13, @throws IOException if exceeded
Warning - not UTF-8
|
static boolean |
readLine(InputStream in,
StringBuilder buf)
Read in a line, placing it into the buffer (excluding the newline).
|
static boolean |
readLine(InputStream in,
StringBuilder buf,
MessageDigest hash)
update the hash along the way
Warning - strips \n but not \r
Warning - 8KB line length limit as of 0.7.13, @throws IOException if exceeded
Warning - not UTF-8
|
static long |
readLong(InputStream rawStream,
int numBytes)
Read the stream for an integer as defined by the I2P data structure specification.
|
static Properties |
readProperties(InputStream rawStream)
Read a mapping from the stream, as defined by the I2P data structure spec,
and store it into a Properties object.
|
static Properties |
readProperties(InputStream rawStream,
Properties props)
Ditto, load into an existing properties
As of 0.9.18, throws DataFormatException on duplicate key
|
static String |
readString(InputStream in)
Read in a string from the stream as specified by the I2P data structure spec.
|
static void |
skip(InputStream in,
long n)
This is different than InputStream.skip(), in that it
does repeated reads until the full amount is skipped.
|
static String[] |
split(String s,
String regex)
Same as s.split(regex) but caches the compiled pattern for speed.
|
static String[] |
split(String s,
String regex,
int limit)
Same as s.split(regex, limit) but caches the compiled pattern for speed.
|
static void |
storeProps(Properties props,
File file)
Writes the props to the file, unsorted (unless props is an OrderedProperties)
Note that this does not escape the \r or \n that are unescaped in loadProps() above.
|
static String |
stripHTML(String orig)
Strip out any HTML (simply removing any less than / greater than symbols)
|
static void |
toBoolean(byte[] data,
int offset,
boolean value)
Deprecated.
unused
|
static void |
toBoolean(byte[] data,
int offset,
Boolean value)
Deprecated.
unused
|
static void |
toDate(byte[] target,
int offset,
long when) |
static byte[] |
toDate(Date date)
Deprecated.
unused
|
static String |
toDecimalString(byte[] buf,
int len)
Deprecated.
unused
|
static String |
toHexString(byte[] data)
Lower-case hex without leading zeros.
|
static void |
toLong(byte[] target,
int offset,
int numBytes,
long value)
Big endian.
|
static byte[] |
toLong(int numBytes,
long value)
Big endian.
|
static void |
toLongLE(byte[] target,
int offset,
int numBytes,
long value)
Little endian, i.e.
|
static int |
toProperties(byte[] target,
int offset,
Properties props)
Deprecated.
|
static byte[] |
toProperties(Properties opts)
Writes the props to returned byte array, not sorted
(unless the opts param is an OrderedProperties)
Strings will be UTF-8 encoded in the byte array.
|
static String |
toString(byte[] buf)
Lower-case hex with leading zeros.
|
static String |
toString(byte[] buf,
int len)
Lower-case hex with leading zeros.
|
static String |
toString(Collection<?> col)
Pretty print the collection
|
static String |
toString(Map<?,?> options)
Pretty print the mapping, unsorted
(unless the options param is an OrderedProperties)
|
static String |
toString(Properties options)
Pretty print the mapping, unsorted
(unless the options param is an OrderedProperties)
|
static void |
write(OutputStream out,
byte[] data,
MessageDigest hash)
update the hash along the way
|
static void |
writeBoolean(OutputStream out,
Boolean bool)
Deprecated.
unused
|
static void |
writeDate(OutputStream out,
Date date)
Write out a date to the stream as specified by the I2P data structure spec.
|
static void |
writeLong(OutputStream rawStream,
int numBytes,
long value)
Write an integer as defined by the I2P data structure specification to the stream.
|
static void |
writeProperties(OutputStream rawStream,
Properties props)
Write a mapping to the stream, as defined by the I2P data structure spec,
and store it into a Properties object.
|
static void |
writeProperties(OutputStream rawStream,
Properties props,
boolean utf8)
Writes the props to the stream, sorted by property name.
|
static void |
writeProperties(OutputStream rawStream,
Properties props,
boolean utf8,
boolean sort)
Writes the props to the stream, sorted by property name if sort == true or
if props is an OrderedProperties.
|
static void |
writeString(OutputStream out,
String string)
Write out a string to the stream as specified by the I2P data structure spec.
|
static void |
writeStringUTF8(OutputStream out,
String string)
Write out a string to the stream as specified by the I2P data structure spec.
|
static byte[] |
xor(byte[] lhs,
byte[] rhs) |
static void |
xor(byte[] lhs,
int startLeft,
byte[] rhs,
int startRight,
byte[] out,
int startOut,
int len)
xor the lhs with the rhs, storing the result in out.
|
public static final int DATE_LENGTH
public static final byte BOOLEAN_TRUE
public static final byte BOOLEAN_FALSE
@Deprecated public static final byte BOOLEAN_UNKNOWN
@Deprecated public static final int BOOLEAN_LENGTH
public static final int MAX_UNCOMPRESSED
public static final int MAX_COMPRESSION
public static final int NO_COMPRESSION
public static Properties readProperties(InputStream rawStream) throws DataFormatException, IOException
rawStream
- stream to read the mapping fromDataFormatException
- if the format is invalidIOException
- if there is a problem reading the datapublic static Properties readProperties(InputStream rawStream, Properties props) throws DataFormatException, IOException
props
- the Properties to load intorawStream
- stream to read the mapping fromDataFormatException
- if the format is invalidIOException
- if there is a problem reading the datapublic static void writeProperties(OutputStream rawStream, Properties props) throws DataFormatException, IOException
rawStream
- stream to write toprops
- properties to write out, may be nullDataFormatException
- if there is not enough valid data to write out,
or a length limit is exceededIOException
- if there is an IO error writing out the datapublic static void writeProperties(OutputStream rawStream, Properties props, boolean utf8) throws DataFormatException, IOException
props
- source may be nullDataFormatException
- if a length limit is exceededIOException
public static void writeProperties(OutputStream rawStream, Properties props, boolean utf8, boolean sort) throws DataFormatException, IOException
props
- source may be nullsort
- should we sort the properties? (set to false if already sorted, e.g. OrderedProperties)DataFormatException
- if any string is over 255 bytes long, or if the total length
(not including the two length bytes) is greater than 65535 bytes.IOException
@Deprecated public static int toProperties(byte[] target, int offset, Properties props) throws DataFormatException, IOException
DataFormatException
IOException
public static int fromProperties(byte[] source, int offset, Properties target) throws DataFormatException
source
- sourcetarget
- returned PropertiesDataFormatException
public static byte[] toProperties(Properties opts) throws DataFormatException
DataFormatException
- if key, value, or total is too longpublic static String toString(Properties options)
public static String toString(Map<?,?> options)
public static void loadProps(Properties props, File file) throws IOException
IOException
public static void loadProps(Properties props, File file, boolean forceLowerCase) throws IOException
forceLowerCase
- if true forces the keys to lower case (not the values)IOException
public static void loadProps(Properties props, InputStream inStr) throws IOException
IOException
public static void loadProps(Properties props, InputStream inStr, boolean forceLowerCase) throws IOException
forceLowerCase
- if true forces the keys to lower case (not the values)IOException
public static void storeProps(Properties props, File file) throws IOException
IllegalArgumentException
- if a key contains any of "#=\n" or starts with ';',
or a value contains '#' or '\n'IOException
public static String toString(Collection<?> col)
public static String toString(byte[] buf)
buf
- may be null (returns "")public static String toString(byte[] buf, int len)
buf
- may be nulllen
- number of bytes. If greater than buf.length, additional zeros will be prependedpublic static String toDecimalString(byte[] buf, int len)
buf
- may be null (returns "0")len
- unusedpublic static final String toHexString(byte[] data)
data
- may be null (returns "00")public static final byte[] fromHexString(String val)
val
- non-null, may have leading minus signpublic static long readLong(InputStream rawStream, int numBytes) throws DataFormatException, IOException
rawStream
- stream to read fromnumBytes
- number of bytes to read and format into a number, 1 to 8DataFormatException
- if negative (only possible if numBytes = 8) (since 0.8.12)EOFException
- since 0.8.2, if there aren't enough bytes to read the numberIOException
- if there is an IO error reading the numberpublic static void writeLong(OutputStream rawStream, int numBytes, long value) throws DataFormatException, IOException
value
- value to write out, non-negativerawStream
- stream to write tonumBytes
- number of bytes to write the number into, 1-8 (padding as necessary)DataFormatException
- if value is negative or if numBytes not 1-8IOException
- if there is an IO error writing to the streampublic static byte[] toLong(int numBytes, long value) throws IllegalArgumentException
numBytes
- 1-8value
- non-negativeIllegalArgumentException
public static void toLong(byte[] target, int offset, int numBytes, long value) throws IllegalArgumentException
numBytes
- 1-8value
- non-negativeIllegalArgumentException
public static void toLongLE(byte[] target, int offset, int numBytes, long value)
numBytes
- 1-8value
- non-negativepublic static long fromLong(byte[] src, int offset, int numBytes)
src
- if null returns 0numBytes
- 1-8ArrayIndexOutOfBoundsException
IllegalArgumentException
- if negative (only possible if numBytes = 8)public static long fromLongLE(byte[] src, int offset, int numBytes)
numBytes
- 1-8ArrayIndexOutOfBoundsException
IllegalArgumentException
- if negative (only possible if numBytes = 8)public static Date readDate(InputStream in) throws DataFormatException, IOException
in
- stream to read fromDataFormatException
- if the stream doesn't contain a validly formatted dateIOException
- if there is an IO error reading the datepublic static void writeDate(OutputStream out, Date date) throws DataFormatException, IOException
out
- stream to write todate
- date to write (can be null)DataFormatException
- if the date is not validIOException
- if there is an IO error writing the date@Deprecated public static byte[] toDate(Date date) throws IllegalArgumentException
IllegalArgumentException
public static void toDate(byte[] target, int offset, long when) throws IllegalArgumentException
IllegalArgumentException
public static Date fromDate(byte[] src, int offset) throws DataFormatException
DataFormatException
public static String readString(InputStream in) throws DataFormatException, IOException
in
- stream to read fromDataFormatException
- if the stream doesn't contain a validly formatted stringEOFException
- since 0.8.2, if there aren't enough bytes to read the stringIOException
- if there is an IO error reading the stringpublic static void writeString(OutputStream out, String string) throws DataFormatException, IOException
out
- stream to write stringstring
- string to write out: null strings are perfectly valid, but strings of excess length will
cause a DataFormatException to be thrownDataFormatException
- if the string is not validIOException
- if there is an IO error writing the stringpublic static void writeStringUTF8(OutputStream out, String string) throws DataFormatException, IOException
out
- stream to write stringstring
- UTF-8 string to write out: null strings are perfectly valid, but strings of excess length will
cause a DataFormatException to be thrownDataFormatException
- if the string is not validIOException
- if there is an IO error writing the string@Deprecated public static Boolean readBoolean(InputStream in) throws DataFormatException, IOException
in
- stream to read fromDataFormatException
- if the boolean is not validIOException
- if there is an IO error reading the boolean@Deprecated public static void writeBoolean(OutputStream out, Boolean bool) throws DataFormatException, IOException
out
- stream to write tobool
- boolean value, or nullDataFormatException
- if the boolean is not validIOException
- if there is an IO error writing the boolean@Deprecated public static Boolean fromBoolean(byte[] data, int offset)
@Deprecated public static void toBoolean(byte[] data, int offset, boolean value)
@Deprecated public static void toBoolean(byte[] data, int offset, Boolean value)
public static final boolean eq(Object lhs, Object rhs)
This treats (null == null) as true, and (null == (!null)) as false.
public static final boolean eq(Collection<?> lhs, Collection<?> rhs)
This treats (null == null) as true, (null == (!null)) as false, and then comparing each element via eq(object, object).
If the size of the collections are not equal, the comparison returns false. The collection order should be consistent, as this simply iterates across both and compares based on the value of each at each step along the way.
public static final boolean eq(byte[] lhs, byte[] rhs)
This treats (null == null) as true, (null == (!null)) as false, and unequal length arrays as false. Variable time.
@Deprecated public static final boolean eq(int lhs, int rhs)
@Deprecated public static final boolean eq(long lhs, long rhs)
@Deprecated public static final boolean eq(byte lhs, byte rhs)
public static final boolean eq(byte[] lhs, int offsetLeft, byte[] rhs, int offsetRight, int length)
ArrayIndexOutOfBoundsException
- if either array isn't long enoughpublic static final boolean eqCT(byte[] lhs, int offsetLeft, byte[] rhs, int offsetRight, int length)
NullPointerException
- if lhs or rhs is nullArrayIndexOutOfBoundsException
- if either array isn't long enoughpublic static final int compareTo(byte[] lhs, byte[] rhs)
public static final byte[] xor(byte[] lhs, byte[] rhs)
public static final void xor(byte[] lhs, int startLeft, byte[] rhs, int startRight, byte[] out, int startOut, int len)
lhs
- one of the source arraysstartLeft
- starting index in the lhs array to begin the xorrhs
- the other source arraystartRight
- starting index in the rhs array to begin the xorout
- output arraystartOut
- starting index in the out array to store the resultlen
- how many bytes into the various arrays to xorpublic static int hashCode(Object obj)
public static int hashCode(Date obj)
public static int hashCode(byte[] b)
public static int hashCode(Collection<?> col)
public static void skip(InputStream in, long n) throws IOException
IOException
public static int read(InputStream in, byte[] target) throws IOException
EOFException
- if the full length is not read (since 0.9.27)IOException
public static int read(InputStream in, byte[] target, int offset, int length) throws IOException
EOFException
- if the full length is not read (since 0.9.27)IOException
public static String readLine(InputStream in) throws IOException
IOException
public static String readLine(InputStream in, MessageDigest hash) throws IOException
hash
- null OKIOException
public static boolean readLine(InputStream in, StringBuilder buf) throws IOException
IOException
public static boolean readLine(InputStream in, StringBuilder buf, MessageDigest hash) throws IOException
hash
- null OKIOException
public static void write(OutputStream out, byte[] data, MessageDigest hash) throws IOException
IOException
public static String formatDuration(long ms)
public static String formatDuration2(long ms)
public static String formatDuration2(double ms)
public static String formatSize(long bytes)
public static String formatSize2(long bytes)
public static String stripHTML(String orig)
orig
- may be null, returns empty string if nullpublic static String escapeHTML(String unescaped)
unescaped
- the unescaped string, may be nullpublic static byte[] compress(byte[] orig)
IllegalArgumentException
- if input size is over 40KBIllegalStateException
- on compression failure, as of 0.9.29public static byte[] compress(byte[] orig, int offset, int size)
IllegalArgumentException
- if size is over 40KBIllegalStateException
- on compression failure, as of 0.9.29public static byte[] compress(byte[] orig, int offset, int size, int level)
level
- the compression level, 0 to 9IllegalArgumentException
- if size is over 40KBIllegalStateException
- on compression failure, as of 0.9.29public static byte[] decompress(byte[] orig) throws IOException
IOException
- if uncompressed is over 40 KB,
or on a decompression errorpublic static byte[] decompress(byte[] orig, int offset, int length) throws IOException
IOException
- if uncompressed is over 40 KB,
or on a decompression errorpublic static byte[] getUTF8(String orig)
RuntimeException
public static byte[] getUTF8(StringBuffer orig)
RuntimeException
public static String getUTF8(byte[] orig)
RuntimeException
public static String getUTF8(byte[] orig, int offset, int len)
RuntimeException
public static byte[] getASCII(String orig)
orig
- non-null, truncates to 8-bit charspublic static String[] split(String s, String regex)
s
- non-nullregex
- non-nullPatternSyntaxException
- uncheckedpublic static String[] split(String s, String regex, int limit)
s
- non-nullregex
- non-nulllimit
- result thresholdPatternSyntaxException
- uncheckedpublic static void copy(InputStream in, OutputStream out) throws IOException
in
- non-nullout
- non-nullIOException