FileHelper (exense Commons 1.0.0 API)

java.lang.Object
- ch.exense.commons.io.FileHelper

```
public class FileHelper
extends Object
```

Constructor Summary

Constructors
Constructor and Description

FileHelper()

Constructors
Constructor and Description
`FileHelper()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`protected static long`	`computeLastModification(File file)`
`protected static long`	`computeLastModificationDateRecursive(File file)`
`static void`	`copy(InputStream input, OutputStream output)` Copy a `InputStream` to an `OutputStream` using a buffer size of 2048
`static void`	`copy(InputStream input, OutputStream output, int bufferSize)` Copy a `InputStream` to an `OutputStream`
`static File`	`createTempFile()` Creates a temporary file that will be deleted on JVM exit
`static File`	`createTempFolder()` Creates a temporary folder
`static File`	`createTempFolder(String prefix)` Creates a temporary folder
`static void`	`deleteFolder(File folder)` Deletes a folder recursively
`static void`	`deleteFolderOnExit(File folder)` Requests that the directory denoted by this abstract pathname be deleted recursively when the virtual machine terminates
`static File`	`extractResourceToTempFile(Class<?> clazz, String resourceName)` Extract a resource and copy it to a a temporary file
`static File`	`getClassLoaderResourceAsFile(ClassLoader classLoader, String resourceName)`
`static long`	`getLastModificationDateRecursive(File file)` Computes the last modification date of a file or a folder recursively
`static String`	`readClassLoaderResource(ClassLoader classLoader, String resourceName)` Reads a classloader resource using UTF8 charset
`static byte[]`	`readClassLoaderResourceAsByteArray(ClassLoader classLoader, String resourceName)` Reads a classloader resource and returns its content as byte array
`static String`	`readResource(Class<?> clazz, String resourceName)` Reads a resource using UTF8 charset
`static byte[]`	`readResourceAsByteArray(Class<?> clazz, String resourceName)` Reads a resource and returns its content as byte array
`static String`	`readStream(InputStream is)` Reads the stream provided as argument using UTF8 charset
`static void`	`unzip(byte[] bytes, File target)` Extracts the zip provided as byte array to the target folder provided as argument
`static void`	`unzip(File zipFile, File target)` Extracts the zip file to the target folder provided as argument
`static void`	`unzip(InputStream stream, File target)` Extracts the zip provided as stream to the target folder provided as argument
`static byte[]`	`zip(File directory)` Create a zip file of the directory denoted by the `File` passed as argument
`static void`	`zip(File directory, File target)` Create a zip file of the directory denoted by the `File` passed as argument
`static void`	`zip(File directory, OutputStream out)` Create a zip file of the directory denoted by the `File` passed as argument

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileHelper
```
public FileHelper()
```
- Method Detail
  - createTempFile
```
public static File createTempFile()
                           throws IOException
```
    Creates a temporary file that will be deleted on JVM exit
    
    Returns:
    
    the File of the temporary file
    
    Throws:
    
    IOException
  - createTempFolder
```
public static File createTempFolder()
                             throws IOException
```
    Creates a temporary folder
    
    Throws:
    
    IOException
  - createTempFolder
```
public static File createTempFolder(String prefix)
                             throws IOException
```
    Creates a temporary folder
    
    Parameters:
    
    prefix - the prefix string to be used in generating the folder's name
    
    Returns:
    
    the File of the temporary folder
    
    Throws:
    
    IOException
  - deleteFolder
```
public static void deleteFolder(File folder)
```
    Deletes a folder recursively
    
    Parameters:
    
    folder - the File to be deleted
  - deleteFolderOnExit
```
public static void deleteFolderOnExit(File folder)
```
    Requests that the directory denoted by this abstract pathname be deleted recursively when the virtual machine terminates
    
    Parameters:
    
    folder - the File to be deleted
  - getLastModificationDateRecursive
```
public static final long getLastModificationDateRecursive(File file)
```
    Computes the last modification date of a file or a folder recursively
    
    Parameters:
    
    file -
    
    Returns:
    
    the time that the file was last modified.
  - computeLastModification
```
protected static final long computeLastModification(File file)
```
  - computeLastModificationDateRecursive
```
protected static final long computeLastModificationDateRecursive(File file)
```
  - unzip
```
public static void unzip(File zipFile,
                         File target)
                  throws IOException
```
    Extracts the zip file to the target folder provided as argument
    
    Parameters:
    
    zipFile - the zip file to be extracted
    
    target - the target folder to extract to
    
    Throws:
    
    IOException
  - unzip
```
public static void unzip(byte[] bytes,
                         File target)
                  throws IOException
```
    Extracts the zip provided as byte array to the target folder provided as argument
    
    Parameters:
    
    bytes - the byte array of the zip to be extracted
    
    target - the target folder to extract to
    
    Throws:
    
    IOException
  - unzip
```
public static void unzip(InputStream stream,
                         File target)
                  throws IOException
```
    Extracts the zip provided as stream to the target folder provided as argument
    
    Parameters:
    
    stream - the InputStream of the zip to be extracted
    
    target - the target folder to extract to
    
    Throws:
    
    IOException
  - zip
```
public static final void zip(File directory,
                             File target)
                      throws IOException
```
    Create a zip file of the directory denoted by the File passed as argument
    
    Parameters:
    
    directory - the directory to be zipped
    
    target - the path to the target zip file
    
    Throws:
    
    IOException
  - zip
```
public static final void zip(File directory,
                             OutputStream out)
                      throws IOException
```
    Create a zip file of the directory denoted by the File passed as argument
    
    Parameters:
    
    directory - the directory to be zipped
    
    out - the output stream of the target zip file
    
    Throws:
    
    IOException
  - zip
```
public static final byte[] zip(File directory)
                        throws IOException
```
    Create a zip file of the directory denoted by the File passed as argument
    
    Parameters:
    
    directory - the directory to be zipped
    
    Returns:
    
    the byte array of the target zip
    
    Throws:
    
    IOException
  - readStream
```
public static String readStream(InputStream is)
```
    Reads the stream provided as argument using UTF8 charset
    
    Parameters:
    
    is - the stream to be read
    
    Returns:
    
    the content of the stream
  - readResource
```
public static String readResource(Class<?> clazz,
                                  String resourceName)
```
    Reads a resource using UTF8 charset
    
    Parameters:
    
    clazz - the class the resource is associated with
    
    resourceName - the name of the resource
    
    Returns:
    
    the content of the resource
  - readClassLoaderResource
```
public static String readClassLoaderResource(ClassLoader classLoader,
                                             String resourceName)
```
    Reads a classloader resource using UTF8 charset
    
    Parameters:
    
    classLoader - the classloader to access the resource
    
    resourceName - the name of the resource
    
    Returns:
    
    the content of the resource
  - readResourceAsByteArray
```
public static byte[] readResourceAsByteArray(Class<?> clazz,
                                             String resourceName)
                                      throws IOException
```
    Reads a resource and returns its content as byte array
    
    Parameters:
    
    clazz - the class the resource is associated with
    
    resourceName - the name of the resource
    
    Returns:
    
    the content of the resource as byte array
    
    Throws:
    
    IOException
  - readClassLoaderResourceAsByteArray
```
public static byte[] readClassLoaderResourceAsByteArray(ClassLoader classLoader,
                                                        String resourceName)
                                                 throws IOException
```
    Reads a classloader resource and returns its content as byte array
    
    Parameters:
    
    classLoader - the classloader to access the resource
    
    resourceName - the name of the resource
    
    Returns:
    
    the content of the resource as byte array
    
    Throws:
    
    IOException
  - getClassLoaderResourceAsFile
```
public static File getClassLoaderResourceAsFile(ClassLoader classLoader,
                                                String resourceName)
```
    Parameters:
    
    classLoader - the classloader to access the resource
    
    resourceName - the name of the resource
    
    Returns:
    
    the resource as File
  - extractResourceToTempFile
```
public static File extractResourceToTempFile(Class<?> clazz,
                                             String resourceName)
                                      throws IOException
```
    Extract a resource and copy it to a a temporary file
    
    Parameters:
    
    clazz - the class the resource is associated with
    
    resourceName - the name of the resource
    
    Returns:
    
    the temporary File
    
    Throws:
    
    IOException
  - copy
```
public static void copy(InputStream input,
                        OutputStream output)
                 throws IOException
```
    Copy a InputStream to an OutputStream using a buffer size of 2048
    
    Parameters:
    
    input - the InputStream to be read
    
    output - the target OutputStream
    
    Throws:
    
    IOException
  - copy
```
public static void copy(InputStream input,
                        OutputStream output,
                        int bufferSize)
                 throws IOException
```
    Copy a InputStream to an OutputStream
    
    Parameters:
    
    input - the InputStream to be read
    
    output - the target OutputStream
    
    bufferSize - the buffersize to be used
    
    Throws:
    
    IOException

Class FileHelper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileHelper

Method Detail

createTempFile

createTempFolder

createTempFolder

deleteFolder

deleteFolderOnExit

getLastModificationDateRecursive

computeLastModification

computeLastModificationDateRecursive

unzip

unzip

unzip

zip

zip

zip

readStream

readResource

readClassLoaderResource

readResourceAsByteArray

readClassLoaderResourceAsByteArray

getClassLoaderResourceAsFile

extractResourceToTempFile

copy

copy