jhelp.util.io

Class UtilIO

java.lang.Object

jhelp.util.io.UtilIO

public final class UtilIO
extends java.lang.Object

Utilities for Input/Output streams

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE Buffer size
static java.lang.String	CURRENT_DIRECTORY Path that represents the current directory
static int	HEADER_SIZE Size of a file header
static int	KILO_BYTES One kilo-byte in bytes
static int	MEGA_BYTES One mega-byte in bytes
private static java.io.File	outsideDirectory Directory external of the code
static char	PATH_SEPARATOR Path separator used in URL, ZIP, JAR
static java.lang.String	PREVIOUS_DIRECTORY Path the represents the parent directory
private static java.io.File	temporaryDirectory Temporary directory

Constructor Summary

Constructors

Modifier	Constructor and Description
private	UtilIO() To avoid instance

Method Summary

Methods

Modifier and Type	Method and Description
static double	byteArrayToDouble(byte[] array) Create a double from a byte array.
static long	byteArrayToLong(byte[] array) Create a long from a byte array.
static java.math.BigInteger	computeBigIntegerSHA(java.io.InputStream inputStream) Compute the SHA code of a stream
static byte[]	computeByteArraySHA(java.io.InputStream inputStream) Compute SHA for a stream
static java.lang.String	computeMD5_SHA_ID(java.io.File file) Compute MD5 and SHA for a file, can be us as unique ID
static java.lang.String	computeMD5_SHA_ID(java.io.InputStream inputStream) Compute MD5 and SHA for a stream, can be us as unique ID
static java.lang.String	computeMD5(java.awt.image.BufferedImage bufferedImage) Compute MD5 of an image
static java.lang.String	computeMD5(java.io.File file) Compute MD5 of a file
static java.lang.String	computeMD5(java.io.InputStream inputStream) Compute MD5 for a stream
static java.lang.String	computeMD5(int[] data) Compute MD5 for an array of integer
static java.lang.String	computeRelativePath(java.io.File start, java.io.File destination) Compute relative path for go from a file to an other
static java.lang.String	computeSHA(java.io.File file) Compute SHA for a file
static java.lang.String	computeSHA(java.io.InputStream inputStream) Compute SHA for a stream
static void	copy(java.io.File source, java.io.File destination) Copy a file or directory.
static boolean	createDirectory(java.io.File directory) Create a directory and its parents if needs
static boolean	createFile(java.io.File file) Create a file and its parent directory if need
static java.io.File	createTemporaryFile(java.lang.String string) Create a temporary file.
static boolean	delete(java.io.File file) Delete a file or a directory.
static byte[]	doubleToByteArray(double d) Create a byte array from double.
static boolean	isVirtualLink(java.io.File file) Indicates if a file is a virtual link.
static byte[]	longToByteArray(long l) Create a byte array from long.
static java.io.File	obtainExternalFile(java.lang.String path) Obtain a file outside of the code.
static java.io.File	obtainFile(java.io.File directory, java.lang.String path) Obtain a file relative to a directory
static java.io.File	obtainFile(java.io.File directory, java.lang.String path, char separator) Obtain a file relative to a directory
static java.io.File	obtainOutsideDirectory() Obtain directory outside the code
static java.io.File	obtainTemporaryDirectory() Temporary directory
static java.math.BigInteger	readBigInteger(java.io.InputStream inputStream) Read a BigInteger from a stream.
static <B extends Binarizable> B	readBinarizable(java.lang.Class<B> clas, java.io.InputStream inputStream) Read a Binarizable inside a stream.
static <B extends Binarizable> B	readBinarizableNamed(java.io.InputStream inputStream) Read a Binarizable inside a stream.
static byte[]	readByteArray(java.io.InputStream inputStream) Read a byte array from stream
static double	readDouble(java.io.InputStream inputStream) Read double from stream
static byte[]	readFileHeader(java.io.File file) Read a file header (First bytes of a file)
static int	readInteger(java.io.InputStream inputStream) Read an integer from stream
static long	readLong(java.io.InputStream inputStream) Read long from stream
static int	readStream(java.io.InputStream inputStream, byte[] array) Read stream and fill an array.
static int	readStream(java.io.InputStream inputStream, byte[] array, int offset) Read stream and fill an array.
static int	readStream(java.io.InputStream inputStream, byte[] array, int offset, int length) Read stream and fill an array.
static java.lang.String	readString(java.io.InputStream inputStream) Read stream from stream
static void	rename(java.io.File source, java.io.File destination) Rename a file
static void	unzip(java.io.File directoryDestination, java.io.File zip) Unzip a file inside a directory
static void	unzip(java.io.File directoryDestination, java.io.InputStream inputStreamZip) Unzip a stream inside a directory
static void	write(java.io.File fileSource, java.io.File fileDestination) Copy a file inside an other one
static void	write(java.io.File fileSource, java.io.OutputStream outputStream) Write a file inside a stream
static void	write(java.io.InputStream inputStream, java.io.File fileDestination) Write a stream inside a file
static void	write(java.io.InputStream inputStream, java.io.OutputStream outputStream) Write a stream inside on other one
static void	writeBigInteger(java.math.BigInteger bigInteger, java.io.OutputStream outputStream) Write a BigInteger in stream.
static void	writeBinarizable(Binarizable binarizable, java.io.OutputStream outputStream) Write a Binarizable inside a stream.
static void	writeBinarizableNamed(Binarizable binarizable, java.io.OutputStream outputStream) Write a Binarizable inside a stream.
static void	writeByteArray(byte[] array, int offset, int length, java.io.OutputStream outputStream) Write a part of byte array on stream
static void	writeByteArray(byte[] array, java.io.OutputStream outputStream) Write an array on stream.
static void	writeDouble(double d, java.io.OutputStream outputStream) Write double in a stream
static void	writeInteger(int integer, java.io.OutputStream outputStream) Write an integer to stream
static void	writeLong(long integer, java.io.OutputStream outputStream) Write long in a stream
static void	writeString(java.lang.String string, java.io.OutputStream outputStream) Write string to stream
static void	zip(java.io.File source, java.io.File destination) Zip a file or directory inside a file
static void	zip(java.io.File source, java.io.OutputStream outputStreamZip) Zip a file or directory inside a stream

Methods inherited from class java.lang.Object

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

Field Detail

outsideDirectory

private static java.io.File outsideDirectory

Directory external of the code

temporaryDirectory

private static java.io.File temporaryDirectory

Temporary directory

BUFFER_SIZE

public static final int BUFFER_SIZE

Buffer size

See Also:

Constant Field Values

CURRENT_DIRECTORY

public static final java.lang.String CURRENT_DIRECTORY

Path that represents the current directory

See Also:

Constant Field Values

HEADER_SIZE

public static final int HEADER_SIZE

Size of a file header

See Also:

Constant Field Values

KILO_BYTES

public static final int KILO_BYTES

One kilo-byte in bytes

See Also:

Constant Field Values

MEGA_BYTES

public static final int MEGA_BYTES

One mega-byte in bytes

See Also:

Constant Field Values

PATH_SEPARATOR

public static final char PATH_SEPARATOR

Path separator used in URL, ZIP, JAR

See Also:

Constant Field Values

PREVIOUS_DIRECTORY

public static final java.lang.String PREVIOUS_DIRECTORY

Path the represents the parent directory

See Also:

Constant Field Values

Constructor Detail

UtilIO

private UtilIO()

To avoid instance

Method Detail

byteArrayToDouble

public static double byteArrayToDouble(byte[] array)

Create a double from a byte array.
Work good with byte array generated with doubleToByteArray(double)

Parameters:

array - Array to convert

Returns:

Double obtain

byteArrayToLong

public static long byteArrayToLong(byte[] array)

Create a long from a byte array.
Work good with byte array generated with longToByteArray(long)

Parameters:

array - Array to convert

Returns:

Long obtain

computeBigIntegerSHA

public static java.math.BigInteger computeBigIntegerSHA(java.io.InputStream inputStream)
                                                 throws java.security.NoSuchAlgorithmException,
                                                        java.io.IOException

Compute the SHA code of a stream

Parameters:

inputStream - Stream to read

Returns:

SHA code

Throws:

java.security.NoSuchAlgorithmException - If SHA not implemented (Should never append, its java base algorithm)

java.io.IOException - On reading issue

computeByteArraySHA

public static byte[] computeByteArraySHA(java.io.InputStream inputStream)
                                  throws java.security.NoSuchAlgorithmException,
                                         java.io.IOException

Compute SHA for a stream

Parameters:

inputStream - Stream to read

Returns:

MD5 of the stream

Throws:

java.security.NoSuchAlgorithmException - If system not support SHA

java.io.IOException - On reading stream issue

computeMD5

public static java.lang.String computeMD5(java.awt.image.BufferedImage bufferedImage)
                                   throws java.security.NoSuchAlgorithmException,
                                          java.io.IOException

Compute MD5 of an image

Parameters:

bufferedImage - Image to compute it's MD5

Returns:

Image MD5

Throws:

java.security.NoSuchAlgorithmException - If system not support MD5

java.io.IOException - On reading image issue

computeMD5

public static java.lang.String computeMD5(java.io.File file)
                                   throws java.security.NoSuchAlgorithmException,
                                          java.io.IOException

Compute MD5 of a file

Parameters:

file - File to compute its MD5

Returns:

Computed MD5

Throws:

java.security.NoSuchAlgorithmException - If system not support MD5

java.io.IOException - On reading file issue

computeMD5

public static java.lang.String computeMD5(java.io.InputStream inputStream)
                                   throws java.security.NoSuchAlgorithmException,
                                          java.io.IOException

Compute MD5 for a stream

Parameters:

inputStream - Stream to read

Returns:

MD5 of the stream

Throws:

java.security.NoSuchAlgorithmException - If system not support MD5

java.io.IOException - On reading stream issue

computeMD5

public static java.lang.String computeMD5(int[] data)
                                   throws java.security.NoSuchAlgorithmException,
                                          java.io.IOException

Compute MD5 for an array of integer

Parameters:

data - Array to compute its MD5

Returns:

Array MD5

Throws:

java.security.NoSuchAlgorithmException - If system not support MD5

java.io.IOException - On reading array issue

computeMD5_SHA_ID

public static java.lang.String computeMD5_SHA_ID(java.io.File file)
                                          throws java.security.NoSuchAlgorithmException,
                                                 java.io.IOException

Compute MD5 and SHA for a file, can be us as unique ID

Parameters:

file - File to read

Returns:

MD5, SHA pair unique ID of the file

Throws:

java.security.NoSuchAlgorithmException - If system not support MD5 or SHA

java.io.IOException - On reading stream issue

computeMD5_SHA_ID

public static java.lang.String computeMD5_SHA_ID(java.io.InputStream inputStream)
                                          throws java.security.NoSuchAlgorithmException,
                                                 java.io.IOException

Compute MD5 and SHA for a stream, can be us as unique ID

Parameters:

inputStream - Stream to read

Returns:

MD5, SHA pair unique ID of the stream

Throws:

java.security.NoSuchAlgorithmException - If system not support MD5 or SHA

java.io.IOException - On reading stream issue

computeRelativePath

public static java.lang.String computeRelativePath(java.io.File start,
                                   java.io.File destination)

Compute relative path for go from a file to an other

Parameters:

start - Start file

destination - Destination file

Returns:

Relative path

computeSHA

public static java.lang.String computeSHA(java.io.File file)
                                   throws java.security.NoSuchAlgorithmException,
                                          java.io.IOException

Compute SHA for a file

Parameters:

file - File to read

Returns:

SHA of the file

Throws:

java.security.NoSuchAlgorithmException - If system not support SHA

java.io.IOException - On reading stream issue

computeSHA

public static java.lang.String computeSHA(java.io.InputStream inputStream)
                                   throws java.security.NoSuchAlgorithmException,
                                          java.io.IOException

Compute SHA for a stream

Parameters:

inputStream - Stream to read

Returns:

MD5 of the stream

Throws:

java.security.NoSuchAlgorithmException - If system not support SHA

java.io.IOException - On reading stream issue

copy

public static void copy(java.io.File source,
        java.io.File destination)
                 throws java.io.IOException

Copy a file or directory. If directory, all content and sub-directory are copied

Parameters:

source - File or directory source

destination - File or directory destination

Throws:

java.io.IOException - On coping issue

createDirectory

public static boolean createDirectory(java.io.File directory)

Create a directory and its parents if needs

Parameters:

directory - Directory to create

Returns:

true if creation succeed. false if failed

createFile

public static boolean createFile(java.io.File file)

Create a file and its parent directory if need

Parameters:

file - File to create

Returns:

true if creation succeed. false if failed

createTemporaryFile

public static java.io.File createTemporaryFile(java.lang.String string)
                                        throws java.io.IOException

Create a temporary file.
That is to say, a file inside the temporary directory

Parameters:

string - File name

Returns:

Created file

Throws:

java.io.IOException - On creation issue

delete

public static boolean delete(java.io.File file)

Delete a file or a directory.
If it is a directory, its delete all children first

Parameters:

file - File/directory to delete

Returns:

true if succeed. false if failed, may be some deletion have happen

doubleToByteArray

public static byte[] doubleToByteArray(double d)

Create a byte array from double.
Can be revert with byteArrayToDouble(byte[])

Parameters:

d - Double to convert

Returns:

Byte array created

isVirtualLink

public static boolean isVirtualLink(java.io.File file)

Indicates if a file is a virtual link.
A virtual link in Linux system is a way to have a reference to a file/directory as if it is in place, but the real file is other place. It is a way to share the same file by several directory

Parameters:

file - File to test

Returns:

true if it is a virtual link

longToByteArray

public static byte[] longToByteArray(long l)

Create a byte array from long.
Can be revert with byteArrayToLong(byte[])

Parameters:

l - Long to convert

Returns:

Byte array created

obtainExternalFile

public static java.io.File obtainExternalFile(java.lang.String path)

Obtain a file outside of the code.
If this class is in a jar called A.jar, and this jar is in /My/Path/A.jar then the file will be relative to /My/Path

Parameters:

path - Relative path

Returns:

The file

obtainFile

public static java.io.File obtainFile(java.io.File directory,
                      java.lang.String path)

Obtain a file relative to a directory

Parameters:

directory - Directory reference

path - Path search

Returns:

The file

obtainFile

public static java.io.File obtainFile(java.io.File directory,
                      java.lang.String path,
                      char separator)

Obtain a file relative to a directory

Parameters:

directory - Directory reference

path - Path search

separator - Separator use inside the path

Returns:

The file

obtainOutsideDirectory

public static java.io.File obtainOutsideDirectory()

Obtain directory outside the code

Returns:

Directory outside the code

obtainTemporaryDirectory

public static java.io.File obtainTemporaryDirectory()

Temporary directory

Returns:

Temporary directory

readBigInteger

public static java.math.BigInteger readBigInteger(java.io.InputStream inputStream)
                                           throws java.io.IOException

Read a BigInteger from a stream.
Previously write with writeBigInteger(BigInteger, OutputStream)

Parameters:

inputStream - Stream to read

Returns:

BigInteger read

Throws:

java.io.IOException - On reading issue

readBinarizable

public static <B extends Binarizable> B readBinarizable(java.lang.Class<B> clas,
                                        java.io.InputStream inputStream)
                                             throws java.io.IOException

Read a Binarizable inside a stream.
The Binarizable should be previously written by writeBinarizable(Binarizable, OutputStream)

Type Parameters:

B - Binarizable type

Parameters:

clas - Class of the Binarizable

inputStream - Stream to read

Returns:

The Binarizable read

Throws:

java.io.IOException - On read the stream or the data not represents the asked Binarizable

readBinarizableNamed

public static <B extends Binarizable> B readBinarizableNamed(java.io.InputStream inputStream)
                                                  throws java.io.IOException

Read a Binarizable inside a stream.
The Binarizable should be previously written by writeBinarizableNamed(Binarizable, OutputStream)

Type Parameters:

B - Binarizable type

Parameters:

inputStream - Stream to read

Returns:

The Binarizable read

Throws:

java.io.IOException - On read the stream or the data not represents the asked Binarizable

readByteArray

public static byte[] readByteArray(java.io.InputStream inputStream)
                            throws java.io.IOException

Read a byte array from stream

Parameters:

inputStream - Stream to read

Returns:

Read array

Throws:

java.io.IOException - On reading issue

readDouble

public static double readDouble(java.io.InputStream inputStream)
                         throws java.io.IOException

Read double from stream

Parameters:

inputStream - Stream to read

Returns:

Read double

Throws:

java.io.IOException - On reading problem

readFileHeader

public static byte[] readFileHeader(java.io.File file)
                             throws java.io.IOException

Read a file header (First bytes of a file)

Parameters:

file - File to read header

Returns:

Header read

Throws:

java.io.IOException - On reading issue

readInteger

public static int readInteger(java.io.InputStream inputStream)
                       throws java.io.IOException

Read an integer from stream

Parameters:

inputStream - Stream to read

Returns:

Integer read

Throws:

java.io.IOException - On reading issue

readLong

public static long readLong(java.io.InputStream inputStream)
                     throws java.io.IOException

Read long from stream

Parameters:

inputStream - Stream to read

Returns:

Read long

Throws:

java.io.IOException - On reading problem

readStream

public static int readStream(java.io.InputStream inputStream,
             byte[] array)
                      throws java.io.IOException

Read stream and fill an array.
The write in array start at begin.
It stop to read stream if stream reach its end or the array is full.
Do same as readStream(inputStream, array, 0, array.length)

Parameters:

inputStream - Stream to read

array - Array to fill

Returns:

Number of bytes read (It can be less than array length if stream have not enough data to fill totaly the array)

Throws:

java.io.IOException - On reading issue

readStream

public static int readStream(java.io.InputStream inputStream,
             byte[] array,
             int offset)
                      throws java.io.IOException

Read stream and fill an array.
The write in array start at the offset specify.
It stop to read stream if stream reach its end or the array is full
Do same as readStream(inputStream, array, offset, array.length - offset)

Parameters:

inputStream - Stream to read

array - Array to fill

offset - To start writing

Returns:

Number of bytes read (It can be less than array length if stream have not enough data to fill totaly the array)

Throws:

java.io.IOException - On reading issue

readStream

public static int readStream(java.io.InputStream inputStream,
             byte[] array,
             int offset,
             int length)
                      throws java.io.IOException

Read stream and fill an array.
The write in array start at the offset specify.
It stop to read stream if stream reach its end or the specify length is reach

Parameters:

inputStream - Stream to read

array - Array to fill

offset - To start writing

length - Number of bytes to read at maximum

Returns:

Number of bytes read (It can be less than specify length if stream have not enough data to respect the length)

Throws:

java.io.IOException - On reading issue

readString

public static java.lang.String readString(java.io.InputStream inputStream)
                                   throws java.io.IOException

Read stream from stream

Parameters:

inputStream - Stream to read

Returns:

Read string

Throws:

java.io.IOException - On reading issue

rename

public static void rename(java.io.File source,
          java.io.File destination)
                   throws java.io.IOException

Rename a file

Parameters:

source - File source

destination - File destination

Throws:

java.io.IOException - On rename issue

unzip

public static void unzip(java.io.File directoryDestination,
         java.io.File zip)
                  throws java.io.IOException

Unzip a file inside a directory

Parameters:

directoryDestination - Directory where unzip

zip - Zip file

Throws:

java.io.IOException - On extracting issue

unzip

public static void unzip(java.io.File directoryDestination,
         java.io.InputStream inputStreamZip)
                  throws java.io.IOException

Unzip a stream inside a directory

Parameters:

directoryDestination - Directory where unzip

inputStreamZip - Stream to unzip

Throws:

java.io.IOException - On unzipping issue

write

public static void write(java.io.File fileSource,
         java.io.File fileDestination)
                  throws java.io.IOException

Copy a file inside an other one

Parameters:

fileSource - Source file

fileDestination - Destination file

Throws:

java.io.IOException - On copying issue

write

public static void write(java.io.File fileSource,
         java.io.OutputStream outputStream)
                  throws java.io.IOException

Write a file inside a stream

Parameters:

fileSource - Source file

outputStream - Stream where write

Throws:

java.io.IOException - On copying issue

write

public static void write(java.io.InputStream inputStream,
         java.io.File fileDestination)
                  throws java.io.IOException

Write a stream inside a file

Parameters:

inputStream - Stream source

fileDestination - File destination

Throws:

java.io.IOException - On copying issue

write

public static void write(java.io.InputStream inputStream,
         java.io.OutputStream outputStream)
                  throws java.io.IOException

Write a stream inside on other one

Parameters:

inputStream - Stream source

outputStream - Stream destination

Throws:

java.io.IOException - On copying issue

writeBigInteger

public static void writeBigInteger(java.math.BigInteger bigInteger,
                   java.io.OutputStream outputStream)
                            throws java.io.IOException

Write a BigInteger in stream.
To read later, you can use readBigInteger(InputStream)

Parameters:

bigInteger - BigInteger to write

outputStream - Stream where write

Throws:

java.io.IOException - On writing issue

writeBinarizable

public static void writeBinarizable(Binarizable binarizable,
                    java.io.OutputStream outputStream)
                             throws java.io.IOException

Write a Binarizable inside a stream.
To read it later, use readBinarizable(Class, InputStream)

Parameters:

binarizable - Binarizable to write

outputStream - Stream where write

Throws:

java.io.IOException - On writing issue

writeBinarizableNamed

public static void writeBinarizableNamed(Binarizable binarizable,
                         java.io.OutputStream outputStream)
                                  throws java.io.IOException

Write a Binarizable inside a stream.
To read it later, use readBinarizableNamed(InputStream)

Parameters:

binarizable - Binarizable to write

outputStream - Stream where write

Throws:

java.io.IOException - On writing issue

writeByteArray

public static void writeByteArray(byte[] array,
                  int offset,
                  int length,
                  java.io.OutputStream outputStream)
                           throws java.io.IOException

Write a part of byte array on stream

Parameters:

array - Array to write

offset - Offset where start read the array

length - Number of byte to write

outputStream - Stream where write

Throws:

java.io.IOException - On writing issue

writeByteArray

public static void writeByteArray(byte[] array,
                  java.io.OutputStream outputStream)
                           throws java.io.IOException

Write an array on stream.
Same as writeByteArray(array, 0, array.length, outputStream)

Parameters:

array - Array to write

outputStream - Stream where write

Throws:

java.io.IOException - On writing issue

writeDouble

public static void writeDouble(double d,
               java.io.OutputStream outputStream)
                        throws java.io.IOException

Write double in a stream

Parameters:

d - Double to write

outputStream - Stream where write

Throws:

java.io.IOException - On writing problem

writeInteger

public static void writeInteger(int integer,
                java.io.OutputStream outputStream)
                         throws java.io.IOException

Write an integer to stream

Parameters:

integer - Integer to write

outputStream - Stream where write

Throws:

java.io.IOException - On writing issue

writeLong

public static void writeLong(long integer,
             java.io.OutputStream outputStream)
                      throws java.io.IOException

Write long in a stream

Parameters:

integer - Long to write

outputStream - Stream where write

Throws:

java.io.IOException - On writing problem

writeString

public static void writeString(java.lang.String string,
               java.io.OutputStream outputStream)
                        throws java.io.IOException

Write string to stream

Parameters:

string - String to write

outputStream - Stream where write

Throws:

java.io.IOException - On writing issue

zip

public static void zip(java.io.File source,
       java.io.File destination)
                throws java.io.IOException

Zip a file or directory inside a file

Parameters:

source - File/directory to zip

destination - File destination

Throws:

java.io.IOException - On zipping issue

zip

public static void zip(java.io.File source,
       java.io.OutputStream outputStreamZip)
                throws java.io.IOException

Zip a file or directory inside a stream

Parameters:

source - File/directory to zip

outputStreamZip - Where write the zip

Throws:

java.io.IOException - On zipping issue