de.unkrig.jsh

Class Command

java.lang.Object

de.unkrig.jsh.Command

public abstract class Command
extends Object

A super-small framework for building UNIX pipes of commands.

Examples:

pipe("ls").through("cat").to("sed", "-e", "s/e//g");
     from(new File("foo.txt")).through("sort").to("sed", "-e", "s/e//g");
     from(new File("foo.txt")).through("sort").to(new File("foo2.txt"));
 

Constructor Summary

Constructors

Constructor and Description
Command()

Method Summary

Methods

Modifier and Type	Method and Description
static Command	from(File inputFile) Creates and returns a Command object which reads from the inputFile
static Command	pipe(String... command) Creates and returns a Command object which will execute the given command and catch its output.
void	print() Prints the output to System.out.
static int	run(ProcessBuilder.Redirect redirectError, String... command) Executes the command, without redirecting its input or output.
static int	run(String... command) Executes the command, without redirecting its input, output and error.
protected abstract InputStream	start()
Command	through(String... command) Creates and returns a Command object which will execute this Command, catch its output, feed it through the given command and catch its output.
void	to(File outputFile) Executes this Command, catches its output and stores it in the outputFile.
int	to(ProcessBuilder.Redirect redirectError, String... command) Executes this Command, catches its output and feeds it into the command.
int	to(String... command) Executes this Command, catches its output and feeds it into the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command()

Method Detail

run

public static int run(String... command)
               throws InterruptedException,
                      IOException

Executes the command, without redirecting its input, output and error.

Returns:

The exit value of the command

Throws:

InterruptedException

IOException

run

public static int run(ProcessBuilder.Redirect redirectError,
      String... command)
               throws InterruptedException,
                      IOException

Executes the command, without redirecting its input or output.

Parameters:

redirectError - Where to redirect the error output of the command

Returns:

The exit value of the command

Throws:

InterruptedException

IOException

from

public static Command from(File inputFile)

Creates and returns a Command object which reads from the inputFile

See Also:

Command

pipe

public static Command pipe(String... command)

Creates and returns a Command object which will execute the given command and catch its output.

See Also:

Command

print

public void print()
           throws IOException

Prints the output to System.out.

Throws:

IOException

See Also:

Command

to

public int to(String... command)
       throws InterruptedException,
              IOException

Executes this Command, catches its output and feeds it into the command.

Returns:

The exit value of the command

Throws:

InterruptedException

IOException

See Also:

Command

to

public int to(ProcessBuilder.Redirect redirectError,
     String... command)
       throws InterruptedException,
              IOException

Executes this Command, catches its output and feeds it into the command.

Parameters:

redirectError - Where to redirect the error output of the command

Returns:

The exit value of the command

Throws:

InterruptedException

IOException

See Also:

Command

to

public void to(File outputFile)
        throws IOException

Executes this Command, catches its output and stores it in the outputFile.

Throws:

IOException

See Also:

Command

through

public Command through(String... command)
                throws InterruptedException,
                       IOException

Creates and returns a Command object which will execute this Command, catch its output, feed it through the given command and catch its output.

Throws:

InterruptedException

IOException

See Also:

Command

start

protected abstract InputStream start()
                              throws IOException

Returns:

The byte stream produced by this Command

Throws:

IOException