com.chemaxon.calculations.util

Interface CmdlineContext

All Known Implementing Classes:

DefaultCmdlineContext

public interface CmdlineContext

Represents contexts of command line applications. CmdlineContext provides and abstraction for testing command line interfaces. Class DefaultCmdlineContext implements default functionality and is injected as a service by this compilation unit. Tests should replace the injected service or inject the test time Please note that System.exit(int) is not delegated by this interface since execution of finally blocks would depend on the actual implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CmdlineContext.ExitWithNonZeroStatus Expected exception when exit(int) invoked with non-zero status.
static class	CmdlineContext.ExitWithZeroStatus Expected exception when exit(int) invoked with zero status.

Method Summary

Modifier and Type	Method and Description
PrintStream	err() Error stream, usually mapped to System.err.
void	exit(int status) Terminate execution with given status code.
InputStream	in() Input stream, usually mapped to System.in.
boolean	isFileExists(String name) Check if a file exists.
InputStream	openFileInput(String name) Open a file for reading.
OutputStream	openFileOutput(String name) Open a file for writing.
InputStream	openUrlStream(String spec) Open a connection to an URL.
PrintStream	out() Output stream, usually mapped to System.out.
SeekableFileOutput	seekableFileOutput(String name) Open a seekable file for writing.

Method Detail

out

PrintStream out()

Output stream, usually mapped to System.out.

err

PrintStream err()

Error stream, usually mapped to System.err.

in

InputStream in()

Input stream, usually mapped to System.in.

isFileExists

boolean isFileExists(String name)

Check if a file exists. Call usually delegated to File.exists() of an instance created by File.File(java.lang.String).

Parameters:

name - File name to check

Returns:

true when given file exists

openUrlStream

InputStream openUrlStream(String spec)
                   throws IOException

Open a connection to an URL. Call usually delegated to URL.openStream() of an instance created by URL.URL(java.lang.String).

Parameters:

spec - The String to parse as an URL.

Returns:

Connection

Throws:

IOException - propagated

openFileInput

InputStream openFileInput(String name)
                   throws FileNotFoundException

Open a file for reading. Call usually delegated to FileInputStream.FileInputStream(java.lang.String).

Parameters:

name - File name to open

Returns:

Opened file

Throws:

FileNotFoundException

openFileOutput

OutputStream openFileOutput(String name)
                     throws FileNotFoundException

Open a file for writing. Call usually delegated to FileOutputStream.FileOutputStream(java.lang.String).

Parameters:

name - File name to open

Returns:

Opened file

Throws:

FileNotFoundException

seekableFileOutput

SeekableFileOutput seekableFileOutput(String name)
                               throws FileNotFoundException

Open a seekable file for writing.

Parameters:

name - File name to open

Returns:

Opened file

Throws:

FileNotFoundException

exit

void exit(int status)
   throws CmdlineContext.ExitWithZeroStatus,
          CmdlineContext.ExitWithNonZeroStatus

Terminate execution with given status code. By default implementation calls System.exit(int). Test time implementations might decide to throw CmdlineContext.ExitWithZeroStatus or CmdlineContext.ExitWithNonZeroStatus instead of delegating to System.exit(int). These RuntimeExceptions are helps for test implementations, regular application code must not catch them.

Parameters:

status - Status code; by convention nonzero status code indicates abnormal termination

Throws:

CmdlineContext.ExitWithZeroStatus - Test time implementation might throw this instead of delegating to System.exit(int) Note that normal application code must not catch this.

CmdlineContext.ExitWithNonZeroStatus - Test time implementation might throw this instead of delegating to System.exit(int) Note that normal application code must not catch this.