LegacyCommandline (ImageJ2 Javadocs 0-SNAPSHOT API)

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
        
        net.imagej.legacy.LegacyCommandline

All Implemented Interfaces:

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

Direct Known Subclasses:

LegacyCommandline.Batch, LegacyCommandline.Debug, LegacyCommandline.Eval, LegacyCommandline.Filename, LegacyCommandline.IJPath, LegacyCommandline.Macro, LegacyCommandline.Port, LegacyCommandline.Run
```
public abstract class LegacyCommandline
extends AbstractConsoleArgument
```
Handles the following ImageJ 1.x commands, as per ImageJ's documentation:

"file-name"

Opens a file
Example 1: blobs.tif
Example 2: /Users/wayne/images/blobs.tif
Example 3: e81*.tif

-macro path [arg]

Runs a macro or script (JavaScript, BeanShell or Python), passing an optional string argument, which the macro or script can be retrieve using the getArgument() function. The macro or script is assumed to be in the ImageJ/macros folder if 'path' is not a full directory path.
Example 1: -macro analyze.ijm
Example 2: -macro script.js /Users/wayne/images/stack1
Example 2: -macro script.py '1.2 2.4 3.8'

-batch path [arg]

Runs a macro or script (JavaScript, BeanShell or Python) in batch (no GUI) mode, passing it an optional argument. ImageJ exits when the macro finishes.

-eval "macro code"

Evaluates macro code
Example 1: -eval "print('Hello, world');"
Example 2: -eval "return getVersion();"

-run command

Runs an ImageJ menu command
Example: -run "About ImageJ..."

-ijpath path

Specifies the path to the directory containing the plugins directory
Example: -ijpath /Applications/ImageJ

-port<n>

Specifies the port ImageJ uses to determine if another instance is running
Example 1: -port1 (use default port address + 1)
Example 2: -port2 (use default port address + 2)
Example 3: -port0 (don't check for another instance)

-debug

Runs ImageJ in debug mode

-batch-no-exit

Runs ImageJ in batch mode and disallows exiting the VM when done

Author:

Johannes Schindelin

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LegacyCommandline.Batch` Implements `-batch path [arg]` and `-batch-no-exit path [arg]`.
`static class`	`LegacyCommandline.Debug` Implements `-debug`.
`static class`	`LegacyCommandline.Eval` Implements `-eval "macro code"`.
`static class`	`LegacyCommandline.Filename` Handles `"file-name"`.
`static class`	`LegacyCommandline.IJPath` Implements `-ijpath path`.
`static class`	`LegacyCommandline.Macro` Implements `-macro path [arg]`.
`static class`	`LegacyCommandline.Port` Implements `-port<n>`.
`static class`	`LegacyCommandline.Run` Implements `-run command`.

Field Summary

Fields
Modifier and Type Field and Description

protected LegacyService legacyService

protected LogService log

Fields
Modifier and Type	Field and Description
`protected LegacyService`	`legacyService`
`protected LogService`	`log`

Constructor Summary

Constructors
Constructor and Description

LegacyCommandline()

Constructors
Constructor and Description
`LegacyCommandline()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`handleBatchExit(LinkedList<String> args)`
`protected void`	`handleBatchOption(LinkedList<String> args)`
`protected IJ1Helper`	`ij1Helper()`
`protected boolean`	`isBatchMode()`

Methods inherited from class org.scijava.console.AbstractConsoleArgument
getParam, isFlag, supports

Methods inherited from class org.scijava.plugin.AbstractRichPlugin
getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual
context, getContext

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
getType, handle

Methods inherited from interface org.scijava.plugin.RichPlugin
getIdentifier, log

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized
compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo

Methods inherited from interface org.scijava.Locatable
getLocation

Methods inherited from interface org.scijava.Versioned
getVersion

Field Detail

legacyService
```
protected LegacyService legacyService
```

log
```
protected LogService log
```

Constructor Detail
- LegacyCommandline
```
public LegacyCommandline()
```

Method Detail

ij1Helper
```
protected IJ1Helper ij1Helper()
```

isBatchMode
```
protected boolean isBatchMode()
```

handleBatchOption

protected void handleBatchOption(LinkedList<String> args)

handleBatchExit

protected void handleBatchExit(LinkedList<String> args)

Class LegacyCommandline

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.scijava.console.AbstractConsoleArgument

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.console.ConsoleArgument

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Field Detail

legacyService

log

Constructor Detail

LegacyCommandline

Method Detail

ij1Helper

isBatchMode

handleBatchOption

handleBatchExit