FileUtil (oshi-core 3.5.0 API)

java.lang.Object
- oshi.util.FileUtil

```
public class FileUtil
extends Object
```
File reading methods

Author:

widdis[at]gmail[dot]com

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`getIntFromFile(String filename)` Read a file and return the int value contained therein.
`static Map<String,String>`	`getKeyValueMapFromFile(String filename, String separator)` Read a file and return a map of string keys to string values contained therein.
`static long`	`getLongFromFile(String filename)` Read a file and return the long value contained therein.
`static String[]`	`getSplitFromFile(String filename)` Read a file and return an array of whitespaces-delimited string values contained therein.
`static String`	`getStringFromFile(String filename)` Read a file and return the String value contained therein.
`static long`	`getUnsignedLongFromFile(String filename)` Read a file and return the unsigned long value contained therein as a long.
`static List<String>`	`readFile(String filename)` Read an entire file at one time.
`static List<String>`	`readFile(String filename, boolean reportError)` Read an entire file at one time.

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

- Method Detail
  - readFile
```
public static List<String> readFile(String filename)
```
    Read an entire file at one time. Intended primarily for Linux /proc filesystem to avoid recalculating file contents on iterative reads.
    
    Parameters:
    
    filename - The file to read
    
    Returns:
    
    A list of Strings representing each line of the file, or an empty list if file could not be read or is empty
  - readFile
```
public static List<String> readFile(String filename,
                                    boolean reportError)
```
    Read an entire file at one time. Intended primarily for Linux /proc filesystem to avoid recalculating file contents on iterative reads.
    
    Parameters:
    
    filename - The file to read
    
    reportError - Whether to log errors reading the file
    
    Returns:
    
    A list of Strings representing each line of the file, or an empty list if file could not be read or is empty
  - getLongFromFile
```
public static long getLongFromFile(String filename)
```
    Read a file and return the long value contained therein. Intended primarily for Linux /sys filesystem
    
    Parameters:
    
    filename - The file to read
    
    Returns:
    
    The value contained in the file, if any; otherwise zero
  - getUnsignedLongFromFile
```
public static long getUnsignedLongFromFile(String filename)
```
    Read a file and return the unsigned long value contained therein as a long. Intended primarily for Linux /sys filesystem
    
    Parameters:
    
    filename - The file to read
    
    Returns:
    
    The value contained in the file, if any; otherwise zero
  - getIntFromFile
```
public static int getIntFromFile(String filename)
```
    Read a file and return the int value contained therein. Intended primarily for Linux /sys filesystem
    
    Parameters:
    
    filename - The file to read
    
    Returns:
    
    The value contained in the file, if any; otherwise zero
  - getStringFromFile
```
public static String getStringFromFile(String filename)
```
    Read a file and return the String value contained therein. Intended primarily for Linux /sys filesystem
    
    Parameters:
    
    filename - The file to read
    
    Returns:
    
    The value contained in the file, if any; otherwise empty string
  - getSplitFromFile
```
public static String[] getSplitFromFile(String filename)
```
    Read a file and return an array of whitespaces-delimited string values contained therein. Intended primarily for Linux /proc
    
    Parameters:
    
    filename - The file to read
    
    Returns:
    
    An array of strings containing delimited values
  - getKeyValueMapFromFile
```
public static Map<String,String> getKeyValueMapFromFile(String filename,
                                                        String separator)
```
    Read a file and return a map of string keys to string values contained therein. Intended primarily for Linux /proc/[pid]/io
    
    Parameters:
    
    filename - The file to read
    
    separator - Characters in each line of the file that separate the key and the value
    
    Returns:
    
    The map contained in the file, if any; otherwise empty map

Class FileUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

readFile

readFile

getLongFromFile

getUnsignedLongFromFile

getIntFromFile

getStringFromFile

getSplitFromFile

getKeyValueMapFromFile