MFile (mhu-lib-core 3.2.9 API)

java.lang.Object
- de.mhus.lib.core.MFile

```
public class MFile
extends Object
```
MFile class.

Version:

$Id: $Id

Author:

hummel

Constructor Summary

Constructors
Constructor and Description

MFile()

Constructors
Constructor and Description
`MFile()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`copyDir(File _src, File _dest)` Copy a hole directory to another location.
`static void`	`copyDir(File _src, File _dest, FileFilter _filter)` copyDir.
`static void`	`copyDir(File _src, File _dest, String _filter)` Copy a directory with content.
`static void`	`copyDir(File _src, File _dest, String[] _filter)` copyDir.
`static boolean`	`copyFile(File _src, File _dest)` Copy a file.
`static void`	`copyFile(InputStream _is, OutputStream _os)` Copy a stream.
`static void`	`copyFile(Reader _is, Writer _os)` Copy a stream.
`static void`	`deleteDir(File _dir)` Remove a directory and all included content.
`static String`	`getFileName(String path)` Returns the name of the file in a path name.
`static String`	`getFileNameOnly(String key)` Returns the name without path and extension.
`static String`	`getFileSuffix(File _file)` Return the Suffix of a file.
`static String`	`getFileSuffix(String name)` Return the Suffix of a file.
`static String`	`getMimeType(String extension)` Searching for the mime type in config and as last option have a static list of extensions.
`static File`	`getWorkingDirectory()` return the internal working directory.
`static String`	`normalize(String name)` Return a name free from problematic characters like slash, they will be changed to underscore
`static byte[]`	`readBinary(InputStream is)` Open and read a stream.
`static byte[]`	`readBinary(InputStream is, boolean close)` Open and read a stream.
`static void`	`readBinary(InputStream is, byte[] buffer, int offset, int length)` Open and read a stream.
`static byte[]`	`readBinaryFile(File in)` Open and read a file.
`static String`	`readFile(File _f)` Open and read a file.
`static String`	`readFile(File _f, String encoding)` Open and read a file.
`static String`	`readFile(InputStream _is)` Open and read a stream.
`static String`	`readFile(InputStream _is, String encoding)` readFile.
`static String`	`readFile(Reader _is)` Open and read a file.
`static List<String>`	`readLines(File file, boolean removeLastEmpty)` Read a file into a list line by line
`static void`	`readLines(File file, Observer lineObserver)` readLines.
`static void`	`readLines(Reader r, Observer lineObserver)` readLines.
`static String`	`replaceExtension(String name, String newExtension)` Replace the Extension of the file
`static String`	`toFileName(String _name)` Normalize the filename, removes all special characters.
`static boolean`	`writeFile(File _f, byte[] _content)` Open and write the content of the byte array a file.
`static boolean`	`writeFile(File _f, String _content)` Open and write a file.
`static void`	`writeFile(OutputStream fos, byte[] _content, int offset, int length)` Write the byte array to the stream.
`static void`	`writeLines(File file, List<String> lines, boolean append)` Write a line list to a file.

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

- Constructor Detail
  - MFile
```
public MFile()
```
- Method Detail
  - getFileSuffix
```
public static String getFileSuffix(File _file)
```
    Return the Suffix of a file. Its the string after the last dot.
    
    Parameters:
    
    _file - a File object.
    
    Returns:
    
    a String object.
  - getFileSuffix
```
public static String getFileSuffix(String name)
```
    Return the Suffix of a file. Its the string after the last dot or an empty string.
    
    Parameters:
    
    name - a String object.
    
    Returns:
    
    a String object.
  - getFileName
```
public static String getFileName(String path)
```
    Returns the name of the file in a path name. Using the OS specific separator.
    
    Parameters:
    
    path - a String object.
    
    Returns:
    
    a String object.
  - getWorkingDirectory
```
public static File getWorkingDirectory()
```
    return the internal working directory.
    
    Returns:
    
    a File object.
  - readFile
```
public static String readFile(File _f)
```
    Open and read a file. It returns the content of the file as string.
    
    Parameters:
    
    _f - a File object.
    
    Returns:
    
    a String object.
  - readFile
```
public static String readFile(File _f,
                              String encoding)
```
    Open and read a file. It returns the content of the file as string.
    
    Parameters:
    
    _f - a File object.
    
    encoding - a String object.
    
    Returns:
    
    a String object.
    
    Since:
    
    3.2.9
  - readFile
```
public static String readFile(Reader _is)
```
    Open and read a file. It returns the content of the file as string.
    
    Parameters:
    
    _is - a Reader object.
    
    Returns:
    
    a String object.
  - readFile
```
public static String readFile(InputStream _is)
```
    Open and read a stream. It returns the content of the file as string. Be aware of special characters.
    
    Parameters:
    
    _is - a InputStream object.
    
    Returns:
    
    a String object.
  - readFile
```
public static String readFile(InputStream _is,
                              String encoding)
```
    readFile.
    
    Parameters:
    
    _is - a InputStream object.
    
    encoding - a String object.
    
    Returns:
    
    a String object.
    
    Since:
    
    3.2.9
  - readBinaryFile
```
public static byte[] readBinaryFile(File in)
                             throws IOException
```
    Open and read a file. It returns the content of the file as byte array.
    
    Parameters:
    
    in - a File object.
    
    Returns:
    
    an array of byte.
    
    Throws:
    
    IOException - if any.
  - readBinary
```
public static byte[] readBinary(InputStream is)
                         throws IOException
```
    Open and read a stream. It returns the content of the file as byte array.
    
    Parameters:
    
    is - a InputStream object.
    
    Returns:
    
    an array of byte.
    
    Throws:
    
    IOException - if any.
  - readBinary
```
public static byte[] readBinary(InputStream is,
                                boolean close)
                         throws IOException
```
    Open and read a stream. It returns the content of the file as byte array.
    
    Parameters:
    
    is - a InputStream object.
    
    close - a boolean.
    
    Returns:
    
    an array of byte.
    
    Throws:
    
    IOException - if any.
  - readBinary
```
public static void readBinary(InputStream is,
                              byte[] buffer,
                              int offset,
                              int length)
                       throws IOException
```
    Open and read a stream. It put the content of the file into the byte array.
    
    Parameters:
    
    is - a InputStream object.
    
    buffer - an array of byte.
    
    offset - a int.
    
    length - a int.
    
    Throws:
    
    IOException - if any.
  - writeFile
```
public static boolean writeFile(File _f,
                                String _content)
```
    Open and write a file. Be aware of special characters.
    
    Parameters:
    
    _f - a File object.
    
    _content - a String object.
    
    Returns:
    
    a boolean.
  - writeFile
```
public static boolean writeFile(File _f,
                                byte[] _content)
```
    Open and write the content of the byte array a file.
    
    Parameters:
    
    _f - a File object.
    
    _content - an array of byte.
    
    Returns:
    
    a boolean.
  - writeFile
```
public static void writeFile(OutputStream fos,
                             byte[] _content,
                             int offset,
                             int length)
                      throws IOException
```
    Write the byte array to the stream.
    
    Parameters:
    
    fos - a OutputStream object.
    
    _content - an array of byte.
    
    offset - a int.
    
    length - a int.
    
    Throws:
    
    IOException - if any.
  - copyFile
```
public static boolean copyFile(File _src,
                               File _dest)
```
    Copy a file.
    
    Parameters:
    
    _src - a File object.
    
    _dest - a File object.
    
    Returns:
    
    a boolean.
  - copyFile
```
public static void copyFile(InputStream _is,
                            OutputStream _os)
```
    Copy a stream.
    
    Parameters:
    
    _is - a InputStream object.
    
    _os - a OutputStream object.
  - copyFile
```
public static void copyFile(Reader _is,
                            Writer _os)
```
    Copy a stream.
    
    Parameters:
    
    _is - a Reader object.
    
    _os - a Writer object.
  - toFileName
```
public static String toFileName(String _name)
```
    Normalize the filename, removes all special characters.
    
    Parameters:
    
    _name - a String object.
    
    Returns:
    
    a String object.
  - deleteDir
```
public static void deleteDir(File _dir)
```
    Remove a directory and all included content.
    
    Parameters:
    
    _dir - a File object.
  - copyDir
```
public static void copyDir(File _src,
                           File _dest)
```
    Copy a hole directory to another location.
    
    Parameters:
    
    _src - a File object.
    
    _dest - a File object.
  - copyDir
```
public static void copyDir(File _src,
                           File _dest,
                           String _filter)
```
    Copy a directory with content. Use the filter to filter the content.
    
    Parameters:
    
    _src - a File object.
    
    _dest - a File object.
    
    _filter - a String object.
  - copyDir
```
public static void copyDir(File _src,
                           File _dest,
                           String[] _filter)
```
    copyDir.
    
    Parameters:
    
    _src - a File object.
    
    _dest - a File object.
    
    _filter - an array of String objects.
  - copyDir
```
public static void copyDir(File _src,
                           File _dest,
                           FileFilter _filter)
```
    copyDir.
    
    Parameters:
    
    _src - a File object.
    
    _dest - a File object.
    
    _filter - a FileFilter object.
  - normalize
```
public static String normalize(String name)
```
    Return a name free from problematic characters like slash, they will be changed to underscore
    
    Parameters:
    
    name - a String object.
    
    Returns:
    
    a String object.
  - getFileNameOnly
```
public static String getFileNameOnly(String key)
```
    Returns the name without path and extension.
    
    Parameters:
    
    key - a String object.
    
    Returns:
    
    a String object.
  - replaceExtension
```
public static String replaceExtension(String name,
                                      String newExtension)
```
    Replace the Extension of the file
    
    Parameters:
    
    name - a String object.
    
    newExtension - a String object.
    
    Returns:
    
    a String object.
  - getMimeType
```
public static String getMimeType(String extension)
```
    Searching for the mime type in config and as last option have a static list of extensions.
    
    Parameters:
    
    extension - a String object.
    
    Returns:
    
    a String object.
  - writeLines
```
public static void writeLines(File file,
                              List<String> lines,
                              boolean append)
                       throws IOException
```
    Write a line list to a file. Be aware of the ENTER \\n character in the lines ! Every line will be truncated by a ENTER \\n sign. This means the last line is empty.
    
    Parameters:
    
    file - a File object.
    
    lines - a List object.
    
    append - a boolean.
    
    Throws:
    
    IOException - if any.
  - readLines
```
public static List<String> readLines(File file,
                                     boolean removeLastEmpty)
                              throws IOException
```
    Read a file into a list line by line
    
    Parameters:
    
    file - a File object.
    
    removeLastEmpty - If you have written line by line the last ENTER will produce an empty line, set true to remove this line.
    
    Returns:
    
    a List object.
    
    Throws:
    
    IOException - if any.
  - readLines
```
public static void readLines(File file,
                             Observer lineObserver)
                      throws IOException
```
    readLines.
    
    Parameters:
    
    file - a File object.
    
    lineObserver - a Observer object.
    
    Throws:
    
    IOException - if any.
  - readLines
```
public static void readLines(Reader r,
                             Observer lineObserver)
                      throws IOException
```
    readLines.
    
    Parameters:
    
    r - a Reader object.
    
    lineObserver - a Observer object.
    
    Throws:
    
    IOException - if any.

Class MFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MFile

Method Detail

getFileSuffix

getFileSuffix

getFileName

getWorkingDirectory

readFile

readFile

readFile

readFile

readFile

readBinaryFile

readBinary

readBinary

readBinary

writeFile

writeFile

writeFile

copyFile

copyFile

copyFile

toFileName

deleteDir

copyDir

copyDir

copyDir

copyDir

normalize

getFileNameOnly

replaceExtension

getMimeType

writeLines

readLines

readLines

readLines