DefaultNSession (Nuts Community Core Runtime 0.8.5.0 API)

java.lang.Object
- net.thevpc.nuts.runtime.standalone.session.DefaultNSession

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, NCmdLineConfigurable, NSession, NCopiable
```
public class DefaultNSession
extends Object
implements Cloneable, NSession, NCopiable
```
Created by vpc on 2/1/17.

Field Summary

Fields
Modifier and Type	Field and Description
`static InheritableThreadLocal<Stack<NSession>>`	`CURRENT_SESSION`
`protected List<String>`	`outputFormatOptions`
`protected NWorkspace`	`workspace`

Constructor Summary

Constructors
Constructor and Description

DefaultNSession(NWorkspace workspace)

DefaultNSession(NWorkspace workspace, NWorkspaceOptions options)

Constructors
Constructor and Description
`DefaultNSession(NWorkspace workspace)`
`DefaultNSession(NWorkspace workspace, NWorkspaceOptions options)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NSession`	`addListener(NListener listener)`
`NSession`	`addOutputFormatOptions(String... options)`
`NSession`	`ask()`
`NSession`	`bot()`
`<T> T`	`callWith(NCallable<T> callable)`
`void`	`close()`
`NSession`	`configure(boolean skipUnsupported, String... args)` configure the current command with the given arguments.
`NSession`	`configure(NWorkspaceOptions options)`
`boolean`	`configureFirst(NCmdLine cmdLine)`
`NSession`	`copy()`
`NSession`	`copyFrom(NBootOptions options)`
`NSession`	`copyFrom(NSession other)`
`NSession`	`copyFrom(NWorkspaceOptions options)`
`NSession`	`currentUser()`
`NSession`	`embedded()`
`NArrayElementBuilder`	`eout()`
`NPrintStream`	`err()`
`NSession`	`flush()`
`NOptional<Boolean>`	`getBot()`
`NOptional<Boolean>`	`getCached()`
`NOptional<NConfirmationMode>`	`getConfirm()`
`NOptional<String>`	`getDebug()`
`String`	`getDependencySolver()`
`NOptional<Boolean>`	`getDry()`
`NArrayElementBuilder`	`getElemOut()`
`String`	`getErrLinePrefix()`
`NOptional<NExecutionType>`	`getExecutionType()`
`NOptional<Instant>`	`getExpireTime()`
`NOptional<NFetchStrategy>`	`getFetchStrategy()`
`NOptional<Boolean>`	`getGui()`
`NOptional<Boolean>`	`getIndexed()`
`NIterableFormat`	`getIterableOutput()`
`List<NListener>`	`getListeners()`
`<T extends NListener> List<T>`	`getListeners(Class<T> type)`
`NOptional<String>`	`getLocale()`
`Filter`	`getLogFileFilter()`
`Level`	`getLogFileLevel()`
`Filter`	`getLogTermFilter()`
`Level`	`getLogTermLevel()`
`String`	`getOutLinePrefix()`
`NOptional<NContentType>`	`getOutputFormat()`
`List<String>`	`getOutputFormatOptions()`
`NOptional<Boolean>`	`getPreviewRepo()`
`String`	`getProgressOptions()`
`NPropertiesHolder`	`getPropertiesHolder()`
`NOptional<NRunAs>`	`getRunAs()`
`NOptional<Boolean>`	`getShowStacktrace()`
`NTerminal`	`getTerminal()`
`NOptional<Boolean>`	`getTrace()`
`Boolean`	`getTrace(boolean withDefaults)`
`NOptional<Boolean>`	`getTransitive()`
`NWorkspace`	`getWorkspace()`
`InputStream`	`in()`
`boolean`	`isAsk()`
`boolean`	`isBot()`
`boolean`	`isCached()`
`boolean`	`isDry()`
`boolean`	`isGui()`
`boolean`	`isIndexed()`
`boolean`	`isIterableOut()`
`boolean`	`isIterableTrace()`
`boolean`	`isNo()`
`boolean`	`isPlainOut()`
`boolean`	`isPlainTrace()`
`boolean`	`isPreviewRepo()`
`boolean`	`isProgress()`
`boolean`	`isStructuredOut()`
`boolean`	`isStructuredTrace()`
`boolean`	`isTrace()`
`boolean`	`isTransitive()`
`boolean`	`isYes()`
`NSession`	`json()`
`NSession`	`no()`
`NPrintStream`	`out()`
`NSession`	`plain()`
`NSession`	`props()`
`NSession`	`removeListener(NListener listener)`
`NSession`	`root()`
`void`	`runWith(NRunnable runnable)`
`NSession`	`setBot(Boolean bot)`
`NSession`	`setCached(Boolean value)`
`NSession`	`setConfirm(NConfirmationMode confirm)`
`NSession`	`setDebug(String debug)`
`NSession`	`setDependencySolver(String dependencySolver)`
`NSession`	`setDry(Boolean dry)`
`NSession`	`setElemOut(NArrayElementBuilder eout)`
`NSession`	`setErrLinePrefix(String errLinePrefix)`
`NSession`	`setExecutionType(NExecutionType executionType)`
`NSession`	`setExpireTime(Instant expireTime)`
`NSession`	`setFetchStrategy(NFetchStrategy mode)`
`NSession`	`setGui(Boolean gui)`
`NSession`	`setIndexed(Boolean value)`
`NSession`	`setIterableOut(boolean iterableOut)`
`NSession`	`setLocale(String locale)`
`NSession`	`setLogFileFilter(Filter logFileFilter)`
`NSession`	`setLogFileLevel(Level logFileLevel)`
`NSession`	`setLogFilter(Filter filter)`
`NSession`	`setLogTermLevel(Level level)`
`NSession`	`setOutLinePrefix(String outLinePrefix)`
`NSession`	`setOutputFormat(NContentType outputFormat)`
`NSession`	`setOutputFormatOptions(List<String> options)`
`NSession`	`setOutputFormatOptions(String... options)`
`NSession`	`setPreviewRepo(Boolean bot)`
`NSession`	`setProgressOptions(String progressOptions)`
`NSession`	`setRunAs(NRunAs runAs)`
`NSession`	`setShowStacktrace(Boolean showStacktrace)`
`NSession`	`setTerminal(NTerminal terminal)`
`NSession`	`setTrace(Boolean trace)`
`NSession`	`setTransitive(Boolean value)`
`NSession`	`spawn()`
`NSession`	`sudo()`
`NSession`	`system()`
`NSession`	`table()`
`String`	`toString()`
`NSession`	`trace()`
`NSession`	`tree()`
`NSession`	`xml()`
`NSession`	`yes()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.thevpc.nuts.NSession
get, of

Methods inherited from interface net.thevpc.nuts.cmdline.NCmdLineConfigurable
configure, configure, configureLast

- Field Detail
  - CURRENT_SESSION
```
public static final InheritableThreadLocal<Stack<NSession>> CURRENT_SESSION
```
  - workspace
```
protected NWorkspace workspace
```
  - outputFormatOptions
```
protected List<String> outputFormatOptions
```
- Constructor Detail
  - DefaultNSession
```
public DefaultNSession(NWorkspace workspace)
```
  - DefaultNSession
```
public DefaultNSession(NWorkspace workspace,
                       NWorkspaceOptions options)
```
- Method Detail
  - runWith
```
public void runWith(NRunnable runnable)
```
    Specified by:
    
    runWith in interface NSession
  - callWith
```
public <T> T callWith(NCallable<T> callable)
```
    Specified by:
    
    callWith in interface NSession
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface NSession
  - configure
```
public final NSession configure(boolean skipUnsupported,
                                String... args)
```
    configure the current command with the given arguments. This is an override of the NCmdLineConfigurable.configure(boolean, java.lang.String...) to help return a more specific return type;
    
    Specified by:
    
    configure in interface NCmdLineConfigurable
    
    Parameters:
    
    args - argument to configure with
    
    Returns:
    
    this instance
  - configureFirst
```
public boolean configureFirst(NCmdLine cmdLine)
```
    Specified by:
    
    configureFirst in interface NCmdLineConfigurable
  - getTrace
```
public NOptional<Boolean> getTrace()
```
    Specified by:
    
    getTrace in interface NSession
  - getTrace
```
public Boolean getTrace(boolean withDefaults)
```
    Specified by:
    
    getTrace in interface NSession
  - isTrace
```
public boolean isTrace()
```
    Specified by:
    
    isTrace in interface NSession
  - trace
```
public NSession trace()
```
    Specified by:
    
    trace in interface NSession
  - setTrace
```
public NSession setTrace(Boolean trace)
```
    Specified by:
    
    setTrace in interface NSession
  - isPlainTrace
```
public boolean isPlainTrace()
```
    Specified by:
    
    isPlainTrace in interface NSession
  - isIterableTrace
```
public boolean isIterableTrace()
```
    Specified by:
    
    isIterableTrace in interface NSession
  - isStructuredTrace
```
public boolean isStructuredTrace()
```
    Specified by:
    
    isStructuredTrace in interface NSession
  - isIterableOut
```
public boolean isIterableOut()
```
    Specified by:
    
    isIterableOut in interface NSession
  - setIterableOut
```
public NSession setIterableOut(boolean iterableOut)
```
    Specified by:
    
    setIterableOut in interface NSession
  - isStructuredOut
```
public boolean isStructuredOut()
```
    Specified by:
    
    isStructuredOut in interface NSession
  - getElemOut
```
public NArrayElementBuilder getElemOut()
```
    Specified by:
    
    getElemOut in interface NSession
  - setElemOut
```
public NSession setElemOut(NArrayElementBuilder eout)
```
    Specified by:
    
    setElemOut in interface NSession
  - isPlainOut
```
public boolean isPlainOut()
```
    Specified by:
    
    isPlainOut in interface NSession
  - getBot
```
public NOptional<Boolean> getBot()
```
    Specified by:
    
    getBot in interface NSession
  - getPreviewRepo
```
public NOptional<Boolean> getPreviewRepo()
```
    Specified by:
    
    getPreviewRepo in interface NSession
  - isPreviewRepo
```
public boolean isPreviewRepo()
```
    Specified by:
    
    isPreviewRepo in interface NSession
  - isBot
```
public boolean isBot()
```
    Specified by:
    
    isBot in interface NSession
  - setBot
```
public NSession setBot(Boolean bot)
```
    Specified by:
    
    setBot in interface NSession
  - setPreviewRepo
```
public NSession setPreviewRepo(Boolean bot)
```
    Specified by:
    
    setPreviewRepo in interface NSession
  - bot
```
public NSession bot()
```
    Specified by:
    
    bot in interface NSession
  - yes
```
public NSession yes()
```
    Specified by:
    
    yes in interface NSession
  - no
```
public NSession no()
```
    Specified by:
    
    no in interface NSession
  - ask
```
public NSession ask()
```
    Specified by:
    
    ask in interface NSession
  - isYes
```
public boolean isYes()
```
    Specified by:
    
    isYes in interface NSession
  - isNo
```
public boolean isNo()
```
    Specified by:
    
    isNo in interface NSession
  - isAsk
```
public boolean isAsk()
```
    Specified by:
    
    isAsk in interface NSession
  - getOutputFormat
```
public NOptional<NContentType> getOutputFormat()
```
    Specified by:
    
    getOutputFormat in interface NSession
  - setOutputFormat
```
public NSession setOutputFormat(NContentType outputFormat)
```
    Specified by:
    
    setOutputFormat in interface NSession
  - json
```
public NSession json()
```
    Specified by:
    
    json in interface NSession
  - plain
```
public NSession plain()
```
    Specified by:
    
    plain in interface NSession
  - props
```
public NSession props()
```
    Specified by:
    
    props in interface NSession
  - tree
```
public NSession tree()
```
    Specified by:
    
    tree in interface NSession
  - table
```
public NSession table()
```
    Specified by:
    
    table in interface NSession
  - xml
```
public NSession xml()
```
    Specified by:
    
    xml in interface NSession
  - copy
```
public NSession copy()
```
    Specified by:
    
    copy in interface NSession
    
    Specified by:
    
    copy in interface NCopiable
  - copyFrom
```
public NSession copyFrom(NSession other)
```
    Specified by:
    
    copyFrom in interface NSession
  - copyFrom
```
public NSession copyFrom(NWorkspaceOptions options)
```
    Specified by:
    
    copyFrom in interface NSession
  - copyFrom
```
public NSession copyFrom(NBootOptions options)
```
  - getFetchStrategy
```
public NOptional<NFetchStrategy> getFetchStrategy()
```
    Specified by:
    
    getFetchStrategy in interface NSession
  - setFetchStrategy
```
public NSession setFetchStrategy(NFetchStrategy mode)
```
    Specified by:
    
    setFetchStrategy in interface NSession
  - addListener
```
public NSession addListener(NListener listener)
```
    Specified by:
    
    addListener in interface NSession
  - removeListener
```
public NSession removeListener(NListener listener)
```
    Specified by:
    
    removeListener in interface NSession
  - getListeners
```
public <T extends NListener> List<T> getListeners(Class<T> type)
```
    Specified by:
    
    getListeners in interface NSession
  - getListeners
```
public List<NListener> getListeners()
```
    Specified by:
    
    getListeners in interface NSession
  - getPropertiesHolder
```
public NPropertiesHolder getPropertiesHolder()
```
  - getConfirm
```
public NOptional<NConfirmationMode> getConfirm()
```
    Specified by:
    
    getConfirm in interface NSession
  - setConfirm
```
public NSession setConfirm(NConfirmationMode confirm)
```
    Specified by:
    
    setConfirm in interface NSession
  - addOutputFormatOptions
```
public NSession addOutputFormatOptions(String... options)
```
    Specified by:
    
    addOutputFormatOptions in interface NSession
  - getOutputFormatOptions
```
public List<String> getOutputFormatOptions()
```
    Specified by:
    
    getOutputFormatOptions in interface NSession
  - setOutputFormatOptions
```
public NSession setOutputFormatOptions(String... options)
```
    Specified by:
    
    setOutputFormatOptions in interface NSession
  - setOutputFormatOptions
```
public NSession setOutputFormatOptions(List<String> options)
```
    Specified by:
    
    setOutputFormatOptions in interface NSession
  - out
```
public NPrintStream out()
```
    Specified by:
    
    out in interface NSession
  - in
```
public InputStream in()
```
    Specified by:
    
    in in interface NSession
  - err
```
public NPrintStream err()
```
    Specified by:
    
    err in interface NSession
  - getIterableOutput
```
public NIterableFormat getIterableOutput()
```
    Specified by:
    
    getIterableOutput in interface NSession
  - getTerminal
```
public NTerminal getTerminal()
```
    Specified by:
    
    getTerminal in interface NSession
  - setTerminal
```
public NSession setTerminal(NTerminal terminal)
```
    Specified by:
    
    setTerminal in interface NSession
  - getWorkspace
```
public NWorkspace getWorkspace()
```
    Specified by:
    
    getWorkspace in interface NSession
  - getTransitive
```
public NOptional<Boolean> getTransitive()
```
    Specified by:
    
    getTransitive in interface NSession
  - isTransitive
```
public boolean isTransitive()
```
    Specified by:
    
    isTransitive in interface NSession
  - setTransitive
```
public NSession setTransitive(Boolean value)
```
    Specified by:
    
    setTransitive in interface NSession
  - getCached
```
public NOptional<Boolean> getCached()
```
    Specified by:
    
    getCached in interface NSession
  - isCached
```
public boolean isCached()
```
    Specified by:
    
    isCached in interface NSession
  - setCached
```
public NSession setCached(Boolean value)
```
    Specified by:
    
    setCached in interface NSession
  - getIndexed
```
public NOptional<Boolean> getIndexed()
```
    Specified by:
    
    getIndexed in interface NSession
  - isIndexed
```
public boolean isIndexed()
```
    Specified by:
    
    isIndexed in interface NSession
  - setIndexed
```
public NSession setIndexed(Boolean value)
```
    Specified by:
    
    setIndexed in interface NSession
  - getExpireTime
```
public NOptional<Instant> getExpireTime()
```
    Specified by:
    
    getExpireTime in interface NSession
  - setExpireTime
```
public NSession setExpireTime(Instant expireTime)
```
    Specified by:
    
    setExpireTime in interface NSession
  - getProgressOptions
```
public String getProgressOptions()
```
    Specified by:
    
    getProgressOptions in interface NSession
  - isProgress
```
public boolean isProgress()
```
    Specified by:
    
    isProgress in interface NSession
  - setProgressOptions
```
public NSession setProgressOptions(String progressOptions)
```
    Specified by:
    
    setProgressOptions in interface NSession
  - getGui
```
public NOptional<Boolean> getGui()
```
    Specified by:
    
    getGui in interface NSession
  - isGui
```
public boolean isGui()
```
    Specified by:
    
    isGui in interface NSession
  - setGui
```
public NSession setGui(Boolean gui)
```
    Specified by:
    
    setGui in interface NSession
  - getErrLinePrefix
```
public String getErrLinePrefix()
```
    Specified by:
    
    getErrLinePrefix in interface NSession
  - setErrLinePrefix
```
public NSession setErrLinePrefix(String errLinePrefix)
```
    Specified by:
    
    setErrLinePrefix in interface NSession
  - getOutLinePrefix
```
public String getOutLinePrefix()
```
    Specified by:
    
    getOutLinePrefix in interface NSession
  - setOutLinePrefix
```
public NSession setOutLinePrefix(String outLinePrefix)
```
    Specified by:
    
    setOutLinePrefix in interface NSession
  - getDry
```
public NOptional<Boolean> getDry()
```
    Specified by:
    
    getDry in interface NSession
  - getShowStacktrace
```
public NOptional<Boolean> getShowStacktrace()
```
    Specified by:
    
    getShowStacktrace in interface NSession
  - isDry
```
public boolean isDry()
```
    Specified by:
    
    isDry in interface NSession
  - setDry
```
public NSession setDry(Boolean dry)
```
    Specified by:
    
    setDry in interface NSession
  - setShowStacktrace
```
public NSession setShowStacktrace(Boolean showStacktrace)
```
    Specified by:
    
    setShowStacktrace in interface NSession
  - getLogTermLevel
```
public Level getLogTermLevel()
```
    Specified by:
    
    getLogTermLevel in interface NSession
  - setLogTermLevel
```
public NSession setLogTermLevel(Level level)
```
    Specified by:
    
    setLogTermLevel in interface NSession
  - getLogTermFilter
```
public Filter getLogTermFilter()
```
    Specified by:
    
    getLogTermFilter in interface NSession
  - setLogFilter
```
public NSession setLogFilter(Filter filter)
```
    Specified by:
    
    setLogFilter in interface NSession
  - configure
```
public NSession configure(NWorkspaceOptions options)
```
    Specified by:
    
    configure in interface NSession
  - getLogFileLevel
```
public Level getLogFileLevel()
```
    Specified by:
    
    getLogFileLevel in interface NSession
  - setLogFileLevel
```
public NSession setLogFileLevel(Level logFileLevel)
```
    Specified by:
    
    setLogFileLevel in interface NSession
  - getLogFileFilter
```
public Filter getLogFileFilter()
```
    Specified by:
    
    getLogFileFilter in interface NSession
  - setLogFileFilter
```
public NSession setLogFileFilter(Filter logFileFilter)
```
    Specified by:
    
    setLogFileFilter in interface NSession
  - eout
```
public NArrayElementBuilder eout()
```
    Specified by:
    
    eout in interface NSession
  - flush
```
public NSession flush()
```
    Specified by:
    
    flush in interface NSession
  - getExecutionType
```
public NOptional<NExecutionType> getExecutionType()
```
    Specified by:
    
    getExecutionType in interface NSession
  - embedded
```
public NSession embedded()
```
    Specified by:
    
    embedded in interface NSession
  - system
```
public NSession system()
```
    Specified by:
    
    system in interface NSession
  - spawn
```
public NSession spawn()
```
    Specified by:
    
    spawn in interface NSession
  - setExecutionType
```
public NSession setExecutionType(NExecutionType executionType)
```
    Specified by:
    
    setExecutionType in interface NSession
  - getDebug
```
public NOptional<String> getDebug()
```
    Specified by:
    
    getDebug in interface NSession
  - setDebug
```
public NSession setDebug(String debug)
```
    Specified by:
    
    setDebug in interface NSession
  - getLocale
```
public NOptional<String> getLocale()
```
    Specified by:
    
    getLocale in interface NSession
  - setLocale
```
public NSession setLocale(String locale)
```
    Specified by:
    
    setLocale in interface NSession
  - getRunAs
```
public NOptional<NRunAs> getRunAs()
```
    Specified by:
    
    getRunAs in interface NSession
  - setRunAs
```
public NSession setRunAs(NRunAs runAs)
```
    Specified by:
    
    setRunAs in interface NSession
  - sudo
```
public NSession sudo()
```
    Specified by:
    
    sudo in interface NSession
  - root
```
public NSession root()
```
    Specified by:
    
    root in interface NSession
  - currentUser
```
public NSession currentUser()
```
    Specified by:
    
    currentUser in interface NSession
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getDependencySolver
```
public String getDependencySolver()
```
    Specified by:
    
    getDependencySolver in interface NSession
  - setDependencySolver
```
public NSession setDependencySolver(String dependencySolver)
```
    Specified by:
    
    setDependencySolver in interface NSession

Class DefaultNSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.thevpc.nuts.NSession

Methods inherited from interface net.thevpc.nuts.cmdline.NCmdLineConfigurable

Field Detail

CURRENT_SESSION

workspace

outputFormatOptions

Constructor Detail

DefaultNSession

DefaultNSession

Method Detail

runWith

callWith

close

configure

configureFirst

getTrace

getTrace

isTrace

trace

setTrace

isPlainTrace

isIterableTrace

isStructuredTrace

isIterableOut

setIterableOut

isStructuredOut

getElemOut

setElemOut

isPlainOut

getBot

getPreviewRepo

isPreviewRepo

isBot

setBot

setPreviewRepo

bot

yes

no

ask

isYes

isNo

isAsk

getOutputFormat

setOutputFormat

json

plain

props

tree

table

xml

copy

copyFrom

copyFrom

copyFrom

getFetchStrategy

setFetchStrategy

addListener

removeListener

getListeners

getListeners

getPropertiesHolder

getConfirm

setConfirm

addOutputFormatOptions

getOutputFormatOptions

setOutputFormatOptions

setOutputFormatOptions

out

in

err

getIterableOutput

getTerminal

setTerminal

getWorkspace

getTransitive