org.zanata.maven

Class ConfigurableMojo<O extends ConfigurableOptions>

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.zanata.maven.ConfigurableMojo<O>

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, BasicOptions, ConfigurableOptions

Direct Known Subclasses:

ConfigurableProjectMojo, PutProjectMojo, PutUserMojo, PutVersionMojo

public abstract class ConfigurableMojo<O extends ConfigurableOptions>
extends org.apache.maven.plugin.AbstractMojo
implements ConfigurableOptions

Base class for mojos which support configuration by the user's zanata.ini

Author:

Sean Flanigan

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
ConfigurableMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
String	getCommandDescription()
List<CommandHook>	getCommandHooks()
boolean	getDebug()
boolean	getErrors()
boolean	getHelp()
String	getKey()
boolean	getLogHttp()
boolean	getQuiet()
URL	getUrl()
File	getUserConfig()
String	getUsername()
abstract ConfigurableCommand<O>	initCommand()
boolean	isAuthRequired()
boolean	isDebugSet()
boolean	isDisableSSLCert()
boolean	isErrorsSet()
boolean	isInteractiveMode()
boolean	isQuietSet()
protected void	runCommand()
void	setCommandHooks(List<CommandHook> commandHooks)
void	setDebug(boolean debug)
void	setDisableSSLCert(boolean disableSSLCert)
void	setErrors(boolean errors)
void	setHelp(boolean help)
void	setInteractiveMode(boolean interactiveMode)
void	setKey(String key)
void	setLogHttp(boolean logHttp)
void	setQuiet(boolean quiet)
void	setUrl(URL url)
void	setUserConfig(File userConfig)
void	setUsername(String username)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zanata.client.commands.BasicOptions

getCommandName

Constructor Detail

ConfigurableMojo

public ConfigurableMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

runCommand

protected void runCommand()
                   throws Exception

Throws:

Exception

initCommand

public abstract ConfigurableCommand<O> initCommand()

Specified by:

initCommand in interface BasicOptions

getDebug

public boolean getDebug()

Specified by:

getDebug in interface BasicOptions

setDebug

public void setDebug(boolean debug)

Specified by:

setDebug in interface BasicOptions

getErrors

public boolean getErrors()

Specified by:

getErrors in interface BasicOptions

setErrors

public void setErrors(boolean errors)

Specified by:

setErrors in interface BasicOptions

getHelp

public boolean getHelp()

Specified by:

getHelp in interface BasicOptions

setHelp

public void setHelp(boolean help)

Specified by:

setHelp in interface BasicOptions

getQuiet

public boolean getQuiet()

Specified by:

getQuiet in interface BasicOptions

setQuiet

public void setQuiet(boolean quiet)

Specified by:

setQuiet in interface BasicOptions

isDebugSet

public boolean isDebugSet()

Specified by:

isDebugSet in interface BasicOptions

isErrorsSet

public boolean isErrorsSet()

Specified by:

isErrorsSet in interface BasicOptions

isQuietSet

public boolean isQuietSet()

Specified by:

isQuietSet in interface BasicOptions

isInteractiveMode

public boolean isInteractiveMode()

Specified by:

isInteractiveMode in interface BasicOptions

setInteractiveMode

public void setInteractiveMode(boolean interactiveMode)

Specified by:

setInteractiveMode in interface BasicOptions

getCommandDescription

public String getCommandDescription()

Specified by:

getCommandDescription in interface BasicOptions

getKey

public String getKey()

Specified by:

getKey in interface ConfigurableOptions

setKey

public void setKey(String key)

Specified by:

setKey in interface ConfigurableOptions

getUrl

public URL getUrl()

Specified by:

getUrl in interface ConfigurableOptions

setUrl

public void setUrl(URL url)

Specified by:

setUrl in interface ConfigurableOptions

setUserConfig

public void setUserConfig(File userConfig)

Specified by:

setUserConfig in interface ConfigurableOptions

getUsername

public String getUsername()

Specified by:

getUsername in interface ConfigurableOptions

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface ConfigurableOptions

getUserConfig

public File getUserConfig()

Specified by:

getUserConfig in interface ConfigurableOptions

setCommandHooks

public void setCommandHooks(List<CommandHook> commandHooks)

Specified by:

setCommandHooks in interface BasicOptions

getCommandHooks

public List<CommandHook> getCommandHooks()

Specified by:

getCommandHooks in interface BasicOptions

getLogHttp

public boolean getLogHttp()

Specified by:

getLogHttp in interface ConfigurableOptions

setLogHttp

public void setLogHttp(boolean logHttp)

Specified by:

setLogHttp in interface ConfigurableOptions

isDisableSSLCert

public boolean isDisableSSLCert()

Specified by:

isDisableSSLCert in interface ConfigurableOptions

setDisableSSLCert

public void setDisableSSLCert(boolean disableSSLCert)

Specified by:

setDisableSSLCert in interface ConfigurableOptions

isAuthRequired

public boolean isAuthRequired()

Specified by:

isAuthRequired in interface ConfigurableOptions