net.thevpc.nsh

Class NshConfig

java.lang.Object

net.thevpc.nsh.NshConfig

All Implemented Interfaces:

Cloneable

public class NshConfig
extends Object
implements Cloneable

Shell engine construction and dependency-injection configuration.

NshConfig is used at shell initialization time (passed to Nsh(NshConfig)) to wire the shell engine's architecture and subsystems:

• Pluggable components: NshEvaluator, NshCommandTypeResolver, NshErrorHandler, NshExternalExecutor, NshHistory
• Builtin registry configuration: core builtins, default builtins, and custom filters
• Application identity: appId and serviceName (used for history files and properties)
• Command-line options: raw args, a custom NshOptionsParser, or pre-configured NshOptions

Difference between NshConfig and NshOptions

• NshConfig = Engine Wiring & Setup Configuration. Configures how the NSH engine itself is built, which components are injected, and which features are enabled. It is configured programmatically prior to shell startup.
• NshOptions = Session Runtime Flags & POSIX/Bash Options. Represents the command-line flags and runtime session state (such as -c, -i, --bash, --posix, -x, -e, startup scripts, and positional arguments). Can be modified dynamically at runtime (e.g. via set -x).

Author:

vpc

See Also:

Nsh, NshOptions

Constructor Summary

Constructors

Constructor and Description
NshConfig()

Method Summary

Modifier and Type	Method and Description
protected NshConfig	clone()
NshConfig	copy()
NId	getAppId()
String	getAppName() Alias for getServiceName(), representing the application/shell name.
String[]	getArgs()
Predicate<NshBuiltin>	getBuiltinFilter()
NshCommandTypeResolver	getCommandTypeResolver()
NshErrorHandler	getErrorHandler()
NshEvaluator	getEvaluator()
NshExternalExecutor	getExternalExecutor()
Supplier<NMsg>	getHeaderMessageSupplier()
NshHistory	getHistory()
Boolean	getIncludeCoreBuiltins()
Boolean	getIncludeDefaultBuiltins()
Boolean	getIncludeExternalExecutor()
Boolean	getIncludeHistory()
NshOptions	getOptions() Pre-configured shell invocation and runtime options.
NshOptionsParser	getOptionsParser()
String	getServiceName() The application or service identity name (e.g.
NshConfig	setAppId(NId appId)
NshConfig	setAppName(String appName) Alias for setServiceName(String), representing the application/shell name.
NshConfig	setArgs(String... args)
NshConfig	setBuiltinFilter(Predicate<NshBuiltin> builtinFilter)
NshConfig	setCommandTypeResolver(NshCommandTypeResolver commandTypeResolver)
NshConfig	setErrorHandler(NshErrorHandler errorHandler)
NshConfig	setEvaluator(NshEvaluator evaluator)
NshConfig	setExternalExecutor(NshExternalExecutor externalExecutor)
NshConfig	setHeaderMessageSupplier(Supplier<NMsg> headerMessageSupplier)
NshConfig	setHistory(NshHistory history)
NshConfig	setIncludeCoreBuiltins(Boolean includeCoreBuiltins)
NshConfig	setIncludeDefaultBuiltins(Boolean includeDefaultBuiltins)
NshConfig	setIncludeExternalExecutor(Boolean includeExternalExecutor)
NshConfig	setIncludeHistory(Boolean includeHistory)
NshConfig	setOptions(NshOptions options) Sets pre-configured shell invocation and runtime options.
NshConfig	setServiceName(String serviceName) Sets the application or service identity name.
NshConfig	setShellOptionsParser(NshOptionsParser shellOptionsParser)

Methods inherited from class java.lang.Object

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

Constructor Detail

NshConfig

public NshConfig()

Method Detail

getArgs

public String[] getArgs()

setArgs

public NshConfig setArgs(String... args)

getOptions

public NshOptions getOptions()

Pre-configured shell invocation and runtime options. If not provided, options will be parsed from getArgs() using getOptionsParser().

Returns:

pre-configured options, or null if unconfigured

setOptions

public NshConfig setOptions(NshOptions options)

Sets pre-configured shell invocation and runtime options.

Parameters:

options - pre-configured options

Returns:

this instance

getServiceName

public String getServiceName()

The application or service identity name (e.g. "nsh"). Used for the history filename (<serviceName>.history) and default shell prompt title. Defaults to appId.artifactId().

Returns:

service/application name

setServiceName

public NshConfig setServiceName(String serviceName)

Sets the application or service identity name.

Parameters:

serviceName - service/application name

Returns:

this instance

getAppName

public String getAppName()

Alias for getServiceName(), representing the application/shell name.

Returns:

application name

setAppName

public NshConfig setAppName(String appName)

Alias for setServiceName(String), representing the application/shell name.

Parameters:

appName - application name

Returns:

this instance

getOptionsParser

public NshOptionsParser getOptionsParser()

setShellOptionsParser

public NshConfig setShellOptionsParser(NshOptionsParser shellOptionsParser)

getEvaluator

public NshEvaluator getEvaluator()

setEvaluator

public NshConfig setEvaluator(NshEvaluator evaluator)

getCommandTypeResolver

public NshCommandTypeResolver getCommandTypeResolver()

setCommandTypeResolver

public NshConfig setCommandTypeResolver(NshCommandTypeResolver commandTypeResolver)

getErrorHandler

public NshErrorHandler getErrorHandler()

setErrorHandler

public NshConfig setErrorHandler(NshErrorHandler errorHandler)

getExternalExecutor

public NshExternalExecutor getExternalExecutor()

setExternalExecutor

public NshConfig setExternalExecutor(NshExternalExecutor externalExecutor)

getHistory

public NshHistory getHistory()

setHistory

public NshConfig setHistory(NshHistory history)

getAppId

public NId getAppId()

setAppId

public NshConfig setAppId(NId appId)

getBuiltinFilter

public Predicate<NshBuiltin> getBuiltinFilter()

setBuiltinFilter

public NshConfig setBuiltinFilter(Predicate<NshBuiltin> builtinFilter)

getHeaderMessageSupplier

public Supplier<NMsg> getHeaderMessageSupplier()

setHeaderMessageSupplier

public NshConfig setHeaderMessageSupplier(Supplier<NMsg> headerMessageSupplier)

getIncludeCoreBuiltins

public Boolean getIncludeCoreBuiltins()

setIncludeCoreBuiltins

public NshConfig setIncludeCoreBuiltins(Boolean includeCoreBuiltins)

getIncludeDefaultBuiltins

public Boolean getIncludeDefaultBuiltins()

setIncludeDefaultBuiltins

public NshConfig setIncludeDefaultBuiltins(Boolean includeDefaultBuiltins)

getIncludeExternalExecutor

public Boolean getIncludeExternalExecutor()

setIncludeExternalExecutor

public NshConfig setIncludeExternalExecutor(Boolean includeExternalExecutor)

getIncludeHistory

public Boolean getIncludeHistory()

setIncludeHistory

public NshConfig setIncludeHistory(Boolean includeHistory)

copy

public NshConfig copy()

clone

protected NshConfig clone()

Overrides:

clone in class Object