Package net.thevpc.naru.api.registry

Class NaruDirectiveBase

java.lang.Object

net.thevpc.naru.api.registry.NaruDirectiveBase

All Implemented Interfaces:

NaruDirective

public abstract class NaruDirectiveBase
extends Object
implements NaruDirective

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	NaruDirectiveBase.AbstractSubCommand
static interface	NaruDirectiveBase.SubCommand
class	NaruDirectiveBase.SubCommandHelp

Constructor Summary

Constructors

Constructor	Description
NaruDirectiveBase(String name, String group, String description, String... aliases)

Method Summary

Modifier and Type	Method	Description
protected void	addCandidates(List<NArgCompleteCandidate> candidates, String prefix, String... options)
NaruStmtResult	execute(NaruDirectiveCallContext context)	Execute the tool and return a string result that will be sent back to the model as a "tool" role message.
NaruStmtResult	executeHelp(NaruDirectiveCallContext context, NCmdLine cmdLine)
String[]	getAliases()
String	getDescription()	Human-readable description sent to the model.
String	group()
String	name()	Machine-readable name used in the tool schema (no spaces).
String	noCommand()
NaruDirectiveBase	noCommand(String noCommand)
protected void	register(NaruDirectiveBase.SubCommand sc)
List<NArgCompleteCandidate>	resolveCandidates(NCmdLine cmdLine, NArgCompletePosition pos, NaruSession session)	Resolve autocomplete candidates for this directive.
protected NOptional<NaruDirectiveBase.SubCommand>	subCommand(String name)

Methods inherited from class java.lang.Object

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

Constructor Details

NaruDirectiveBase

public NaruDirectiveBase(String name,
 String group,
 String description,
 String... aliases)

Method Details

noCommand

public String noCommand()

noCommand

public NaruDirectiveBase noCommand(String noCommand)

register

protected void register(NaruDirectiveBase.SubCommand sc)

subCommand

protected NOptional<NaruDirectiveBase.SubCommand> subCommand(String name)

group

public String group()

Specified by:

group in interface NaruDirective

getAliases

public String[] getAliases()

Specified by:

getAliases in interface NaruDirective

name

public String name()

Description copied from interface: NaruDirective

Machine-readable name used in the tool schema (no spaces).

Specified by:

name in interface NaruDirective

getDescription

public String getDescription()

Description copied from interface: NaruDirective

Human-readable description sent to the model.

Specified by:

getDescription in interface NaruDirective

addCandidates

protected void addCandidates(List<NArgCompleteCandidate> candidates,
 String prefix,
 String... options)

execute

public NaruStmtResult execute(NaruDirectiveCallContext context)

Description copied from interface: NaruDirective

Execute the tool and return a string result that will be sent back to the model as a "tool" role message.

Specified by:

execute in interface NaruDirective

Parameters:

context - per-run context (project dir, session, etc.)

Returns:

result string (text, JSON snippet, error message, …)

executeHelp

public NaruStmtResult executeHelp(NaruDirectiveCallContext context,
 NCmdLine cmdLine)

resolveCandidates

public List<NArgCompleteCandidate> resolveCandidates(NCmdLine cmdLine,
 NArgCompletePosition pos,
 NaruSession session)

Description copied from interface: NaruDirective

Resolve autocomplete candidates for this directive.

Specified by:

resolveCandidates in interface NaruDirective