Package oshi.util
Class FileUtil
java.lang.Object
oshi.util.FileUtil
File reading methods
-
Method Summary
Modifier and TypeMethodDescriptionstatic int
getIntFromFile(String filename)
Read a file and return the int value contained therein.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
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 byte[]
readAllBytes(String filename)
Read an entire file at one time.static byte[]
readAllBytes(String filename, boolean reportError)
Read an entire file at one time.Read an entire file at one time.Read an entire file at one time.static Properties
readPropertiesFromFilename(String propsFilename)
Read a configuration file from the sequence of context classloader, system classloader and classloader of the current class, and return its propertiesstatic String
readSymlinkTarget(File file)
Reads the target of a symbolic link
-
Method Details
-
readFile
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
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 readreportError
- 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
-
readAllBytes
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 byte array representing the file
-
readAllBytes
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 readreportError
- Whether to log errors reading the file- Returns:
- A byte array representing the file
-
getLongFromFile
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
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
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
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
-
getKeyValueMapFromFile
Read a file and return a map of string keys to string values contained therein. Intended primarily for Linux/proc/[pid]
files to provide more detailed or accurate information not available in the API.- Parameters:
filename
- The file to readseparator
- Character(s) in each line of the file that separate the key and the value.- Returns:
- The map contained in the file, delimited by the separator, with the value whitespace trimmed. If keys and values are not parsed, an empty map is returned.
-
readPropertiesFromFilename
Read a configuration file from the sequence of context classloader, system classloader and classloader of the current class, and return its properties- Parameters:
propsFilename
- The filename- Returns:
- A
Properties
object containing the properties.
-
readSymlinkTarget
Reads the target of a symbolic link- Parameters:
file
- The file to read- Returns:
- The symlink name, or null if the read failed
-