KSLCore/ksl.utilities.io/KSLFileUtil

KSLFileUtil

Provides some basic file utilities. Additional utilities can be found in Google Guava and Apache Commons IO. However, this basic IO provides basic needs without external libraries and is integrated withe KSL functionality.

Properties

logger

val logger: KLogger

Use for general logging

programLaunchDirectory

val programLaunchDirectory: Path

Returns the path to the directory that the program was launched from on the OS. This call may throw a SecurityException if the system information is not accessible. Uses System property "user.dir"

programLaunchDirectoryAsString

val programLaunchDirectoryAsString: String

Returns the directory that the program was launched from on the OS as a string. This call may throw a SecurityException if the system information is not accessible. Uses System property "user.dir"

SOUT

val SOUT: PrintWriter

System.out as a PrintWriter

Functions

chooseFile

fun chooseFile(): File?

copyDirectory

fun copyDirectory(source: File, destination: File)

fun copyDirectory(source: Path, destination: Path)

createCSVFileName

fun createCSVFileName(name: String?): String

Makes a String that has the form name.csv

createDirectories

fun createDirectories(path: Path): Path?

Will throw an IOException if something goes wrong in the creation.

createFile

fun createFile(pathToFile: Path): File

createFileName

fun createFileName(theName: String?, theFileExtension: String?): String

Makes a String that has the form name.ext If an extension already exists it is replaced.

createLogPrintWriter

fun createLogPrintWriter(file: File): LogPrintWriter

Makes a LogPrintWriter from the given File. IOExceptions are caught and logged. If the file exists it will be written over.

fun createLogPrintWriter(pathToFile: Path): LogPrintWriter

Makes a PrintWriter from the given path, any IOExceptions are caught and logged.

createPrintWriter

fun createPrintWriter(file: File): PrintWriter

Makes a PrintWriter from the given File. IOExceptions are caught and logged. If the file exists it is written over.

fun createPrintWriter(pathToFile: Path): PrintWriter

Makes a PrintWriter from the given path, any IOExceptions are caught and logged. The path must be to a file, not a directory. If the directories that are on the path do not exist, they are created. If the referenced file exists it is written over.

fun createPrintWriter(fileName: String): PrintWriter

Makes the file in the directory that the program launched within

createSubDirectory

fun createSubDirectory(mainDir: Path, dirName: String): Path

Creates a subdirectory within the supplied main directory.

createTemporaryFile

fun createTemporaryFile(fileName: String, dir: Path = KSL.outDir): File

createTxtFileName

fun createTxtFileName(name: String?): String

Makes a String that has the form name.txt

deleteDirectory

fun deleteDirectory(directoryToBeDeleted: File): Boolean

Recursively deletes

fun deleteDirectory(pathToDir: Path): Boolean

getExtensionByStringFileName

fun getExtensionByStringFileName(filename: String): Optional<String>

This method will check for the dot ‘.' occurrence in the given filename. If it exists, then it will find the last position of the dot ‘.' and return the characters after that, the characters after the last dot ‘.' known as the file extension. Special Cases:

getExtensionFromPath

fun getExtensionFromPath(pathToFile: Path): Optional<String>

hasCSVExtension

fun hasCSVExtension(pathToFile: Path): Boolean

isCSVFile

fun isCSVFile(pathToFile: Path?): Boolean

isCSVFileName

fun isCSVFileName(fileName: String?): Boolean

isTeXFile

fun isTeXFile(pathToFile: Path?): Boolean

isTexFileName

fun isTexFileName(fileName: String?): Boolean

isTextFile

fun isTextFile(pathToFile: Path?): Boolean

isTextFileName

fun isTextFileName(fileName: String?): Boolean

openInBrowser

fun openInBrowser(file: File)

fun openInBrowser(fileName: String, html: String, dir: Path = KSL.plotDir): File

removeFileExtension

fun removeFileExtension(filename: String?, removeAllExtensions: Boolean): String?

removeLastFileExtension

fun removeLastFileExtension(fileName: String): String?

scanToArray

fun scanToArray(pathToFile: Path): DoubleArray

Assumes that the file holds doubles with each value on a different line 1.0 4.0 2.0 etc

toCSVString

fun toCSVString(array: DoubleArray, df: DecimalFormat? = null): String

write

fun write(array: Array<IntArray>, out: PrintWriter = SOUT)

fun write(array: IntArray, out: PrintWriter = SOUT)

fun write(array: Array<DoubleArray>, out: PrintWriter = SOUT, df: DecimalFormat? = null)

fun write(array: DoubleArray, out: PrintWriter = SOUT, df: DecimalFormat? = null)

Allows writing directly to a known PrintWriter. Facilitates writing to the file before or after the array is written

fun write(list: List<DoubleArray>, out: PrintWriter = SOUT, df: DecimalFormat? = null)

Allows writing directly to a known PrintWriter. Facilitates writing to the file before or after the list is written

writeToFile

fun writeToFile(array: Array<IntArray>, pathToFile: Path)

fun writeToFile(array: Array<IntArray>, fileName: String)

fun writeToFile(array: Array<DoubleArray>, pathToFile: Path, df: DecimalFormat? = null)

fun writeToFile(array: Array<DoubleArray>, fileName: String, df: DecimalFormat? = null)

Writes the data in the array to rows in the file, each element in a row is separated by a comma

fun writeToFile(array: IntArray, pathToFile: Path)

fun writeToFile(array: IntArray, fileName: String)

fun writeToFile(array: DoubleArray, pathToFile: Path, df: DecimalFormat? = null): Path

fun writeToFile(array: DoubleArray, fileName: String, df: DecimalFormat? = null): Path

Writes the data in the array to rows in the file, each row with one data point