net.thevpc.nuts.runtime.core.format

Class DefaultSearchFormatBase

java.lang.Object

net.thevpc.nuts.runtime.core.format.DefaultSearchFormatBase

All Implemented Interfaces:

NutsCommandLineConfigurable, NutsIterableFormat

Direct Known Subclasses:

DefaultSearchFormatJson, DefaultSearchFormatPlain, DefaultSearchFormatProps, DefaultSearchFormatTable, DefaultSearchFormatTree, DefaultSearchFormatXml

public abstract class DefaultSearchFormatBase
extends Object
implements NutsIterableFormat

Author:

thevpc

Constructor Summary

Constructors

Constructor and Description
DefaultSearchFormatBase(NutsSession session, NutsPrintStream writer, NutsContentType format, NutsFetchDisplayOptions options)

Method Summary

Modifier and Type	Method and Description
boolean	configure(boolean skipUnsupported, NutsCommandLine commandLine) configure the current command with the given arguments.
NutsIterableFormat	configure(boolean skipUnsupported, String... args) configure the current command with the given arguments.
NutsFetchDisplayOptions	getDisplayOptions()
NutsContentType	getOutputFormat()
NutsSession	getSession()
NutsWorkspace	getWorkspace()
NutsPrintStream	getWriter()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.thevpc.nuts.NutsIterableFormat

complete, next, start

Methods inherited from interface net.thevpc.nuts.NutsCommandLineConfigurable

configureFirst, configureLast

Constructor Detail

DefaultSearchFormatBase

public DefaultSearchFormatBase(NutsSession session,
                               NutsPrintStream writer,
                               NutsContentType format,
                               NutsFetchDisplayOptions options)

Method Detail

getOutputFormat

public NutsContentType getOutputFormat()

Specified by:

getOutputFormat in interface NutsIterableFormat

getDisplayOptions

public NutsFetchDisplayOptions getDisplayOptions()

configure

public 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

configure

public NutsIterableFormat 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

Specified by:

configure in interface NutsIterableFormat

Parameters:

args - argument to configure with

Returns:

this instance

getWorkspace

public NutsWorkspace getWorkspace()

getSession

public NutsSession getSession()

getWriter

public NutsPrintStream getWriter()