net.proteusframework.core.spring

Class CommandLineHelper

java.lang.Object

net.proteusframework.core.spring.CommandLineHelper

All Implemented Interfaces:

AutoCloseable

public class CommandLineHelper
extends Object
implements AutoCloseable

Helper class for running command line programs.

Example:

    public static void main(String[] args)
    {
        try (CommandLineHelper clh  = new CommandLineHelper())
        {
            clh.contextRegister(MyConfig.class);
            clh.runApplication(new MyJob());
        }
    }
 

Author:

Russ Tennant (russ@i2rd.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPRING_CONFIG Spring Java Config Class Name.
static String	SPRING_PROPERTIES PropertySource - Spring Properties.

Constructor Summary

Constructors

Constructor and Description
CommandLineHelper() Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	close()
void	contextRegister(Class<?>... annotatedConfigurationClasses) Configure the application context with the specified java configuration class.
void	contextScan(String... basePackages) Scan the specified packages for Spring configuration.
void	exit() Shutdown and cleanly exit the program / VM.
<R> R	runApplication(Callable<R> application) Start the specified application and wait until it is finished before returning.
void	runApplication(Runnable application) Start the specified application and wait until it is finished before returning.
<R> R	runApplicationCallableClass(Class<? extends Callable<R>> applicationClass) Start the specified application and wait until it is finished before returning.
void	runApplicationRunnableClass(Class<? extends Runnable> applicationClass) Start the specified application and wait until it is finished before returning.
<R> Future<R>	startApplication(Callable<R> application) Start the specified application.
Future<?>	startApplication(Runnable application) Start the specified application.
<R> Future<R>	startApplicationCallableClass(Class<? extends Callable<R>> applicationClass) Start the specified application.
void	startApplicationContext() Start the ApplicationContext.
Future<?>	startApplicationRunnableClass(Class<? extends Runnable> applicationClass) Start the specified application.

Methods inherited from class java.lang.Object

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

Field Detail

SPRING_CONFIG

public static final String SPRING_CONFIG

Spring Java Config Class Name.

See Also:

Constant Field Values

SPRING_PROPERTIES

public static final String SPRING_PROPERTIES

PropertySource - Spring Properties.

See Also:

Constant Field Values

Constructor Detail

CommandLineHelper

public CommandLineHelper()

Create a new instance.

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

contextRegister

public void contextRegister(Class<?>... annotatedConfigurationClasses)

Configure the application context with the specified java configuration class.

Parameters:

annotatedConfigurationClasses - the configuration classes.

See Also:

AnnotationConfigApplicationContext.register(Class[])

contextScan

public void contextScan(String... basePackages)

Scan the specified packages for Spring configuration.

Parameters:

basePackages - the base packages.

See Also:

AnnotationConfigApplicationContext.scan(String...)

exit

public void exit()

Shutdown and cleanly exit the program / VM.

runApplication

@Nullable
public <R> R runApplication(@Nonnull
                                      Callable<R> application)

Start the specified application and wait until it is finished before returning. The ApplicationContext will be started if necessary.

The application context will be available when the call method is called.

Type Parameters:

R - the return type.

Parameters:

application - the application to run.

Returns:

the return value from the application.

runApplication

public void runApplication(@Nonnull
                           Runnable application)

Start the specified application and wait until it is finished before returning. The ApplicationContext will be started if necessary.

The application context will be available when the run method is called.

Parameters:

application - the application to run.

runApplicationCallableClass

@Nullable
public <R> R runApplicationCallableClass(@Nonnull
                                                   Class<? extends Callable<R>> applicationClass)

Start the specified application and wait until it is finished before returning. The ApplicationContext will be started if necessary.

The application context will be available when the class is instantiated.

Type Parameters:

R - the return type.

Parameters:

applicationClass - the application to run.

Returns:

the return value from the application.

runApplicationRunnableClass

public void runApplicationRunnableClass(@Nonnull
                                        Class<? extends Runnable> applicationClass)

Start the specified application and wait until it is finished before returning. The ApplicationContext will be started if necessary.

The application context will be available when the class is instantiated.

Parameters:

applicationClass - the application to run.

startApplication

public <R> Future<R> startApplication(@Nonnull
                                      Callable<R> application)

Start the specified application. The ApplicationContext will be started if necessary.

The application context will be available when the call method is called.

Type Parameters:

R - the return type.

Parameters:

application - the application to run.

Returns:

the Future.

startApplication

public Future<?> startApplication(@Nonnull
                                  Runnable application)

Start the specified application. The ApplicationContext will be started if necessary.

The application context will be available when the run method is called.

Parameters:

application - the application to run.

Returns:

the Future.

startApplicationCallableClass

public <R> Future<R> startApplicationCallableClass(@Nonnull
                                                   Class<? extends Callable<R>> applicationClass)

Start the specified application. The ApplicationContext will be started if necessary.

The application context will be available when the class is instantiated.

Type Parameters:

R - the return type.

Parameters:

applicationClass - the application to run.

Returns:

the Future.

startApplicationContext

public void startApplicationContext()

Start the ApplicationContext.

startApplicationRunnableClass

public Future<?> startApplicationRunnableClass(@Nonnull
                                               Class<? extends Runnable> applicationClass)

Start the specified application. The ApplicationContext will be started if necessary.

The application context will be available when the class is instantiated.

Parameters:

applicationClass - the application to run. Must have a no-arg constructor.

Returns:

the Future.