Package org.codehaus.plexus.tools.cli

Class AbstractCli

java.lang.Object

org.codehaus.plexus.tools.cli.AbstractCli

All Implemented Interfaces:

Cli

public abstract class AbstractCli
extends java.lang.Object
implements Cli

Version:

$Id$

Author:

jason van zyl

Field Summary

Fields

Modifier and Type	Field	Description
static char	DEBUG
static char	ERRORS
static char	HELP
static char	QUIET
static char	SET_SYSTEM_PROPERTY
static char	VERSION

Constructor Summary

Constructors

Constructor	Description
AbstractCli()

Method Summary

Modifier and Type	Method	Description
abstract org.apache.commons.cli.Options	buildCliOptions(org.apache.commons.cli.Options options)
org.apache.commons.cli.Options	buildDefaultCliOptions()
protected void	customizeContainerConfiguration(org.codehaus.plexus.ContainerConfiguration configuration, org.apache.commons.cli.CommandLine cli)
void	displayHelp()
int	execute(java.lang.String[] args)
int	execute(java.lang.String[] args, org.codehaus.plexus.classworlds.ClassWorld classWorld)
java.lang.String	getPomPropertiesPath()
abstract void	invokePlexusComponent(org.apache.commons.cli.CommandLine cli, org.codehaus.plexus.PlexusContainer container)
org.apache.commons.cli.CommandLine	parse(java.lang.String[] args)
protected void	showError(java.lang.String message, java.lang.Exception e, boolean show)
protected int	showFatalError(java.lang.String message, java.lang.Exception e, boolean show)

Methods inherited from class java.lang.Object

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

Field Detail

QUIET

public static final char QUIET

See Also:

Constant Field Values

DEBUG

public static final char DEBUG

See Also:

Constant Field Values

ERRORS

public static final char ERRORS

See Also:

Constant Field Values

HELP

public static final char HELP

See Also:

Constant Field Values

VERSION

public static final char VERSION

See Also:

Constant Field Values

SET_SYSTEM_PROPERTY

public static final char SET_SYSTEM_PROPERTY

See Also:

Constant Field Values

Constructor Detail

AbstractCli

public AbstractCli()

Method Detail

buildCliOptions

public abstract org.apache.commons.cli.Options buildCliOptions(org.apache.commons.cli.Options options)

Specified by:

buildCliOptions in interface Cli

invokePlexusComponent

public abstract void invokePlexusComponent(org.apache.commons.cli.CommandLine cli,
                                           org.codehaus.plexus.PlexusContainer container)
                                    throws java.lang.Exception

Specified by:

invokePlexusComponent in interface Cli

Throws:

java.lang.Exception

getPomPropertiesPath

public java.lang.String getPomPropertiesPath()

Specified by:

getPomPropertiesPath in interface Cli

execute

public int execute(java.lang.String[] args)

execute

public int execute(java.lang.String[] args,
                   org.codehaus.plexus.classworlds.ClassWorld classWorld)

customizeContainerConfiguration

protected void customizeContainerConfiguration(org.codehaus.plexus.ContainerConfiguration configuration,
                                               org.apache.commons.cli.CommandLine cli)

showFatalError

protected int showFatalError(java.lang.String message,
                             java.lang.Exception e,
                             boolean show)

showError

protected void showError(java.lang.String message,
                         java.lang.Exception e,
                         boolean show)

buildDefaultCliOptions

public org.apache.commons.cli.Options buildDefaultCliOptions()

parse

public org.apache.commons.cli.CommandLine parse(java.lang.String[] args)
                                         throws org.apache.commons.cli.ParseException

Throws:

org.apache.commons.cli.ParseException

displayHelp

public void displayHelp()