org.midica.file

Class Foreign

java.lang.Object

org.midica.file.Foreign

public class Foreign
extends java.lang.Object

This class provides methods to interact with foreign command line tools.

This is used for importing and exporting files using an intermediate, temporary MIDI file.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	lastStdOut

Constructor Summary

Constructors

Constructor and Description
Foreign()

Method Summary

Modifier and Type	Method and Description
static java.nio.file.Path	createTempDirectory() Creates a temporary directory.
static java.io.File	createTempFile(java.lang.String extension, java.nio.file.Path parentDir) Creates a temporary file.
static java.io.File	createTempMidiFile() Creates a temporary file to be used for MIDI import or export.
static void	deleteTempDir(java.nio.file.Path dir) Removes the given temp directory.
static void	deleteTempFile(java.io.File file) Deletes the given temporary file.
static void	execute(java.util.List<java.lang.String> cmd, java.lang.String programName, boolean acceptAllExitCodes) Executes a command.
static void	execute(java.lang.String[] cmd, java.lang.String programName, boolean acceptAllExitCodes) Executes a command.
static java.io.File[]	getFiles(java.nio.file.Path dirPath) Returns all files inside the given temp directory.
static java.lang.String	getLastOutput() Returns whatever the last executed program wrote to STDOUT.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

lastStdOut

private static java.lang.String lastStdOut

Constructor Detail

Foreign

public Foreign()

Method Detail

createTempDirectory

public static java.nio.file.Path createTempDirectory()
                                              throws ForeignException

Creates a temporary directory.

Returns:

the temporary directory

Throws:

ForeignException - if something goes wrong

getFiles

public static java.io.File[] getFiles(java.nio.file.Path dirPath)
                               throws ForeignException

Returns all files inside the given temp directory.

Parameters:

dirPath - temp directory to be read

Returns:

all files in the given directory.

Throws:

ForeignException - if something goes wrong

deleteTempDir

public static void deleteTempDir(java.nio.file.Path dir)

Removes the given temp directory.

Parameters:

dir - the directory to remove

createTempMidiFile

public static java.io.File createTempMidiFile()
                                       throws ForeignException

Creates a temporary file to be used for MIDI import or export.

Returns:

the temporary file

Throws:

ForeignException - if something goes wrong

createTempFile

public static java.io.File createTempFile(java.lang.String extension,
                                          java.nio.file.Path parentDir)
                                   throws ForeignException

Creates a temporary file.

Parameters:

extension - file extension (without the dot) - may be null

parentDir - parent directory or null, if the directory doesn’t matter

Returns:

the temporary file

Throws:

ForeignException - if something goes wrong

deleteTempFile

public static void deleteTempFile(java.io.File file)

Deletes the given temporary file. Suppresses any exception, if the deletion fails.

Parameters:

file - the file to be deleted

execute

public static void execute(java.lang.String[] cmd,
                           java.lang.String programName,
                           boolean acceptAllExitCodes)
                    throws ForeignException

Executes a command.

Transforms the given cmd array to a list and calls execute(List, String, boolean).

Parameters:

cmd - Command and Options

programName - Name of the foreign Program to be displayed in error messages

acceptAllExitCodes - true to silently ignore exit codes other than 0. false to throw an exception in this case.

Throws:

ForeignException - if an error occurs.

execute

public static void execute(java.util.List<java.lang.String> cmd,
                           java.lang.String programName,
                           boolean acceptAllExitCodes)
                    throws ForeignException

Executes a command.

Parameters:

cmd - Command and Options

programName - Name of the foreign Program to be displayed in error messages

acceptAllExitCodes - true to silently ignore exit codes other than 0. false to throw an exception in this case.

Throws:

ForeignException - if an error occurs. Sets the path-checked marker inside of the exception, if the command was found.

getLastOutput

public static java.lang.String getLastOutput()

Returns whatever the last executed program wrote to STDOUT.

Returns:

the last STDOUT string