Package org.springframework.shell.core

Class FileInputProvider

java.lang.Object

org.springframework.shell.core.FileInputProvider

All Implemented Interfaces:

AutoCloseable, InputProvider

public class FileInputProvider
extends Object
implements InputProvider, AutoCloseable

An InputProvider that reads input from a file.

Supports backslashes at end of line to signal line continuation.

Author:

Eric Bottard, Piotr Olaszewski, Mahmoud Ben Hassine

Constructor Summary

Constructors

Constructor	Description
FileInputProvider(File file)	Create a new FileInputProvider instance.

Method Summary

Modifier and Type	Method	Description
void	close()
@Nullable String	readInput()	Return text entered by user to invoke commands.

Methods inherited from class java.lang.Object

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

Constructor Details

FileInputProvider

public FileInputProvider(File file)
                  throws FileNotFoundException

Create a new FileInputProvider instance.

Parameters:

file - the file to read input from

Throws:

FileNotFoundException - if the file does not exist

Method Details

readInput

public @Nullable String readInput()
                           throws IOException

Description copied from interface: InputProvider

Return text entered by user to invoke commands.

Specified by:

readInput in interface InputProvider

Returns:

user input line or null if end of input is reached

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException