OpDescriptionGenerator (SciJava Ops Engine 1.0.0 API)

All Superinterfaces:

Comparable<OpDescriptionGenerator>, Prioritized<OpDescriptionGenerator>

All Known Implementing Classes:

DefaultOpDescriptionGenerator
```
public interface OpDescriptionGenerator
extends Prioritized<OpDescriptionGenerator>
```
An interface whose implementations are able to describe all the Ops in an OpEnvironment that could satisfy an OpRequest.

Author:

Gabriel Selzer

Field Summary

Fields
Modifier and Type Field Description

static String NO_OP_MATCHES

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default double`	`priority()`
`String`	`simpleDescriptions(OpEnvironment env, OpRequest request)`	Returns a `String` with a "simple" description for each Op in `env` matching `request`.
`String`	`verboseDescriptions(OpEnvironment env, OpRequest request)`	Returns a `String` with a "simple" description for each Op in `env` matching `request`.

Methods inherited from interface org.scijava.priority.Prioritized
compareTo

- Field Detail
  - NO_OP_MATCHES
```
static final String NO_OP_MATCHES
```
    See Also:
    
    Constant Field Values
- Method Detail
  - simpleDescriptions
```
String simpleDescriptions(OpEnvironment env,
                          OpRequest request)
```
    Returns a String with a "simple" description for each Op in env matching request.
    
    Parameters:
    
    env - an OpEnvironment containing Ops that may match request
    
    request - an OpRequest to filter on.
    
    Returns:
    
    a String with a "simple" description for each Op in env matching request.
  - verboseDescriptions
```
String verboseDescriptions(OpEnvironment env,
                           OpRequest request)
```
    Returns a String with a "simple" description for each Op in env matching request.
    
    Parameters:
    
    env - an OpEnvironment containing Ops that may match request
    
    request - an OpRequest to filter on.
    
    Returns:
    
    a String with a "simple" description for each Op in env matching request.
  - priority
```
default double priority()
```
    Specified by:
    
    priority in interface Prioritized<OpDescriptionGenerator>