de.weltraumschaf.commons.application

Interface Invokable

All Known Implementing Classes:

InvokableAdapter

public interface Invokable

An invokable is an application object invokable by command line interface.

Since:

1.0.0

Author:

Sven Strittmatter

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Template method for main application code.
void	exit(ExitCode status) Exits the invokable.
void	exit(int status) Exits the invokable.
IO	getIoStreams() Get stream object for I/O.
void	init() Initializes the invokable.
void	setExiter(Exitable exiter) Set an exiter to handle exit calls.
void	setIoStreams(IO ioStreams) Set stream object for I/O.

Method Detail

init

void init()

Initializes the invokable.

execute

void execute()
             throws Exception

Template method for main application code.

Throws:

Exception - If something goes wrong.

getIoStreams

IO getIoStreams()

Get stream object for I/O.

Returns:

Return always same instance until it was reset.

setIoStreams

void setIoStreams(IO ioStreams)

Set stream object for I/O.

Parameters:

ioStreams - Stream object.

exit

void exit(ExitCode status)

Exits the invokable.

Parameters:

status - exit status.

exit

void exit(int status)

Exits the invokable.

Parameters:

status - exit status.

setExiter

void setExiter(Exitable exiter)

Set an exiter to handle exit calls.

Parameters:

exiter - Object which handles exit calls.