net.thevpc.nuts.runtime.core

Class DefaultNutsSession

java.lang.Object

net.thevpc.nuts.runtime.core.DefaultNutsSession

All Implemented Interfaces:

Cloneable, NutsCommandLineConfigurable, NutsSession

public class DefaultNutsSession
extends Object
implements Cloneable, NutsSession

Created by vpc on 2/1/17.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	outputFormatOptions
protected NutsWorkspace	ws

Constructor Summary

Constructors

Constructor and Description
DefaultNutsSession(NutsWorkspace ws)
DefaultNutsSession(NutsWorkspace ws, NutsWorkspaceOptions options)

Method Summary

Modifier and Type	Method and Description
NutsSession	addListener(NutsListener listener)
NutsSession	addOutputFormatOptions(String... options)
boolean	configure(boolean skipUnsupported, NutsCommandLine commandLine) configure the current command with the given arguments.
Object	configure(boolean skipUnsupported, String... args) configure the current command with the given arguments.
NutsSession	configure(NutsWorkspaceOptions options)
boolean	configureFirst(NutsCommandLine cmdLine)
NutsSession	copy()
NutsSession	copyFrom(NutsSession other)
NutsSession	copyFrom(NutsWorkspaceOptions options)
NutsArrayElementBuilder	eout()
NutsPrintStream	err()
NutsSession	flush()
NutsId	getAppId()
Boolean	getBot()
NutsConfirmationMode	getConfirm()
Boolean	getDebug()
NutsArrayElementBuilder	getElemOut()
String	getErrLinePrefix()
NutsExecutionType	getExecutionType()
Instant	getExpireTime()
NutsFetchStrategy	getFetchStrategy()
NutsIterableFormat	getIterableOutput()
NutsListener[]	getListeners()
<T extends NutsListener> T[]	getListeners(Class<T> type)
String	getLocale()
Filter	getLogFileFilter()
Level	getLogFileLevel()
Filter	getLogTermFilter()
Level	getLogTermLevel()
String	getOutLinePrefix()
NutsContentType	getOutputFormat()
NutsContentType	getOutputFormat(NutsContentType defaultValue)
String[]	getOutputFormatOptions()
NutsContentType	getPreferredOutputFormat()
String	getProgressOptions()
Map<String,Object>	getProperties()
Object	getProperty(String key)
NutsRunAs	getRunAs()
NutsSessionTerminal	getTerminal()
NutsWorkspace	getWorkspace()
InputStream	in()
boolean	isAsk()
boolean	isBot()
boolean	isCached()
boolean	isDebug()
boolean	isDry()
boolean	isGui()
boolean	isIndexed()
boolean	isIterableOut()
boolean	isIterableTrace()
boolean	isNo()
boolean	isPlainOut()
boolean	isPlainTrace()
boolean	isStructuredOut()
boolean	isStructuredTrace()
boolean	isTrace()
boolean	isTransitive()
boolean	isYes()
NutsSession	json()
NutsPrintStream	out()
NutsSession	plain()
NutsSession	props()
NutsSession	removeListener(NutsListener listener)
NutsSession	setAppId(NutsId appId)
NutsSession	setBot(Boolean bot)
NutsSession	setCached(Boolean value)
NutsSession	setConfirm(NutsConfirmationMode confirm)
NutsSession	setDebug(Boolean debug)
NutsSession	setDry(Boolean dry)
NutsSession	setElemOut(NutsArrayElementBuilder eout)
NutsSession	setErrLinePrefix(String errLinePrefix)
NutsSession	setExecutionType(NutsExecutionType executionType)
NutsSession	setExpireTime(Instant expireTime)
NutsSession	setFetchStrategy(NutsFetchStrategy mode)
NutsSession	setGui(Boolean gui)
NutsSession	setIndexed(Boolean value)
NutsSession	setIterableOut(boolean iterableOut)
NutsSession	setLocale(String locale)
NutsSession	setLogFileFilter(Filter logFileFilter)
NutsSession	setLogFileLevel(Level logFileLevel)
NutsSession	setLogFilter(Filter filter)
NutsSession	setLogLevel(Level level)
NutsSession	setOutLinePrefix(String outLinePrefix)
NutsSession	setOutputFormat(NutsContentType outputFormat)
NutsSession	setOutputFormatOptions(String... options)
NutsSession	setProgressOptions(String progressOptions)
NutsSession	setProperties(Map<String,Object> properties)
NutsSession	setProperty(String key, Object value)
NutsSession	setRunAs(NutsRunAs runAs)
NutsSession	setTerminal(NutsSessionTerminal terminal)
NutsSession	setTrace(Boolean trace)
NutsSession	setTransitive(Boolean value)
NutsSession	table()
String	toString()
NutsSession	tree()
NutsSession	xml()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.thevpc.nuts.NutsCommandLineConfigurable

configureLast

Field Detail

ws

protected NutsWorkspace ws

outputFormatOptions

protected List<String> outputFormatOptions

Constructor Detail

DefaultNutsSession

public DefaultNutsSession(NutsWorkspace ws)

DefaultNutsSession

public DefaultNutsSession(NutsWorkspace ws,
                          NutsWorkspaceOptions options)

Method Detail

configure

public Object configure(boolean skipUnsupported,
                        String... args)

configure the current command with the given arguments. This is an override of the NutsCommandLineConfigurable.configure(boolean, java.lang.String...) to help return a more specific return type;

Specified by:

configure in interface NutsCommandLineConfigurable

Parameters:

args - argument to configure with

Returns:

this instance

configure

public final boolean configure(boolean skipUnsupported,
                               NutsCommandLine commandLine)

configure the current command with the given arguments.

Specified by:

configure in interface NutsCommandLineConfigurable

Parameters:

skipUnsupported - when true, all unsupported options are skipped silently

commandLine - arguments to configure with

Returns:

this instance

configureFirst

public boolean configureFirst(NutsCommandLine cmdLine)

Specified by:

configureFirst in interface NutsCommandLineConfigurable

getPreferredOutputFormat

public NutsContentType getPreferredOutputFormat()

isTrace

public boolean isTrace()

Specified by:

isTrace in interface NutsSession

setTrace

public NutsSession setTrace(Boolean trace)

Specified by:

setTrace in interface NutsSession

isPlainTrace

public boolean isPlainTrace()

Specified by:

isPlainTrace in interface NutsSession

isIterableTrace

public boolean isIterableTrace()

Specified by:

isIterableTrace in interface NutsSession

isStructuredTrace

public boolean isStructuredTrace()

Specified by:

isStructuredTrace in interface NutsSession

isIterableOut

public boolean isIterableOut()

Specified by:

isIterableOut in interface NutsSession

setIterableOut

public NutsSession setIterableOut(boolean iterableOut)

Specified by:

setIterableOut in interface NutsSession

isStructuredOut

public boolean isStructuredOut()

Specified by:

isStructuredOut in interface NutsSession

getElemOut

public NutsArrayElementBuilder getElemOut()

Specified by:

getElemOut in interface NutsSession

setElemOut

public NutsSession setElemOut(NutsArrayElementBuilder eout)

Specified by:

setElemOut in interface NutsSession

isPlainOut

public boolean isPlainOut()

Specified by:

isPlainOut in interface NutsSession

isBot

public boolean isBot()

Specified by:

isBot in interface NutsSession

getBot

public Boolean getBot()

Specified by:

getBot in interface NutsSession

setBot

public NutsSession setBot(Boolean bot)

Specified by:

setBot in interface NutsSession

isYes

public boolean isYes()

Specified by:

isYes in interface NutsSession

isNo

public boolean isNo()

Specified by:

isNo in interface NutsSession

isAsk

public boolean isAsk()

Specified by:

isAsk in interface NutsSession

getOutputFormat

public NutsContentType getOutputFormat(NutsContentType defaultValue)

Specified by:

getOutputFormat in interface NutsSession

getOutputFormat

public NutsContentType getOutputFormat()

Specified by:

getOutputFormat in interface NutsSession

setOutputFormat

public NutsSession setOutputFormat(NutsContentType outputFormat)

Specified by:

setOutputFormat in interface NutsSession

json

public NutsSession json()

Specified by:

json in interface NutsSession

plain

public NutsSession plain()

Specified by:

plain in interface NutsSession

props

public NutsSession props()

Specified by:

props in interface NutsSession

tree

public NutsSession tree()

Specified by:

tree in interface NutsSession

table

public NutsSession table()

Specified by:

table in interface NutsSession

xml

public NutsSession xml()

Specified by:

xml in interface NutsSession

copy

public NutsSession copy()

Specified by:

copy in interface NutsSession

copyFrom

public NutsSession copyFrom(NutsSession other)

Specified by:

copyFrom in interface NutsSession

copyFrom

public NutsSession copyFrom(NutsWorkspaceOptions options)

Specified by:

copyFrom in interface NutsSession

getAppId

public NutsId getAppId()

Specified by:

getAppId in interface NutsSession

setAppId

public NutsSession setAppId(NutsId appId)

Specified by:

setAppId in interface NutsSession

getFetchStrategy

public NutsFetchStrategy getFetchStrategy()

Specified by:

getFetchStrategy in interface NutsSession

setFetchStrategy

public NutsSession setFetchStrategy(NutsFetchStrategy mode)

Specified by:

setFetchStrategy in interface NutsSession

addListener

public NutsSession addListener(NutsListener listener)

Specified by:

addListener in interface NutsSession

removeListener

public NutsSession removeListener(NutsListener listener)

Specified by:

removeListener in interface NutsSession

getListeners

public <T extends NutsListener> T[] getListeners(Class<T> type)

Specified by:

getListeners in interface NutsSession

getListeners

public NutsListener[] getListeners()

Specified by:

getListeners in interface NutsSession

setProperty

public NutsSession setProperty(String key,
                               Object value)

Specified by:

setProperty in interface NutsSession

getProperties

public Map<String,Object> getProperties()

Specified by:

getProperties in interface NutsSession

setProperties

public NutsSession setProperties(Map<String,Object> properties)

Specified by:

setProperties in interface NutsSession

getProperty

public Object getProperty(String key)

Specified by:

getProperty in interface NutsSession

getConfirm

public NutsConfirmationMode getConfirm()

Specified by:

getConfirm in interface NutsSession

setConfirm

public NutsSession setConfirm(NutsConfirmationMode confirm)

Specified by:

setConfirm in interface NutsSession

addOutputFormatOptions

public NutsSession addOutputFormatOptions(String... options)

Specified by:

addOutputFormatOptions in interface NutsSession

getOutputFormatOptions

public String[] getOutputFormatOptions()

Specified by:

getOutputFormatOptions in interface NutsSession

setOutputFormatOptions

public NutsSession setOutputFormatOptions(String... options)

Specified by:

setOutputFormatOptions in interface NutsSession

out

public NutsPrintStream out()

Specified by:

out in interface NutsSession

in

public InputStream in()

Specified by:

in in interface NutsSession

err

public NutsPrintStream err()

Specified by:

err in interface NutsSession

getIterableOutput

public NutsIterableFormat getIterableOutput()

Specified by:

getIterableOutput in interface NutsSession

getTerminal

public NutsSessionTerminal getTerminal()

Specified by:

getTerminal in interface NutsSession

setTerminal

public NutsSession setTerminal(NutsSessionTerminal terminal)

Specified by:

setTerminal in interface NutsSession

getWorkspace

public NutsWorkspace getWorkspace()

Specified by:

getWorkspace in interface NutsSession

isTransitive

public boolean isTransitive()

Specified by:

isTransitive in interface NutsSession

setTransitive

public NutsSession setTransitive(Boolean value)

Specified by:

setTransitive in interface NutsSession

isCached

public boolean isCached()

Specified by:

isCached in interface NutsSession

setCached

public NutsSession setCached(Boolean value)

Specified by:

setCached in interface NutsSession

isIndexed

public boolean isIndexed()

Specified by:

isIndexed in interface NutsSession

setIndexed

public NutsSession setIndexed(Boolean value)

Specified by:

setIndexed in interface NutsSession

getExpireTime

public Instant getExpireTime()

Specified by:

getExpireTime in interface NutsSession

setExpireTime

public NutsSession setExpireTime(Instant expireTime)

Specified by:

setExpireTime in interface NutsSession

getProgressOptions

public String getProgressOptions()

Specified by:

getProgressOptions in interface NutsSession

setProgressOptions

public NutsSession setProgressOptions(String progressOptions)

Specified by:

setProgressOptions in interface NutsSession

isGui

public boolean isGui()

Specified by:

isGui in interface NutsSession

setGui

public NutsSession setGui(Boolean gui)

Specified by:

setGui in interface NutsSession

getErrLinePrefix

public String getErrLinePrefix()

Specified by:

getErrLinePrefix in interface NutsSession

setErrLinePrefix

public NutsSession setErrLinePrefix(String errLinePrefix)

Specified by:

setErrLinePrefix in interface NutsSession

getOutLinePrefix

public String getOutLinePrefix()

Specified by:

getOutLinePrefix in interface NutsSession

setOutLinePrefix

public NutsSession setOutLinePrefix(String outLinePrefix)

Specified by:

setOutLinePrefix in interface NutsSession

isDry

public boolean isDry()

Specified by:

isDry in interface NutsSession

setDry

public NutsSession setDry(Boolean dry)

Specified by:

setDry in interface NutsSession

getLogTermLevel

public Level getLogTermLevel()

Specified by:

getLogTermLevel in interface NutsSession

setLogLevel

public NutsSession setLogLevel(Level level)

Specified by:

setLogLevel in interface NutsSession

getLogTermFilter

public Filter getLogTermFilter()

Specified by:

getLogTermFilter in interface NutsSession

setLogFilter

public NutsSession setLogFilter(Filter filter)

Specified by:

setLogFilter in interface NutsSession

configure

public NutsSession configure(NutsWorkspaceOptions options)

Specified by:

configure in interface NutsSession

getLogFileLevel

public Level getLogFileLevel()

Specified by:

getLogFileLevel in interface NutsSession

setLogFileLevel

public NutsSession setLogFileLevel(Level logFileLevel)

Specified by:

setLogFileLevel in interface NutsSession

getLogFileFilter

public Filter getLogFileFilter()

Specified by:

getLogFileFilter in interface NutsSession

setLogFileFilter

public NutsSession setLogFileFilter(Filter logFileFilter)

Specified by:

setLogFileFilter in interface NutsSession

eout

public NutsArrayElementBuilder eout()

Specified by:

eout in interface NutsSession

flush

public NutsSession flush()

Specified by:

flush in interface NutsSession

getExecutionType

public NutsExecutionType getExecutionType()

Specified by:

getExecutionType in interface NutsSession

setExecutionType

public NutsSession setExecutionType(NutsExecutionType executionType)

Specified by:

setExecutionType in interface NutsSession

isDebug

public boolean isDebug()

Specified by:

isDebug in interface NutsSession

getDebug

public Boolean getDebug()

Specified by:

getDebug in interface NutsSession

setDebug

public NutsSession setDebug(Boolean debug)

Specified by:

setDebug in interface NutsSession

getLocale

public String getLocale()

Specified by:

getLocale in interface NutsSession

setLocale

public NutsSession setLocale(String locale)

Specified by:

setLocale in interface NutsSession

getRunAs

public NutsRunAs getRunAs()

Specified by:

getRunAs in interface NutsSession

setRunAs

public NutsSession setRunAs(NutsRunAs runAs)

Specified by:

setRunAs in interface NutsSession

toString

public String toString()

Overrides:

toString in class Object