com.github.wuic.util

Class IOUtils

java.lang.Object

com.github.wuic.util.IOUtils

public final class IOUtils
extends Object

Utility class built on top of the java.io package helping WUIC to deal with I/O.

Since:

0.3.1

Version:

1.6

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IOUtils.CrcMessageDigest A CRC32 is wrapped inside this class which is a MessageDigest.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STD_SEPARATOR The slash character is the standard separator used internally, even on windows platform.
static int	WUIC_BUFFER_LEN Length of a memory buffer used in WUIC.
static int	ZIP_MAGIC_NUMBER All ZIP files begins with this magic number.

Method Summary

Methods

Modifier and Type	Method and Description
static Path	buildPath(String path) Returns a hierarchy of paths represented by the given String.
static Path	buildPath(String path, DirectoryPathFactory factory) Returns a hierarchy of paths represented by the given String.
static void	close(Closeable... closeableArray) Tries to close the given objects and log the IOException at INFO level to make the code more readable when we assume that the IOException won't be managed.
static int	copyStream(InputStream is, OutputStream os) Copies the data from the given input stream into the given output stream and doesn't wrap any IOException.
static void	copyStreamToWriterIoe(InputStream is, Writer writer, String cs) Copies the data from the given input stream into the given writer and does not wrap the IOException.
static void	delete(File file) Deletes the File quietly.
static byte[]	digest(byte[]... bytes) Digests each byte array in the given array and return the corresponding signature.
static byte[]	digest(String... strings) Digests each String in the given array and return the corresponding signature.
static Boolean	isArchive(File file) Checks if the path path points to a a valid ZIP archive.
static Boolean	isArchive(InputStream inputStream) Checks if the given stream points represents a valid ZIP archive.
static List<String>	listFile(DirectoryPath parent, Pattern pattern) Lists all the files from the given directory matching the given pattern.
static List<String>	listFile(DirectoryPath parent, Pattern pattern, List<String> skipStartsWithList) Searches as specified in listFile(com.github.wuic.path.DirectoryPath, java.util.regex.Pattern) with a list that contains all begin paths to ignore.
static List<String>	listFile(DirectoryPath parent, String relativePath, Pattern pattern, List<String> skipStartsWithList) Lists the files matching the given pattern in the directory path and its subdirectory represented by a specified relativePath.
static List<String>	listFile(DirectoryPath parent, String relativePath, String endWith, List<String> skipStartsWithList) Lists the files ending with the given Sting in the directory path..
static String	mergePath(String... paths) Merges the given String array with the standard separator.
static MessageDigest	newMessageDigest() Returns a new MessageDigest based on CRC algorithm.
static String	normalizePathSeparator(String path) Makes sure a given path uses the slash character has path separator by replacing all backslashes.
static String	readString(InputStreamReader reader) Reads the given reader and returns its content in a String.

Methods inherited from class java.lang.Object

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

Field Detail

STD_SEPARATOR

public static final String STD_SEPARATOR

The slash character is the standard separator used internally, even on windows platform.

See Also:

Constant Field Values

WUIC_BUFFER_LEN

public static final int WUIC_BUFFER_LEN

Length of a memory buffer used in WUIC.

See Also:

Constant Field Values

ZIP_MAGIC_NUMBER

public static final int ZIP_MAGIC_NUMBER

All ZIP files begins with this magic number.

See Also:

Constant Field Values

Method Detail

newMessageDigest

public static MessageDigest newMessageDigest()

Returns a new MessageDigest based on CRC algorithm.

Returns:

the message digest

digest

public static byte[] digest(String... strings)

Digests each String in the given array and return the corresponding signature.

Parameters:

strings - the string array

Returns:

the digested bytes

digest

public static byte[] digest(byte[]... bytes)

Digests each byte array in the given array and return the corresponding signature.

Parameters:

bytes - the byte arrays

Returns:

the digested bytes

mergePath

public static String mergePath(String... paths)

Merges the given String array with the standard separator.

Parameters:

paths - the paths to be merged

Returns:

the merged paths

normalizePathSeparator

public static String normalizePathSeparator(String path)

Makes sure a given path uses the slash character has path separator by replacing all backslashes.

Parameters:

path - the path to normalize

Returns:

the normalized path

close

public static void close(Closeable... closeableArray)

Tries to close the given objects and log the IOException at INFO level to make the code more readable when we assume that the IOException won't be managed.

Also ignore null parameters.

Parameters:

closeableArray - the objects to close

readString

public static String readString(InputStreamReader reader)
                         throws IOException

Reads the given reader and returns its content in a String.

Parameters:

reader - the reader

Returns:

the content

Throws:

IOException - if an I/O error occurs

copyStreamToWriterIoe

public static void copyStreamToWriterIoe(InputStream is,
                         Writer writer,
                         String cs)
                                  throws IOException

Copies the data from the given input stream into the given writer and does not wrap the IOException.

Parameters:

is - the InputStream

writer - the Writer

cs - the charset to use to convert byte array to char array

Throws:

IOException - in an I/O error occurs

copyStream

public static int copyStream(InputStream is,
             OutputStream os)
                      throws IOException

Copies the data from the given input stream into the given output stream and doesn't wrap any IOException.

Parameters:

is - the InputStream

os - the OutputStream

Returns:

the content length

Throws:

IOException - in an I/O error occurs

isArchive

public static Boolean isArchive(File file)
                         throws IOException

Checks if the path path points to a a valid ZIP archive.

Parameters:

file - the path to check

Returns:

true if path is an archive, false otherwise

Throws:

IOException

isArchive

public static Boolean isArchive(InputStream inputStream)
                         throws IOException

Checks if the given stream points represents a valid ZIP archive.

Parameters:

inputStream - the stream to check

Returns:

true if the stream should be an archive, false otherwise

Throws:

IOException

listFile

public static List<String> listFile(DirectoryPath parent,
                    Pattern pattern)
                             throws IOException

Lists all the files from the given directory matching the given pattern.

For instance, if a directory /foo contains a path in foo/oof/path.js, calling this method with an Pattern .* will result in an array containing the String oof/path.js.

Parameters:

parent - the directory

pattern - the pattern to filter files

Returns:

the matching files

Throws:

IOException - if any I/O error occurs

listFile

public static List<String> listFile(DirectoryPath parent,
                    Pattern pattern,
                    List<String> skipStartsWithList)
                             throws IOException

Searches as specified in listFile(com.github.wuic.path.DirectoryPath, java.util.regex.Pattern) with a list that contains all begin paths to ignore.

Parameters:

parent - the directory

pattern - the pattern to filter files

skipStartsWithList - a list that contains all begin paths to ignore

Returns:

the matching files

Throws:

IOException - if any I/O error occurs

listFile

public static List<String> listFile(DirectoryPath parent,
                    String relativePath,
                    String endWith,
                    List<String> skipStartsWithList)
                             throws IOException

Lists the files ending with the given Sting in the directory path..

Parameters:

parent - the parent

relativePath - the directory path relative to the parent

endWith - the directory path relative to the parent

skipStartsWithList - a list that contains all begin paths to ignore

Returns:

the matching files

Throws:

IOException - if any I/O error occurs

listFile

public static List<String> listFile(DirectoryPath parent,
                    String relativePath,
                    Pattern pattern,
                    List<String> skipStartsWithList)
                             throws IOException

Lists the files matching the given pattern in the directory path and its subdirectory represented by a specified relativePath.

Parameters:

parent - the parent

relativePath - the directory path relative to the parent

pattern - the pattern which filters files

skipStartsWithList - a list that contains all begin paths to ignore

Returns:

the matching files

Throws:

IOException - if any I/O error occurs

buildPath

public static Path buildPath(String path,
             DirectoryPathFactory factory)
                      throws IOException

Returns a hierarchy of paths represented by the given String. The given DirectoryPathFactory is used to create directories.

Parameters:

path - the path hierarchy

factory - the factory.

Returns:

the last Path of the hierarchy with its parent

Throws:

IOException - if any I/O error occurs

buildPath

public static Path buildPath(String path)
                      throws IOException

Returns a hierarchy of paths represented by the given String. Uses a FsDirectoryPathFactory to create instances.

Parameters:

path - the path hierarchy

Returns:

the last Path of the hierarchy with its parent

Throws:

IOException - if any I/O error occurs

delete

public static void delete(File file)

Deletes the File quietly. The methods checks if the file is not null and calls itself recursively if the file is a directory.

Parameters:

file - the file or directory to delete