io.stallion.boot

Class NewJavaPluginRunAction

java.lang.Object

io.stallion.boot.NewJavaPluginRunAction

All Implemented Interfaces:

StallionRunAction<CommandOptionsBase>

public class NewJavaPluginRunAction
extends Object
implements StallionRunAction<CommandOptionsBase>

A command-line StallionRunAction that will walk the user through generating the scaffolding for a brand new Stallion java plugin, including setting up the maven pom.xml and a directory structure.

Constructor Summary

Constructors

Constructor and Description
NewJavaPluginRunAction()

Method Summary

Modifier and Type	Method and Description
void	copyFile(String resourcePath, String relativePath)
void	copyTemplate(String resourcePath, String relativePath, Map ctx)
void	execute(CommandOptionsBase options) Actually do the action.
String	getActionName() The name of the action, will be used on the command line to run the action.
String	getArtifactId()
String	getGroupId()
String	getHelp() A friendly description of what the action does, will be printed on the command-line when help is asked for.
String	getJavaPackageName()
String	getPluginName()
String	getPluginNameTitleCase()
void	loadApp(CommandOptionsBase options) Load the application context.
void	makeNewApp(String javaFolder)
CommandOptionsBase	newCommandOptions() Each action might have its own command-line arguments.
String	promptForInputOfLength(String prompt, int length)
String	promptForInputOfLength(String prompt, int length, String contains)
String	promptForValidInput(String prompt, String... validChoices)
boolean	promptYesNo(String prompt)
NewJavaPluginRunAction	setArtifactId(String artifactId)
NewJavaPluginRunAction	setGroupId(String groupId)
NewJavaPluginRunAction	setJavaPackageName(String javaPackageName)
NewJavaPluginRunAction	setPluginName(String pluginName)
NewJavaPluginRunAction	setPluginNameTitleCase(String pluginNameTitleCase)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.stallion.boot.StallionRunAction

getSubActionName

Constructor Detail

NewJavaPluginRunAction

public NewJavaPluginRunAction()

Method Detail

getActionName

public String getActionName()

Description copied from interface: StallionRunAction

The name of the action, will be used on the command line to run the action.

Specified by:

getActionName in interface StallionRunAction<CommandOptionsBase>

Returns:

getHelp

public String getHelp()

Description copied from interface: StallionRunAction

A friendly description of what the action does, will be printed on the command-line when help is asked for.

Specified by:

getHelp in interface StallionRunAction<CommandOptionsBase>

Returns:

loadApp

public void loadApp(CommandOptionsBase options)

Description copied from interface: StallionRunAction

Load the application context. Some actions just need the settings loaded. Other actions need the settings plus all the services and data access layers. Other actions need all the former plus need to start jobs and the async task coordinator. Call exactly what you need to load in this method.

Specified by:

loadApp in interface StallionRunAction<CommandOptionsBase>

newCommandOptions

public CommandOptionsBase newCommandOptions()

Description copied from interface: StallionRunAction

Each action might have its own command-line arguments. Define your command-line arguments by creating a subclass of BaseCommandOptions. Then override this method to construct an instance of the subclass you created and return it.

Specified by:

newCommandOptions in interface StallionRunAction<CommandOptionsBase>

Returns:

execute

public void execute(CommandOptionsBase options)
             throws Exception

Description copied from interface: StallionRunAction

Actually do the action.

Specified by:

execute in interface StallionRunAction<CommandOptionsBase>

Throws:

Exception

makeNewApp

public void makeNewApp(String javaFolder)
                throws Exception

Throws:

Exception

copyTemplate

public void copyTemplate(String resourcePath,
                         String relativePath,
                         Map ctx)
                  throws IOException

Throws:

IOException

copyFile

public void copyFile(String resourcePath,
                     String relativePath)
              throws IOException

Throws:

IOException

promptYesNo

public boolean promptYesNo(String prompt)

promptForInputOfLength

public String promptForInputOfLength(String prompt,
                                     int length)

promptForInputOfLength

public String promptForInputOfLength(String prompt,
                                     int length,
                                     String contains)

promptForValidInput

public String promptForValidInput(String prompt,
                                  String... validChoices)

getPluginName

public String getPluginName()

setPluginName

public NewJavaPluginRunAction setPluginName(String pluginName)

getJavaPackageName

public String getJavaPackageName()

setJavaPackageName

public NewJavaPluginRunAction setJavaPackageName(String javaPackageName)

getPluginNameTitleCase

public String getPluginNameTitleCase()

setPluginNameTitleCase

public NewJavaPluginRunAction setPluginNameTitleCase(String pluginNameTitleCase)

getGroupId

public String getGroupId()

setGroupId

public NewJavaPluginRunAction setGroupId(String groupId)

getArtifactId

public String getArtifactId()

setArtifactId

public NewJavaPluginRunAction setArtifactId(String artifactId)