net.thevpc.nsh.cmd

Class NshBuiltinBase

java.lang.Object

net.thevpc.nsh.cmd.NshBuiltinBase

All Implemented Interfaces:

NshBuiltin, net.thevpc.nuts.spi.NComponent

Direct Known Subclasses:

NshBuiltinCore, NshBuiltinDefault

public abstract class NshBuiltinBase
extends Object
implements NshBuiltin

Author:

thevpc

Constructor Summary

Constructors

Constructor and Description
NshBuiltinBase(String name, Class<?> optionsSupplier)
NshBuiltinBase(String name, Supplier<?> optionsSupplier)

Method Summary

Modifier and Type	Method and Description
void	autoComplete(NshExecutionContext context, net.thevpc.nuts.cmdline.NCmdLineAutoComplete autoComplete)
protected net.thevpc.nuts.cmdline.NCmdLine	cmdLine(String[] args, NshExecutionContext context)
protected static Object	createOptions(Class<?> optionsClass)
void	exec(String[] args, NshExecutionContext context) exec and return error code
String	getHelp()
String	getHelpHeader()
String	getName()
protected void	init(net.thevpc.nuts.cmdline.NCmdLine cmdLine, NshExecutionContext context)
boolean	isEnabled()
protected abstract void	main(net.thevpc.nuts.cmdline.NCmdLine cmdLine, NshExecutionContext context)
protected abstract boolean	nextNonOption(net.thevpc.nuts.cmdline.NArg arg, net.thevpc.nuts.cmdline.NCmdLine cmdLine, NshExecutionContext context)
protected abstract boolean	nextOption(net.thevpc.nuts.cmdline.NArg arg, net.thevpc.nuts.cmdline.NCmdLine cmdLine, NshExecutionContext context)
void	setEnabled(boolean enabled)
protected void	throwExecutionException(Object errObject, int errorCode, net.thevpc.nuts.core.NSession session)
protected void	validate(net.thevpc.nuts.cmdline.NCmdLine cmdLine, NshExecutionContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

NshBuiltinBase

public NshBuiltinBase(String name,
                      Class<?> optionsSupplier)

NshBuiltinBase

public NshBuiltinBase(String name,
                      Supplier<?> optionsSupplier)

Method Detail

createOptions

protected static Object createOptions(Class<?> optionsClass)

nextOption

protected abstract boolean nextOption(net.thevpc.nuts.cmdline.NArg arg,
                                      net.thevpc.nuts.cmdline.NCmdLine cmdLine,
                                      NshExecutionContext context)

nextNonOption

protected abstract boolean nextNonOption(net.thevpc.nuts.cmdline.NArg arg,
                                         net.thevpc.nuts.cmdline.NCmdLine cmdLine,
                                         NshExecutionContext context)

main

protected abstract void main(net.thevpc.nuts.cmdline.NCmdLine cmdLine,
                             NshExecutionContext context)

validate

protected void validate(net.thevpc.nuts.cmdline.NCmdLine cmdLine,
                        NshExecutionContext context)

init

protected void init(net.thevpc.nuts.cmdline.NCmdLine cmdLine,
                    NshExecutionContext context)

autoComplete

public void autoComplete(NshExecutionContext context,
                         net.thevpc.nuts.cmdline.NCmdLineAutoComplete autoComplete)

Specified by:

autoComplete in interface NshBuiltin

getHelp

public String getHelp()

Specified by:

getHelp in interface NshBuiltin

getName

public String getName()

Specified by:

getName in interface NshBuiltin

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface NshBuiltin

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface NshBuiltin

getHelpHeader

public String getHelpHeader()

Specified by:

getHelpHeader in interface NshBuiltin

throwExecutionException

protected void throwExecutionException(Object errObject,
                                       int errorCode,
                                       net.thevpc.nuts.core.NSession session)

exec

public final void exec(String[] args,
                       NshExecutionContext context)

Description copied from interface: NshBuiltin

exec and return error code

Specified by:

exec in interface NshBuiltin

Parameters:

args - command

context - context

cmdLine

protected net.thevpc.nuts.cmdline.NCmdLine cmdLine(String[] args,
                                                   NshExecutionContext context)