BinaryUtils - Revision history

G.dimaio at 17:54, 21 December 2012

2012-12-21T17:54:20Z

Anonymous at 09:33, 20 December 2012

2012-12-20T09:33:12Z

Anonymous at 09:22, 20 December 2012

2012-12-20T09:22:48Z

Anonymous at 13:26, 18 December 2012

2012-12-18T13:26:39Z

Anonymous at 09:29, 18 December 2012

2012-12-18T09:29:02Z

Anonymous: Created page with "Class FQN: '''it.greenvulcano.util.bin.BinaryUtils''' ==Following the BinaryUtils public static methods== /** * Dumps the content of a byte array..."

2012-12-18T09:14:14Z

Created page with "Class FQN: '''it.greenvulcano.util.bin.BinaryUtils''' ==Following the BinaryUtils public static methods== <syntaxhighlight lang="java5"> /** * Dumps the content of a byte array..."

New page

Class FQN: '''it.greenvulcano.util.bin.BinaryUtils'''

==Following the BinaryUtils public static methods==

<syntaxhighlight lang="java5">
/**
* Dumps the content of a byte array as a sequence of integers
*
* @param arr
* the array to convert
* @return the converted value
*/
public static String dumpByteArrayAsInts(byte[] arr)

/**
* Dumps the content of a byte array as a sequence of integers (Hex format)
*
* @param arr
* The byte array
* @return The String conversion of the buffer bytes as integer values in
* 2-Hex-digits output format
*/
public static String dumpByteArrayAsHexInts(byte[] arr)

/**
* Dumps the Hex formatted sequence as a byte array
*
* @param hexArr
* The 2-Hex-digits string to convert
* @return the byte array, or an empy array if input is malformed
*/
public static byte[] dumpHexIntsAsByteArray(String hexArr)

/**
* Convert sequences of characters (into an input string) representing an
* escape sequence into the corresponding escape sequences
*
* @param input
* the input string
* @return the converted string
*/
public static String unescapeString(String input)

/**
* This method tokenizes a given string using a given byte sequence as
* separator and returns a <tt>List</tt> containing found tokens. The
* returned <tt>List</tt> is NEVER null (it may have zero components,
* anyway).
*
* @param theString
* the <tt>String</tt> to be tokenized.
* @param separatorByteSequence
* the byte sequence separator between tokens.
* @return a <tt>List</tt> containing found tokens.
*/
public static List<String> splitByByteSequenceSeparator(String theString, byte[] separatorByteSequence)

/**
* Loads the full content of a file. 
* The file must be reachable via the parent classloader, or at least
* via the system classloader. 
* The full content of a file is then stored into a <code>byte</code> array. 
*
* @param filename
* the name of the file to be read
* @return the full content of the file, stored into a <code>byte</code>
* array
* @throws IOException
* if any I/O error occurs
*/
public static byte[] readFileAsBytesFromCP(String filename) throws IOException

/**
* Loads the full content of a file into a <code>byte</code> array. 
*
* @param filename
* the name of the file to be read
* @return the full content of the file, stored into a <code>byte</code>
* array
* @throws IOException
* if any I/O error occurs
*/
public static byte[] readFileAsBytes(String filename) throws IOException

/**
* Loads the full content of a file into a <code>byte</code> array. 
*
* @param file
* the file to be read
* @return the full content of the file, stored into a <code>byte</code>
* array
* @throws IOException
* if any I/O error occurs
*/
public static byte[] readFileAsBytes(File file) throws IOException

/**
* Read all data from a source <code>InputStream</code> and stores them into
* a <code>byte</code> array. 
* It is assumed that the source <code>InputStream</code> will be closed by
* the caller of this method.
*
* @param in
* the <code>InputStream</code> to read from
* @return the read bytes, stored into a <code>byte</code> array
* @throws IOException
* if any I/O error occurs
*/
public static byte[] inputStreamToBytes(InputStream in) throws IOException

/**
* Read all data from a source <code>InputStream</code> and stores them into
* a file on the local filesystem. 
* It is assumed that the source <code>InputStream</code> will be closed by
* the caller of this method.
*
* @param in
* the <code>InputStream</code> to read from
* @param filename
* the name of the file to be written to
* @throws IOException
* if any I/O error occurs
*/
public static void inputStreamToFile(InputStream in, String filename) throws IOException

/**
* Write the content of a <code>byte</code> array into a new file on the
* local filesystem.
*
* @param contentArray
* the <code>byte</code> array to be written to file
* @param filename
* the name of the file to be written to
* @throws IOException
* if any I/O error occurs
*/
public static void writeBytesToFile(byte[] contentArray, String filename) throws IOException

/**
* Write the content of a <code>byte</code> array into a file on the local
* filesystem.
*
* @param contentArray
* the <code>byte</code> array to be written to file
* @param filename
* the name of the file to be written to
* @param append
* If true the data are appended to existent file
* @throws IOException
* if any I/O error occurs
*/
public static void writeBytesToFile(byte[] contentArray, String filename, boolean append) throws IOException

/**
* Write the content of a <code>byte</code> array into a new file on the
* local filesystem.
*
* @param contentArray
* the <code>byte</code> array to be written to file
* @param file
* the file to be written to
* @throws IOException
* if any I/O error occurs
*/
public static void writeBytesToFile(byte[] contentArray, File file) throws IOException

/**
* Write the content of a <code>byte</code> array into a file on the local
* filesystem.
*
* @param contentArray
* the <code>byte</code> array to be written to file
* @param file
* the file to be written to
* @throws IOException
* if any I/O error occurs
*/
public static void writeBytesToFile(byte[] contentArray, File file, boolean append) throws IOException

/**
* Returns <code>true</code> if the passed <code>byte</code> value is an
* ASCII printable character, <code>false</code> otherwise.
*
* @param b
* the passed <code>byte</code> value
* @return <code>true</code> if the passed <code>byte</code> value is an
* ASCII printable character, <code>false</code> otherwise.
*/
public static boolean isASCIIPrintableChar(byte b)
</syntaxhighlight>

@@ Line 2: / Line 2: @@
 This class contains static utility methods to manage binary buffers.
-==Following the BinaryUtils public static methods==
+==BinaryUtils public static methods==
 <syntaxhighlight lang="java5">
 /**

@@ Line 1: / Line 1: @@
 Class FQN: '''it.greenvulcano.util.bin.BinaryUtils'''
 ==Following the BinaryUtils public static methods==
@@ Line 125: / Line 126: @@
 /**
-* Writes the content of a byte array into a new file on the
+* Writes the content of a byte array into a new file on the local filesystem.
+*
 * @param contentArray

@@ Line 72: / Line 72: @@
 /**
-* Loads the full content of a file into a <code>byte</code> array.<br>
+* Loads the full content of a file into a byte array.
+*
 * @param filename
@@ Line 84: / Line 84: @@
 /**
-* Loads the full content of a file into a <code>byte</code> array.<br>
+* Loads the full content of a file into a byte array.
+*
 * @param file
 *        the file to be read
-* @return the full content of the file, stored into a <code>byte</code>
+* @return the full content of the file, stored into a byte
 *         array
 * @throws IOException
@@ Line 152: / Line 152: @@
 /**
-* Writes the content of a byte array into a new file on the
+* Writes the content of a byte array into a new file on the local filesystem.
+*
 * @param contentArray
@@ Line 165: / Line 164: @@
 /**
-* Writes the content of a byte array into a file on the local
+* Writes the content of a byte array into a file on the local filesystem.
+*
 * @param contentArray

@@ Line 33: / Line 33: @@
 /**
-* Convert sequences of characters (into an input string) representing an
+* Converts sequences of characters (into an input string) representing an
 * escape sequence into the corresponding escape sequences
+*
@@ Line 96: / Line 96: @@
 /**
-* Read all data from a source <code>InputStream</code> and stores them into
+* Reads all data from a source InputStream and stores them into
-* a <code>byte</code> array.<br>
+* a byte array.
-* It is assumed that the source <code>InputStream</code> will be closed by
+* It is assumed that the source InputStream will be closed by
 * the caller of this method.
+*
 * @param in
-*        the <code>InputStream</code> to read from
+*        the InputStream to read from
-* @return the read bytes, stored into a <code>byte</code> array
+* @return the read bytes, stored into a byte array
 * @throws IOException
 *         if any I/O error occurs
@@ Line 110: / Line 110: @@
 /**
-* Read all data from a source <code>InputStream</code> and stores them into
+* Reads all data from a source InputStream and stores them into
-* a file on the local filesystem.<br>
+* a file on the local filesystem.
-* It is assumed that the source <code>InputStream</code> will be closed by
+* It is assumed that the source InputStream will be closed by
 * the caller of this method.
+*
 * @param in
-*        the <code>InputStream</code> to read from
+*        the InputStream to read from
 * @param filename
 *        the name of the file to be written to
@@ Line 125: / Line 125: @@
 /**
-* Write the content of a <code>byte</code> array into a new file on the
+* Writes the content of a byte array into a new file on the
 * local filesystem.
+*
 * @param contentArray
-*        the <code>byte</code> array to be written to file
+*        the byte array to be written to file
 * @param filename
 *        the name of the file to be written to
@@ Line 138: / Line 138: @@
 /**
-* Write the content of a <code>byte</code> array into a file on the local
+* Writes the content of a byte array into a file on the local filesystem.
+*
 * @param contentArray
-*        the <code>byte</code> array to be written to file
+*        the byte array to be written to file
 * @param filename
 *        the name of the file to be written to
@@ Line 153: / Line 152: @@
 /**
-* Write the content of a <code>byte</code> array into a new file on the
+* Writes the content of a byte array into a new file on the
 * local filesystem.
+*
 * @param contentArray
-*        the <code>byte</code> array to be written to file
+*        the byte array to be written to file
 * @param file
 *        the file to be written to
@@ Line 166: / Line 165: @@
 /**
-* Write the content of a <code>byte</code> array into a file on the local
+* Writes the content of a byte array into a file on the local
 * filesystem.
+*
 * @param contentArray
-*        the <code>byte</code> array to be written to file
+*        the byte array to be written to file
 * @param file
 *        the file to be written to
@@ Line 179: / Line 178: @@
 /**
-* Returns <code>true</code> if the passed <code>byte</code> value is an
+* Returns true if the passed byte value is an
-* ASCII printable character, <code>false</code> otherwise.
+* ASCII printable character, false otherwise.
+*
 * @param b
-*        the passed <code>byte</code> value
+*        the passed byte value
-* @return <code>true</code> if the passed <code>byte</code> value is an
+* @return true if the passed byte value is an
-*         ASCII printable character, <code>false</code> otherwise.
+*         ASCII printable character, false otherwise.
 */
 public static boolean isASCIIPrintableChar(byte b)
 </syntaxhighlight>

@@ Line 44: / Line 44: @@
 /**
 * This method tokenizes a given string using a given byte sequence as
-* separator and returns a <tt>List</tt> containing found tokens. The
+* separator and returns a List containing found tokens. The
-* returned <tt>List</tt> is NEVER null (it may have zero components,
+* returned List is NEVER null (it may have zero components,
 * anyway).
+*
 * @param theString
-*        the <tt>String</tt> to be tokenized.
+*        the String to be tokenized.
 * @param separatorByteSequence
 *        the byte sequence separator between tokens.
-* @return a <tt>List</tt> containing found tokens.
+* @return a List containing found tokens.
 */
 public static List<String> splitByByteSequenceSeparator(String theString, byte[] separatorByteSequence)
 /**
-* Loads the full content of a file.<br>
+* Loads the full content of a file.
-* The file must be reachable via the <i>parent classloader</i>, or at least
+* The file must be reachable via the parent classloader, or at least
-* via the <i>system classloader</i>.<br>
+* via the system classloader.
-* The full content of a file is then stored into a <code>byte</code> array.<br>
+* The full content of a file is then stored into a byte array.
+*
 * @param filename
 *        the name of the file to be read
-* @return the full content of the file, stored into a <code>byte</code>
+* @return the full content of the file, stored into a byte
 *         array
 * @throws IOException