org.overlord.sramp.shell

Class FileShellCommandReader

java.lang.Object

org.overlord.sramp.shell.AbstractShellCommandReader

org.overlord.sramp.shell.FileShellCommandReader

All Implemented Interfaces:

ShellCommandReader

public class FileShellCommandReader
extends AbstractShellCommandReader

An implementation of the ShellCommandReader that reads data from a file.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
FileShellCommandReader(ShellCommandFactory factory, ShellContextImpl context, String filePath) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Called by the shell when exiting.
boolean	isBatch()
void	open() Called to open the shell command reader.
String	promptForInput(String prompt) Prompts the user for some input.
String	promptForPassword(String prompt) Prompts the user for a password.
protected String	readLine() Reads a single line from the input source (e.g.

Methods inherited from class org.overlord.sramp.shell.AbstractShellCommandReader

getCommandOutput, getContext, getFactory, read

Methods inherited from class java.lang.Object

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

Constructor Detail

FileShellCommandReader

public FileShellCommandReader(ShellCommandFactory factory,
                      ShellContextImpl context,
                      String filePath)

Constructor.

Parameters:

factory -

context -

filePath -

Method Detail

open

public void open()
          throws IOException

Description copied from interface: ShellCommandReader

Called to open the shell command reader.

Specified by:

open in interface ShellCommandReader

Specified by:

open in class AbstractShellCommandReader

Throws:

IOException

See Also:

org.overlord.sramp.common.shell.AbstractShellCommandReader#open()

readLine

protected String readLine()
                   throws IOException

Description copied from class: AbstractShellCommandReader

Reads a single line from the input source (e.g. user input) and returns it.

Specified by:

readLine in class AbstractShellCommandReader

Throws:

IOException

See Also:

org.overlord.sramp.common.shell.AbstractShellCommandReader#readLine()

close

public void close()
           throws IOException

Description copied from interface: ShellCommandReader

Called by the shell when exiting.

Specified by:

close in interface ShellCommandReader

Overrides:

close in class AbstractShellCommandReader

Throws:

IOException

See Also:

org.overlord.sramp.common.shell.ShellCommandReader#close()

isBatch

public boolean isBatch()

Specified by:

isBatch in interface ShellCommandReader

Overrides:

isBatch in class AbstractShellCommandReader

Returns:

true if this is a batch command reader

See Also:

ShellCommandReader.isBatch()

promptForInput

public String promptForInput(String prompt)

Description copied from interface: ShellCommandReader

Prompts the user for some input. Returns the text entered by the user.

See Also:

ShellCommandReader.promptForInput(java.lang.String)

promptForPassword

public String promptForPassword(String prompt)

Description copied from interface: ShellCommandReader

Prompts the user for a password. Returns the text entered by the user.

See Also:

ShellCommandReader.promptForPassword(java.lang.String)