|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.i2p.data.DataHelper
public class DataHelper
Defines some simple IO routines for dealing with marshalling data structures
Field Summary | |
---|---|
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 Summary | |
---|---|
DataHelper()
|
Method Summary | |
---|---|
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 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 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(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)
|
static long |
fromLong(byte[] src,
int offset,
int numBytes)
|
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 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)
Deprecated. unused |
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: - 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) |
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)
This is different than InputStream.read(target, offset, length), in that it returns the new offset (== old offset + bytes read). |
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 before the newline was found 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 String |
readLine(InputStream in,
Sha256Standalone hash)
Deprecated. use MessageDigest version |
static boolean |
readLine(InputStream in,
StringBuffer buf)
Deprecated. use StringBuilder version |
static boolean |
readLine(InputStream in,
StringBuffer buf,
Sha256Standalone hash)
Deprecated. use StringBuilder / MessageDigest version |
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 boolean |
readLine(InputStream in,
StringBuilder buf,
Sha256Standalone hash)
Deprecated. use MessageDigest version |
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 |
static String |
readString(InputStream in)
Read in a string from the stream as specified by the I2P data structure spec. |
(package private) static void |
sortStructureList(List<? extends DataStructure> dataStructures)
See above. |
static List<? extends DataStructure> |
sortStructures(Collection<? extends DataStructure> dataStructures)
Sort based on the Hash of the DataStructure. |
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)
|
static String |
toHexString(byte[] data)
Lower-case hex without leading zeros. |
static void |
toLong(byte[] target,
int offset,
int numBytes,
long value)
|
static byte[] |
toLong(int numBytes,
long value)
|
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 |
write(OutputStream out,
byte[] data,
Sha256Standalone hash)
Deprecated. use MessageDigest version |
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 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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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
Constructor Detail |
---|
public DataHelper()
Method Detail |
---|
public static Properties readProperties(InputStream rawStream) throws DataFormatException, IOException
rawStream
- stream to read the mapping from
DataFormatException
- if the format is invalid
IOException
- if there is a problem reading the datapublic static Properties readProperties(InputStream rawStream, Properties props) throws DataFormatException, IOException
props
- the Properties to load into
DataFormatException
IOException
public static void writeProperties(OutputStream rawStream, Properties props) throws DataFormatException, IOException
rawStream
- stream to write toprops
- properties to write out
DataFormatException
- if either is too long.
DataFormatException
- if there is not enough valid data to write out
IOException
- 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 null
DataFormatException
- if either is too long.
jrandom disabled UTF-8 in mid-2004, for performance reasons,
i.e. slow foo.getBytes("UTF-8")
Re-enable it so we can pass UTF-8 tunnel names through the I2CP SessionConfig.
Use utf8 = false for RouterAddress (fast, non UTF-8)
Use utf8 = true for SessionConfig (slow, UTF-8)
IOException
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 Properties
DataFormatException
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 prepended
public static String toDecimalString(byte[] buf, int len)
public static final String toHexString(byte[] data)
data
- may be null (returns "00")public static final byte[] fromHexString(String val)
public 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 8
DataFormatException
- 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 number
IOException
- 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 (padding as necessary)
DataFormatException
- if value is negative
IOException
- if there is an IO error writing to the streampublic static byte[] toLong(int numBytes, long value) throws IllegalArgumentException
numBytes
- 1-8value
- non-negative
IllegalArgumentException
public static void toLong(byte[] target, int offset, int numBytes, long value) throws IllegalArgumentException
numBytes
- 1-8value
- non-negative
IllegalArgumentException
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-8
AIOOBE
IllegalArgumentException
- if negative (only possible if numBytes = 8)public static long fromLongLE(byte[] src, int offset, int numBytes)
numBytes
- 1-8
AIOOBE
IllegalArgumentException
- if negative (only possible if numBytes = 8)public static Date readDate(InputStream in) throws DataFormatException, IOException
in
- stream to read from
DataFormatException
- if the stream doesn't contain a validly formatted date
IOException
- 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 valid
IOException
- 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 from
DataFormatException
- if the stream doesn't contain a validly formatted string
EOFException
- since 0.8.2, if there aren't enough bytes to read the string
IOException
- 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 thrown
DataFormatException
- if the string is not valid
IOException
- if there is an IO error writing the stringpublic static Boolean readBoolean(InputStream in) throws DataFormatException, IOException
in
- stream to read from
DataFormatException
- if the boolean is not valid
IOException
- 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 null
DataFormatException
- if the boolean is not valid
IOException
- 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)
public static final boolean eq(Collection lhs, Collection rhs)
public static final boolean eq(byte[] lhs, byte[] rhs)
@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)
AIOOBE
- 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 int read(InputStream in, byte[] target) throws IOException
IOException
public static int read(InputStream in, byte[] target, int offset, int length) throws IOException
IOException
public static String readLine(InputStream in) throws IOException
IOException
public static String readLine(InputStream in, Sha256Standalone hash) throws IOException
IOException
public static String readLine(InputStream in, MessageDigest hash) throws IOException
IOException
@Deprecated public static boolean readLine(InputStream in, StringBuffer buf) throws IOException
IOException
@Deprecated public static boolean readLine(InputStream in, StringBuffer buf, Sha256Standalone hash) throws IOException
IOException
public static boolean readLine(InputStream in, StringBuilder buf) throws IOException
IOException
public static boolean readLine(InputStream in, StringBuilder buf, Sha256Standalone hash) throws IOException
IOException
public static boolean readLine(InputStream in, StringBuilder buf, MessageDigest hash) throws IOException
IOException
public static void write(OutputStream out, byte[] data, Sha256Standalone hash) throws IOException
IOException
public static void write(OutputStream out, byte[] data, MessageDigest hash) throws IOException
IOException
public static List<? extends DataStructure> sortStructures(Collection<? extends DataStructure> dataStructures)
static void sortStructureList(List<? extends DataStructure> dataStructures)
public static String formatDuration(long ms)
public static String formatDuration2(long 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 null
public static byte[] compress(byte[] orig)
IllegalArgumentException
- if size is over 40KBpublic static byte[] compress(byte[] orig, int offset, int size)
IllegalArgumentException
- if size is over 40KBpublic static byte[] compress(byte[] orig, int offset, int size, int level)
IllegalArgumentException
- if size is over 40KBpublic static byte[] decompress(byte[] orig) throws IOException
IOE
- if uncompressed is over 40 KB
IOException
public static byte[] decompress(byte[] orig, int offset, int length) throws IOException
IOE
- if uncompressed is over 40 KB
IOException
public 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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |