net.thevpc.nsh.options

Class NshOptions

java.lang.Object

net.thevpc.nsh.options.NshOptions

All Implemented Interfaces:

Cloneable

public class NshOptions
extends Object
implements Cloneable

Shell invocation flags and runtime execution state.

NshOptions holds the POSIX and Bash compatible command-line flags and runtime execution options for an NSH shell session. These options determine how the shell runs (e.g. interactive vs batch, bash dialect vs posix, debugging flags like xtrace or verbose, startup script files, etc.).

Unlike NshConfig, which handles engine construction and dependency injection (evaluator, executors, builtins, error handler), NshOptions represents the runtime session state. It is initialized from parsed command-line arguments (or configured programmatically via NshConfig.setOptions(NshOptions)), and can be dynamically modified during execution (for example via shell builtins like set -x or set -e).

Author:

vpc

See Also:

NshConfig, DefaultNshOptionsParser

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bash maximize compatibility with bash
boolean	command
List<String>	commandArgs
boolean	debugger
boolean	dumpPoStrings
boolean	dumpStrings
boolean	effectiveInteractive
boolean	errExit
boolean	exitAfterProcessingLines
boolean	interactive
boolean	login
boolean	noEditing
boolean	noProfile
boolean	noRc
boolean	posix
String	rcFile
boolean	readCommandsFromStdIn -s option
boolean	restricted
boolean	verbose
boolean	xtrace

Constructor Summary

Constructors

Constructor and Description
NshOptions()

Method Summary

Modifier and Type	Method and Description
NshOptions	clone()
NshOptions	copy() Creates a deep copy of this options instance.
List<String>	getCommandArgs()
List<String>	getFiles()
String	getRcFile()
String	getScriptName() Alias for getServiceName(), representing the script or command name ($0).
String	getServiceName() The script name or command invocation name (positional parameter $0).
String	getShutdownScript()
String	getStartupScript()
boolean	isBash()
boolean	isCommand()
boolean	isDebugger()
boolean	isDumpPoStrings()
boolean	isDumpStrings()
boolean	isEffectiveInteractive()
boolean	isErrExit()
boolean	isExitAfterProcessingLines()
boolean	isHelp()
boolean	isInteractive()
boolean	isLogin()
boolean	isNoEditing()
boolean	isNoProfile()
boolean	isNoRc()
boolean	isNsh()
boolean	isPosix()
boolean	isReadCommandsFromStdIn()
boolean	isRestricted()
boolean	isVerbose()
boolean	isVersion()
boolean	isXtrace()
NshOptions	setBash(boolean bash)
NshOptions	setCommand(boolean command)
NshOptions	setCommandArgs(List<String> commandArgs)
NshOptions	setDebugger(boolean debugger)
NshOptions	setDumpPoStrings(boolean dumpPoStrings)
NshOptions	setDumpStrings(boolean dumpStrings)
NshOptions	setEffectiveInteractive(boolean effectiveInteractive)
NshOptions	setErrExit(boolean errExit)
NshOptions	setExitAfterProcessingLines(boolean exitAfterProcessingLines)
NshOptions	setFiles(List<String> files)
NshOptions	setHelp(boolean help)
NshOptions	setInteractive(boolean interactive)
NshOptions	setLogin(boolean login)
NshOptions	setNoEditing(boolean noEditing)
NshOptions	setNoProfile(boolean noProfile)
NshOptions	setNoRc(boolean noRc)
NshOptions	setPosix(boolean posix)
NshOptions	setRcFile(String rcFile)
NshOptions	setReadCommandsFromStdIn(boolean readCommandsFromStdIn)
NshOptions	setRestricted(boolean restricted)
NshOptions	setScriptName(String scriptName) Alias for setServiceName(String), representing the script or command name ($0).
NshOptions	setServiceName(String serviceName) Sets the script name or command invocation name (positional parameter $0).
NshOptions	setShutdownScript(String shutdownScript)
NshOptions	setStartupScript(String startupScript)
NshOptions	setVerbose(boolean verbose)
NshOptions	setVersion(boolean version)
NshOptions	setXtrace(boolean xtrace)

Methods inherited from class java.lang.Object

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

Field Detail

verbose

public boolean verbose

xtrace

public boolean xtrace

errExit

public boolean errExit

restricted

public boolean restricted

interactive

public boolean interactive

effectiveInteractive

public boolean effectiveInteractive

posix

public boolean posix

exitAfterProcessingLines

public boolean exitAfterProcessingLines

bash

public boolean bash

maximize compatibility with bash

noRc

public boolean noRc

noProfile

public boolean noProfile

noEditing

public boolean noEditing

dumpPoStrings

public boolean dumpPoStrings

dumpStrings

public boolean dumpStrings

login

public boolean login

debugger

public boolean debugger

readCommandsFromStdIn

public boolean readCommandsFromStdIn

-s option

rcFile

public String rcFile

command

public boolean command

commandArgs

public List<String> commandArgs

Constructor Detail

NshOptions

public NshOptions()

Method Detail

isVerbose

public boolean isVerbose()

setVerbose

public NshOptions setVerbose(boolean verbose)

isXtrace

public boolean isXtrace()

setXtrace

public NshOptions setXtrace(boolean xtrace)

isRestricted

public boolean isRestricted()

setRestricted

public NshOptions setRestricted(boolean restricted)

isInteractive

public boolean isInteractive()

setInteractive

public NshOptions setInteractive(boolean interactive)

isPosix

public boolean isPosix()

setPosix

public NshOptions setPosix(boolean posix)

isNoRc

public boolean isNoRc()

setNoRc

public NshOptions setNoRc(boolean noRc)

isNoProfile

public boolean isNoProfile()

setNoProfile

public NshOptions setNoProfile(boolean noProfile)

isNoEditing

public boolean isNoEditing()

setNoEditing

public NshOptions setNoEditing(boolean noEditing)

isDumpPoStrings

public boolean isDumpPoStrings()

setDumpPoStrings

public NshOptions setDumpPoStrings(boolean dumpPoStrings)

isDumpStrings

public boolean isDumpStrings()

setDumpStrings

public NshOptions setDumpStrings(boolean dumpStrings)

isLogin

public boolean isLogin()

setLogin

public NshOptions setLogin(boolean login)

isDebugger

public boolean isDebugger()

setDebugger

public NshOptions setDebugger(boolean debugger)

getRcFile

public String getRcFile()

setRcFile

public NshOptions setRcFile(String rcFile)

isReadCommandsFromStdIn

public boolean isReadCommandsFromStdIn()

setReadCommandsFromStdIn

public NshOptions setReadCommandsFromStdIn(boolean readCommandsFromStdIn)

isBash

public boolean isBash()

setBash

public NshOptions setBash(boolean bash)

isCommand

public boolean isCommand()

setCommand

public NshOptions setCommand(boolean command)

getCommandArgs

public List<String> getCommandArgs()

setCommandArgs

public NshOptions setCommandArgs(List<String> commandArgs)

getFiles

public List<String> getFiles()

setFiles

public NshOptions setFiles(List<String> files)

isExitAfterProcessingLines

public boolean isExitAfterProcessingLines()

setExitAfterProcessingLines

public NshOptions setExitAfterProcessingLines(boolean exitAfterProcessingLines)

getServiceName

public String getServiceName()

The script name or command invocation name (positional parameter $0). If not explicitly set, defaults to the shell application's service name defined in NshConfig.getServiceName().

Returns:

script or invocation name ($0)

setServiceName

public NshOptions setServiceName(String serviceName)

Sets the script name or command invocation name (positional parameter $0).

Parameters:

serviceName - script or invocation name

Returns:

this instance

getScriptName

public String getScriptName()

Alias for getServiceName(), representing the script or command name ($0).

Returns:

script name ($0)

setScriptName

public NshOptions setScriptName(String scriptName)

Alias for setServiceName(String), representing the script or command name ($0).

Parameters:

scriptName - script name ($0)

Returns:

this instance

getStartupScript

public String getStartupScript()

setStartupScript

public NshOptions setStartupScript(String startupScript)

getShutdownScript

public String getShutdownScript()

setShutdownScript

public NshOptions setShutdownScript(String shutdownScript)

isVersion

public boolean isVersion()

setVersion

public NshOptions setVersion(boolean version)

isHelp

public boolean isHelp()

setHelp

public NshOptions setHelp(boolean help)

isEffectiveInteractive

public boolean isEffectiveInteractive()

setEffectiveInteractive

public NshOptions setEffectiveInteractive(boolean effectiveInteractive)

isErrExit

public boolean isErrExit()

setErrExit

public NshOptions setErrExit(boolean errExit)

isNsh

public boolean isNsh()

copy

public NshOptions copy()

Creates a deep copy of this options instance.

Returns:

a copy of this options

clone

public NshOptions clone()

Overrides:

clone in class Object