ReadFileExtensions (file-worker 4.21 API)

java.lang.Object
- de.alpharogroup.file.read.ReadFileExtensions

```
public final class ReadFileExtensions
extends Object
```
The class ReadFileExtensions helps you reading files.

Version:

1.0

Author:

Asterios Raptis

Constructor Summary

Constructors
Constructor and Description

ReadFileExtensions()

Constructors
Constructor and Description
`ReadFileExtensions()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Byte[]`	`getFilecontentAsByteObjectArray(File tmpFile)` Get a Byte array from the given file.
`static String`	`inputStream2String(InputStream inputStream)` The Method inputStream2String() reads the data from the InputStream into a String.
`static String`	`inputStream2String(InputStream inputStream, Charset encoding)` The Method inputStream2String() reads the data from the InputStream into a String.
`static Reader`	`openFileReader(String fileName)` The Method openFileReader() opens a BufferedReader from the given file.
`static String`	`reader2String(Reader reader)` The Method reader2String() reads the data from the Reader into a String.
`static byte[]`	`readFileToBytearray(File file)` Get a byte array from the given file.
`static String`	`readFromFile(File file)` The Method readFromFile() reads the filecontent to a String.
`static String`	`readFromFile(File file, Charset encoding)` Read from file.
`static String`	`readHeadLine(String inputFile)` The Method readHeadLine() opens the File and reads the first line from the file.
`static List<String>`	`readLinesInList(File input)` Reads every line from the File and puts them to the List.
`static List<String>`	`readLinesInList(File input, boolean trim)` Reads every line from the File and puts them to the List.
`static List<String>`	`readLinesInList(File input, Charset encoding)` Reads every line from the File and puts them to the List.
`static List<String>`	`readLinesInList(File input, Charset encoding, boolean trim)` Reads every line from the File and puts them to the List.
`static List<String>`	`readLinesInList(InputStream input)` Reads every line from the given InputStream and puts them to the List.
`static List<String>`	`readLinesInList(InputStream input, boolean trim)` Reads every line from the given InputStream and puts them to the List.
`static List<String>`	`readLinesInList(InputStream input, Charset encoding, boolean trim)` Reads every line from the given InputStream and puts them to the List.
`static Properties`	`readPropertiesFromFile(String filename)` The Method readFromFile(String) reads from the properties-file all Properties and saves them into a Properties-Object.
`static byte[]`	`toByteArray(File tmpFile)` Get a byte array from the given file.
`static byte[]`	`toByteArray(InputStream input)` Get a byte array from the given `InputStream`.

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

- Constructor Detail
  - ReadFileExtensions
```
public ReadFileExtensions()
```
- Method Detail
  - getFilecontentAsByteObjectArray
```
public static Byte[] getFilecontentAsByteObjectArray(File tmpFile)
                                              throws IOException
```
    Get a Byte array from the given file.
    
    Parameters:
    
    tmpFile - the tmp file
    
    Returns:
    
    the filecontent as Byte array object.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - inputStream2String
```
public static String inputStream2String(InputStream inputStream)
                                 throws IOException
```
    The Method inputStream2String() reads the data from the InputStream into a String.
    
    Parameters:
    
    inputStream - The InputStream from where we read.
    
    Returns:
    
    The String that we read from the InputStream.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - inputStream2String
```
public static String inputStream2String(InputStream inputStream,
                                        Charset encoding)
                                 throws IOException
```
    The Method inputStream2String() reads the data from the InputStream into a String.
    
    Parameters:
    
    inputStream - The InputStream from where we read.
    
    encoding - the encoding
    
    Returns:
    
    The String that we read from the InputStream.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - openFileReader
```
public static Reader openFileReader(String fileName)
                             throws IOException
```
    The Method openFileReader() opens a BufferedReader from the given file.
    
    Parameters:
    
    fileName - The file from where to read.
    
    Returns:
    
    The opened BufferedReader from the specified file.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - reader2String
```
public static String reader2String(Reader reader)
                            throws IOException
```
    The Method reader2String() reads the data from the Reader into a String.
    
    Note: Reader will not be closed.
    
    Parameters:
    
    reader - The Reader from where we read.
    
    Returns:
    
    The String that we read from the Reader.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - readFileToBytearray
```
public static byte[] readFileToBytearray(File file)
                                  throws IOException
```
    Get a byte array from the given file.
    
    Parameters:
    
    file - The file.
    
    Returns:
    
    Returns a byte array or null.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - readFromFile
```
public static String readFromFile(File file)
                           throws IOException
```
    The Method readFromFile() reads the filecontent to a String.
    
    Parameters:
    
    file - The File to read to a String.
    
    Returns:
    
    The String from the File.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - readFromFile
```
public static String readFromFile(File file,
                                  Charset encoding)
                           throws IOException
```
    Read from file.
    
    Parameters:
    
    file - the file
    
    encoding - the encoding
    
    Returns:
    
    the string
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - readHeadLine
```
public static String readHeadLine(String inputFile)
                           throws FileNotFoundException,
                                  IOException
```
    The Method readHeadLine() opens the File and reads the first line from the file.
    
    Parameters:
    
    inputFile - The Path to the File and name from the file from where we read.
    
    Returns:
    
    The first line from the file.
    
    Throws:
    
    FileNotFoundException - the file not found exception
    
    IOException - Signals that an I/O exception has occurred.
  - readLinesInList
```
public static List<String> readLinesInList(File input)
                                    throws FileNotFoundException,
                                           IOException
```
    Reads every line from the File and puts them to the List.
    
    Parameters:
    
    input - The File from where the input comes.
    
    Returns:
    
    The List with all lines from the file.
    
    Throws:
    
    FileNotFoundException - is thrown if the given file is not found.
    
    IOException - Signals that an I/O exception has occurred.
  - readLinesInList
```
public static List<String> readLinesInList(File input,
                                           boolean trim)
                                    throws FileNotFoundException,
                                           IOException
```
    Reads every line from the File and puts them to the List.
    
    Parameters:
    
    input - The File from where the input comes.
    
    trim - the flag trim if the lines shell be trimed.
    
    Returns:
    
    The List with all lines from the file.
    
    Throws:
    
    FileNotFoundException - is thrown if the given file is not found.
    
    IOException - Signals that an I/O exception has occurred.
  - readLinesInList
```
public static List<String> readLinesInList(File input,
                                           Charset encoding)
                                    throws FileNotFoundException,
                                           IOException
```
    Reads every line from the File and puts them to the List.
    
    Parameters:
    
    input - The File from where the input comes.
    
    encoding - the encoding
    
    Returns:
    
    The List with all lines from the file.
    
    Throws:
    
    FileNotFoundException - is thrown if the given file is not found.
    
    IOException - When a io-problem occurs.
  - readLinesInList
```
public static List<String> readLinesInList(File input,
                                           Charset encoding,
                                           boolean trim)
                                    throws FileNotFoundException,
                                           IOException
```
    Reads every line from the File and puts them to the List.
    
    Parameters:
    
    input - The File from where the input comes.
    
    encoding - the charset for read
    
    trim - the flag trim if the lines shell be trimed.
    
    Returns:
    
    The List with all lines from the file.
    
    Throws:
    
    FileNotFoundException - is thrown if the given file is not found.
    
    IOException - When a io-problem occurs.
  - readLinesInList
```
public static List<String> readLinesInList(InputStream input)
                                    throws IOException
```
    Reads every line from the given InputStream and puts them to the List.
    
    Parameters:
    
    input - The InputStream from where the input comes.
    
    Returns:
    
    The List with all lines from the file.
    
    Throws:
    
    IOException - When a io-problem occurs.
  - readLinesInList
```
public static List<String> readLinesInList(InputStream input,
                                           boolean trim)
                                    throws IOException
```
    Reads every line from the given InputStream and puts them to the List.
    
    Parameters:
    
    input - The InputStream from where the input comes.
    
    trim - the flag trim if the lines shell be trimed.
    
    Returns:
    
    The List with all lines from the file.
    
    Throws:
    
    IOException - When a io-problem occurs.
  - readLinesInList
```
public static List<String> readLinesInList(InputStream input,
                                           Charset encoding,
                                           boolean trim)
                                    throws IOException
```
    Reads every line from the given InputStream and puts them to the List.
    
    Parameters:
    
    input - The InputStream from where the input comes.
    
    encoding - the charset for read
    
    trim - the flag trim if the lines shell be trimed.
    
    Returns:
    
    The List with all lines from the file.
    
    Throws:
    
    IOException - When a io-problem occurs.
  - readPropertiesFromFile
```
public static Properties readPropertiesFromFile(String filename)
                                         throws IOException
```
    The Method readFromFile(String) reads from the properties-file all Properties and saves them into a Properties-Object.
    
    Parameters:
    
    filename - The Filename from the Properties-file.
    
    Returns:
    
    The Properties or null if an error occurs.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - toByteArray
```
public static byte[] toByteArray(File tmpFile)
                          throws IOException
```
    Get a byte array from the given file.
    
    Parameters:
    
    tmpFile - The file.
    
    Returns:
    
    Returns a byte array or null.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - toByteArray
```
public static byte[] toByteArray(InputStream input)
                          throws IOException
```
    Get a byte array from the given InputStream.
    
    Parameters:
    
    input - The InputStream.
    
    Returns:
    
    the a byte array.
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
    
    NullPointerException - if the input is null

Class ReadFileExtensions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReadFileExtensions

Method Detail

getFilecontentAsByteObjectArray

inputStream2String

inputStream2String

openFileReader

reader2String

readFileToBytearray

readFromFile

readFromFile

readHeadLine

readLinesInList

readLinesInList

readLinesInList

readLinesInList

readLinesInList

readLinesInList

readLinesInList

readPropertiesFromFile

toByteArray

toByteArray