org.scijava.console

Class AbstractConsoleArgument

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.plugin.AbstractTypedPlugin<D>

org.scijava.plugin.AbstractHandlerPlugin<LinkedList<String>>

org.scijava.console.AbstractConsoleArgument

All Implemented Interfaces:

Comparable<Prioritized>, ConsoleArgument, Contextual, HandlerPlugin<LinkedList<String>>, HasPluginInfo, RichPlugin, SciJavaPlugin, SingletonPlugin, TypedPlugin<LinkedList<String>>, Prioritized, Typed<LinkedList<String>>

Direct Known Subclasses:

HeadlessArgument, MainArgument, OpenArgument, RunArgument, RunArgument, RunScriptArgument, SystemPropertyArgument, UIArgument

public abstract class AbstractConsoleArgument
extends AbstractHandlerPlugin<LinkedList<String>>
implements ConsoleArgument

Abstract superclass of ConsoleArgument implementations.

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor and Description
AbstractConsoleArgument()
AbstractConsoleArgument(int requiredArgs, String... flags)
AbstractConsoleArgument(String... flags)

Method Summary

Modifier and Type	Method and Description
protected String	getParam(LinkedList<String> args) If the next argument is an appropriate parameter to a ConsoleArgument, retrieves it; otherwise, returns null.
Class<LinkedList<String>>	getType() Gets the type associated with the object.
protected boolean	isFlag(LinkedList<String> args) Check if the given list of arguments starts with a flag that matches this ConsoleArgument.
boolean	supports(LinkedList<String> args) Gets whether this object is compatible with the given data object.

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

compareTo, getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.console.ConsoleArgument

handle

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

getPriority, setPriority

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Constructor Detail

AbstractConsoleArgument

public AbstractConsoleArgument()

AbstractConsoleArgument

public AbstractConsoleArgument(String... flags)

AbstractConsoleArgument

public AbstractConsoleArgument(int requiredArgs,
                               String... flags)

Method Detail

supports

public boolean supports(LinkedList<String> args)

Description copied from interface: Typed

Gets whether this object is compatible with the given data object.

By default, this method will return true always, since the type is known to be compatible. But individual implementations may have other requirements beyond class assignability.

Specified by:

supports in interface Typed<LinkedList<String>>

Overrides:

supports in class AbstractTypedPlugin<LinkedList<String>>

getType

public Class<LinkedList<String>> getType()

Description copied from interface: Typed

Gets the type associated with the object.

Specified by:

getType in interface Typed<LinkedList<String>>

isFlag

protected boolean isFlag(LinkedList<String> args)

Check if the given list of arguments starts with a flag that matches this ConsoleArgument.

Returns:

true iff one of this argument's flags matches the first string in the given list, or this argument has no explicit flags.

getParam

protected String getParam(LinkedList<String> args)

If the next argument is an appropriate parameter to a ConsoleArgument, retrieves it; otherwise, returns null.

Returns:

The first argument of the given list, if it does not start with a '-' character; or null otherwise.