FileIoUtil (java-utils 1.0.6 API)

java.lang.Object
- com.github.hypfvieh.util.FileIoUtil

public final class FileIoUtil
extends Object

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static List<String>`	`getTextfileFromUrl(String _url)` Retrives a text file from an given URL.
`static List<String>`	`getTextfileFromUrl(String _url, Charset _charset)` Retrives a text file from an given URL and reads the content with the given charset.
`static List<String>`	`getTextfileFromUrl(String _url, Charset _charset, boolean _silent)`
`static String`	`guessLineTerminatorOfFile(String _file)` Tries to find the line termination character(s) of the given file.
`static Properties`	`loadPropertiesFromClasspath(String _propertiesFile)` Loads the contents of a properties file located in the Java classpath into a `Properties` object.
`static boolean`	`loadPropertiesFromClasspath(String _propertiesFile, Properties _properties)` Same as `loadPropertiesFromClasspath(String)` but does not throw checked exception.
`static InputStream`	`openInputStreamForFile(String _fileNameWithPath, SearchOrder... _searchOrder)` Tries to find _fileNameWithPath in either classpath, systempath or absolute path and opens an `InputStream` for it.
`static List<String>`	`readFileFrom(String _fileName, Charset _charset, SearchOrder... _searchOrder)` Read a file from different sources depending on _searchOrder.
`static String`	`readFileFromClassPath(String _fileName)` Reads a file from classpath to String.
`static List<String>`	`readFileFromClassPathAsList(String _fileName)` Reads a file from classpath to a list of String using default charset and log any exception.
`static List<String>`	`readFileFromClassPathAsList(String _fileName, Charset _charset, boolean _silent)` Reads a file from classpath to a list of String with the given charset.
`static List<String>`	`readFileToList(File _file)` Reads a file to a List<String> (each line is one entry in list).
`static List<String>`	`readFileToList(String _fileName)` Reads a file to a List<String> (each line is one entry in list).
`static String`	`readFileToString(File _file)`
`static String`	`readFileToString(String _file)` Reads a file and returns it's content as string.
`static Properties`	`readProperties(File _file)` Trys to read a properties file.
`static Properties`	`readProperties(InputStream _stream)` Tries to read a properties file from an inputstream.
`static boolean`	`readPropertiesBoolean(Properties _props, String _property)` Reads a property as boolean from an properties object.
`static Properties`	`readPropertiesFromFile(String _fileName, Properties _props)` Read properties from given filename (returns empty `Properties` object on failure).
`static String`	`readStringFromResources(InputStream _stream, String _charset)` Read a Resource-file (eg.
`static List<String>`	`readTextFileFromStream(InputStream _input, Charset _charset, boolean _silent)` Reads a text file from given `InputStream` using the given `Charset`.
`static boolean`	`writeProperties(File _file, Properties _props)` Writes a properties Object to file.
`static boolean`	`writeProperties(String _propertiesFile, Properties _props)` Write a properties object to a given file (will overwrite existing files!).
`static boolean`	`writeTextFile(String _fileName, String _fileContent, boolean _append)` Write String to file with the java default charset (usually UTF-8).
`static boolean`	`writeTextFile(String _fileName, String _fileContent, Charset _charset, boolean _append)` Write String to file with the given charset.

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

- Method Detail
  - readProperties
```
public static Properties readProperties(File _file)
```
    Trys to read a properties file. Returns null if properties file could not be loaded
    
    Parameters:
    
    _file -
    
    Returns:
    
    Properties Object or null
  - readProperties
```
public static Properties readProperties(InputStream _stream)
```
    Tries to read a properties file from an inputstream.
    
    Parameters:
    
    _stream -
    
    Returns:
    
    properties object/null
  - readPropertiesFromFile
```
public static Properties readPropertiesFromFile(String _fileName,
                                                Properties _props)
```
    Read properties from given filename (returns empty Properties object on failure).
    
    Parameters:
    
    _fileName - The properties file to read
    
    _props - optional properties object, if null a new object created in the method
    
    Returns:
    
    Properties object
  - writeProperties
```
public static boolean writeProperties(File _file,
                                      Properties _props)
```
    Writes a properties Object to file. Returns true on success, false otherwise.
    
    Parameters:
    
    _file -
    
    _props -
    
    Returns:
    
    true on success, false otherwise
  - writeProperties
```
public static boolean writeProperties(String _propertiesFile,
                                      Properties _props)
```
    Write a properties object to a given file (will overwrite existing files!).
    
    Parameters:
    
    _propertiesFile - - The filename you want to use
    
    _props - - The properties to save
    
    Returns:
    
    boolean true on success, false on exception
  - readPropertiesBoolean
```
public static boolean readPropertiesBoolean(Properties _props,
                                            String _property)
```
    Reads a property as boolean from an properties object. Returns true if read property matches 1, yes, true, enabled, on, y
    
    Parameters:
    
    _props -
    
    _property -
    
    Returns:
  - getTextfileFromUrl
```
public static List<String> getTextfileFromUrl(String _url)
```
    Retrives a text file from an given URL. Url could be remote (like http://) or local (file://) If protocol is not specified by "protocol://" (like "http://" or "file://"), "file://" is assumed.
    
    Parameters:
    
    _url -
    
    Returns:
    
    fileContent as List or null if file is empty or an error occoured
  - getTextfileFromUrl
```
public static List<String> getTextfileFromUrl(String _url,
                                              Charset _charset)
```
    Retrives a text file from an given URL and reads the content with the given charset. Url could be remote (like http://) or local (file://) If protocol is not specified by "protocol://" (like "http://" or "file://"), "file://" is assumed.
    
    Parameters:
    
    _url -
    
    _charset -
    
    Returns:
    
    fileContent as List or null if file is empty or an error occurred.
  - getTextfileFromUrl
```
public static List<String> getTextfileFromUrl(String _url,
                                              Charset _charset,
                                              boolean _silent)
```
    Parameters:
    
    _url -
    
    _charset -
    
    _silent - true to not log exceptions, false otherwise
    
    Returns:
    
    list of string or null on error
    
    See Also:
    
    getTextfileFromUrl(String, Charset)
  - readTextFileFromStream
```
public static List<String> readTextFileFromStream(InputStream _input,
                                                  Charset _charset,
                                                  boolean _silent)
```
    Reads a text file from given InputStream using the given Charset.
    
    Parameters:
    
    _input - stream to read
    
    _charset - charset to use
    
    _silent - true to disable exception logging, false otherwise
    
    Returns:
    
    List of string or null on error
  - readFileToString
```
public static String readFileToString(String _file)
```
    Reads a file and returns it's content as string.
    
    Parameters:
    
    _file -
    
    Returns:
  - readFileToList
```
public static List<String> readFileToList(File _file)
```
    Reads a file to a List<String> (each line is one entry in list). Line endings (line feed/carriage return) are NOT removed!
    
    Parameters:
    
    _file -
    
    Returns:
  - readFileToList
```
public static List<String> readFileToList(String _fileName)
```
    Reads a file to a List<String> (each line is one entry in list). Line endings (line feed/carriage return) are NOT removed!
    
    Parameters:
    
    _fileName -
    
    Returns:
  - readFileToString
```
public static String readFileToString(File _file)
```
  - readStringFromResources
```
public static String readStringFromResources(InputStream _stream,
                                             String _charset)
```
    Read a Resource-file (eg. Text) to String.
    
    Parameters:
    
    _stream -
    
    _charset -
    
    Returns:
    
    the file as string, or null on error
  - loadPropertiesFromClasspath
```
public static Properties loadPropertiesFromClasspath(String _propertiesFile)
                                              throws IOException
```
    Loads the contents of a properties file located in the Java classpath into a Properties object.
    
    Parameters:
    
    _propertiesFile - properties file located in Java classpath
    
    Returns:
    
    properties object
    
    Throws:
    
    IOException - if file not found or loading fails for other I/O reasons
  - loadPropertiesFromClasspath
```
public static boolean loadPropertiesFromClasspath(String _propertiesFile,
                                                  Properties _properties)
```
    Same as loadPropertiesFromClasspath(String) but does not throw checked exception. The returned boolean indicates if loading was successful. Read properties are stored in the given properties object (should never be null!).
    
    Parameters:
    
    _propertiesFile -
    
    _properties -
    
    Returns:
    
    true if properties could be loaded, false otherwise
  - readFileFromClassPath
```
public static String readFileFromClassPath(String _fileName)
```
    Reads a file from classpath to String.
    
    Parameters:
    
    _fileName -
    
    Returns:
    
    file contents as String or null
  - readFileFromClassPathAsList
```
public static List<String> readFileFromClassPathAsList(String _fileName)
```
    Reads a file from classpath to a list of String using default charset and log any exception.
    
    Parameters:
    
    _fileName -
    
    Returns:
    
    file contents or empty list
  - readFileFromClassPathAsList
```
public static List<String> readFileFromClassPathAsList(String _fileName,
                                                       Charset _charset,
                                                       boolean _silent)
```
    Reads a file from classpath to a list of String with the given charset. Will optionally suppress any exception logging.
    
    Parameters:
    
    _fileName - file to read
    
    _charset - charset to use for reading
    
    _silent - true to suppress error logging, false otherwise
    
    Returns:
    
    file contents or null on exception
  - writeTextFile
```
public static boolean writeTextFile(String _fileName,
                                    String _fileContent,
                                    Charset _charset,
                                    boolean _append)
```
    Write String to file with the given charset. Optionally appends the data to the file.
    
    Parameters:
    
    _fileName - the file to write
    
    _fileContent - the content to write
    
    _charset - the charset to use
    
    _append - append content to file, if false file will be overwritten if existing
    
    Returns:
    
    true on successful write, false otherwise
  - writeTextFile
```
public static boolean writeTextFile(String _fileName,
                                    String _fileContent,
                                    boolean _append)
```
    Write String to file with the java default charset (usually UTF-8). Optionally appends the data to the file.
    
    Parameters:
    
    _fileName - the file to write
    
    _fileContent - the content to write
    
    _append - append content to file, if false file will be overwritten if existing
    
    Returns:
    
    true on successful write, false otherwise
  - readFileFrom
```
public static List<String> readFileFrom(String _fileName,
                                        Charset _charset,
                                        SearchOrder... _searchOrder)
```
    Read a file from different sources depending on _searchOrder. Will return the first successfully read file which can be loaded either from custom path, classpath or system path.
    
    Parameters:
    
    _fileName - file to read
    
    _charset - charset used for reading
    
    _searchOrder - search order
    
    Returns:
    
    List of String with file content or null if file could not be found
  - openInputStreamForFile
```
public static InputStream openInputStreamForFile(String _fileNameWithPath,
                                                 SearchOrder... _searchOrder)
```
    Tries to find _fileNameWithPath in either classpath, systempath or absolute path and opens an InputStream for it. Search order is specified by SearchOrder varargs.
    
    Parameters:
    
    _fileNameWithPath -
    
    _searchOrder -
    
    Returns:
    
    InputStream for the file or null if file could not be found
  - guessLineTerminatorOfFile
```
public static String guessLineTerminatorOfFile(String _file)
```
    Tries to find the line termination character(s) of the given file. Only useful for files with text content!
    
    Parameters:
    
    _file -
    
    Returns:
    
    never null, will return system default line terminator on any error

Class FileIoUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

readProperties

readProperties

readPropertiesFromFile

writeProperties

writeProperties

readPropertiesBoolean

getTextfileFromUrl

getTextfileFromUrl

getTextfileFromUrl

readTextFileFromStream

readFileToString

readFileToList

readFileToList

readFileToString

readStringFromResources

loadPropertiesFromClasspath

loadPropertiesFromClasspath

readFileFromClassPath

readFileFromClassPathAsList

readFileFromClassPathAsList

writeTextFile

writeTextFile

readFileFrom

openInputStreamForFile

guessLineTerminatorOfFile