de.weltraumschaf.commons.application

Class InvokableAdapter

java.lang.Object

de.weltraumschaf.commons.application.InvokableAdapter

All Implemented Interfaces:

Invokable

public abstract class InvokableAdapter
extends Object
implements Invokable

Abstract base implementation of an command line invokable.

Extend this class in your client code.

Example:

  public final class MyApp extends InvokableAdapter {

      public MyApp(final String[] args) {
          super(args);
      }

      public static void main(final String[] args) {
          InvokableAdapter.main(new MyApp(args));
      }

      @Override
      public void execute() throws Exception {
          registerShutdownHook(new Runnable() {

              @Override
              public void run() {
                  // Your shutdown code goes here.
              }
          });

          // Your application code here.
      }
  }
 

Since:

1.0.0

Version:

$Id: $Id

Author:

Sven Strittmatter <weltraumschaf@googlemail.com>

Field Summary

Fields

Modifier and Type	Field and Description
private String[]	args Copy of the command line arguments.
boolean	debug
private Exitable	exiter Abstraction for System.exit(int).
private IO	ioStreams I/O streams.
private Runtime	runtime Runtime for registering callbacks.
private ShutDownHook	shutDownHook Container for shutdown callbacks.

Constructor Summary

Constructors

Constructor and Description
InvokableAdapter(String[] args) Copies the command line arguments.
InvokableAdapter(String[] args, Runtime runtime, ShutDownHook shutDownHook) Dedicated constructor.

Method Summary

Modifier and Type	Method and Description
void	exit(ExitCode status) Exits the invokable.
void	exit(int status) Exits the invokable.
String[]	getArgs() Get the command line arguments.
IO	getIoStreams() Get stream object for I/O.
void	init() Initializes the invokable.
boolean	isDebugEnabled() isDebugEnabled.
static void	main(Invokable invokable) Invokes invokable with default I/O.
static void	main(Invokable invokable, IO ioStreams) Inject the I/O streams to the invokable and then calls Invokable.init() and then Invokable.execute().
static void	main(Invokable invokable, IO ioStreams, boolean debug) Inject the I/O streams to the invokable and then calls Invokable.init() and then Invokable.execute().
void	registerShutdownHook(Callable<Void> callback) Register a callback as shut down hook.
void	registerShutdownHook(Runnable callback) Register a callback as shut down hook.
void	setExiter(Exitable exiter) Set an exiter to handle exit calls.
void	setIoStreams(IO ioStreams) Set stream object for I/O.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.weltraumschaf.commons.application.Invokable

execute

Field Detail

debug

public boolean debug

args

private final String[] args

Copy of the command line arguments.

shutDownHook

private final ShutDownHook shutDownHook

Container for shutdown callbacks.

ioStreams

private IO ioStreams

I/O streams.

exiter

private Exitable exiter

Abstraction for System.exit(int).

runtime

private final Runtime runtime

Runtime for registering callbacks.

Constructor Detail

InvokableAdapter

public InvokableAdapter(String[] args)

Copies the command line arguments.

Parameters:

args - Command line arguments.

InvokableAdapter

public InvokableAdapter(String[] args,
                        Runtime runtime,
                        ShutDownHook shutDownHook)

Dedicated constructor.

Parameters:

args - Command line arguments.

runtime - Runtime for registering callbacks.

shutDownHook - Object to hold shutdown hooks.

Method Detail

main

public static void main(Invokable invokable)

Invokes invokable with default I/O.

Parameters:

invokable - Implementation to invoke.

main

public static void main(Invokable invokable,
                        IO ioStreams)

Inject the I/O streams to the invokable and then calls Invokable.init() and then Invokable.execute(). This method handles ell thrown Exception and calls System.exit(int).

Parameters:

invokable - Implementation to invoke.

ioStreams - I/O streams.

main

public static void main(Invokable invokable,
                        IO ioStreams,
                        boolean debug)

Inject the I/O streams to the invokable and then calls Invokable.init() and then Invokable.execute(). This method handles ell thrown Exception and calls System.exit(int), and prints stack trace if debug is true. FIXME Remove debug parameter.

Parameters:

invokable - implementation to invoke

ioStreams - I/O streams

debug - print stack trace if true

isDebugEnabled

public final boolean isDebugEnabled()

isDebugEnabled.

Specified by:

isDebugEnabled in interface Invokable

Returns:

a boolean.

init

public final void init()

Initializes the invokable. Adds shutdown hook to runtime.

Specified by:

init in interface Invokable

getArgs

public final String[] getArgs()

Get the command line arguments.

Returns:

Returns copy of the arguments array.

getIoStreams

public final IO getIoStreams()

Get stream object for I/O.

Specified by:

getIoStreams in interface Invokable

Returns:

Return always same instance until it was reset.

setIoStreams

public final void setIoStreams(IO ioStreams)

Set stream object for I/O.

Specified by:

setIoStreams in interface Invokable

Parameters:

ioStreams - Stream object.

registerShutdownHook

public final void registerShutdownHook(Runnable callback)

Register a callback as shut down hook.

Parameters:

callback - must not be null

registerShutdownHook

public final void registerShutdownHook(Callable<Void> callback)

Register a callback as shut down hook.

Parameters:

callback - must not be null

exit

public final void exit(int status)

Exits the invokable.

Specified by:

exit in interface Invokable

Parameters:

status - exit status.

exit

public final void exit(ExitCode status)

Exits the invokable.

Specified by:

exit in interface Invokable

Parameters:

status - exit status.

setExiter

public final void setExiter(Exitable exiter)

Set an exiter to handle exit calls.

Specified by:

setExiter in interface Invokable

Parameters:

exiter - Object which handles exit calls.