OpParameter (SciJava Ops External Parser 1.0.0 API)

java.lang.Object
- org.scijava.ops.parser.OpParameter

```
public class OpParameter
extends Object
```
Record class wrangling data pertaining to an Op parameter

Author:

Gabriel Selzer, Mark Hiner

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OpParameter.IO_TYPE
Op parameters must be one of the following types

Field Summary

Fields
Modifier and Type Field Description

protected String desc

protected OpParameter.IO_TYPE ioType

protected String name

protected String type

Constructor Summary

Constructors
Constructor Description

OpParameter(String name, String type, OpParameter.IO_TYPE ioType, String description)
Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,Object>`	`data()`	Creates a `Map` representation for this Op parameter that could be used in YAML generation.

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

- Field Detail
  - ioType
```
protected final OpParameter.IO_TYPE ioType
```
  - name
```
protected final String name
```
  - type
```
protected final String type
```
  - desc
```
protected final String desc
```
- Constructor Detail
  - OpParameter
```
public OpParameter(String name,
                   String type,
                   OpParameter.IO_TYPE ioType,
                   String description)
```
    Default constructor
    
    Parameters:
    
    name - the name of the parameter
    
    type - the Type of the parameter, stringified
    
    ioType - the OpParameter.IO_TYPE of the parameter. Note that functional outputs should use OpParameter.IO_TYPE.OUTPUT, output buffers should use OpParameter.IO_TYPE.CONTAINER, and data structures that are operated on inplace should use OpParameter.IO_TYPE.MUTABLE.
    
    description - a description of the parameter
- Method Detail
  - data
```
public Map<String,Object> data()
```
    Creates a Map representation for this Op parameter that could be used in YAML generation.
    
    Returns:
    
    a Map containing this parameter's data.