Module org.scijava.ops.engine

Package org.scijava.ops.engine.impl

Class DefaultOpDescriptionGenerator

java.lang.Object

org.scijava.ops.engine.impl.DefaultOpDescriptionGenerator

All Implemented Interfaces:

Comparable<OpDescriptionGenerator>, OpDescriptionGenerator, Prioritized<OpDescriptionGenerator>

public class DefaultOpDescriptionGenerator
extends Object
implements OpDescriptionGenerator

An OpDescriptionGenerator implementation which makes use of ConvertedOpInfos to provide "simple" descriptions.

Author:

Gabriel Selzer

Field Summary

Fields inherited from interface org.scijava.ops.engine.OpDescriptionGenerator

NO_OP_MATCHES

Constructor Summary

Constructors

Constructor	Description
DefaultOpDescriptionGenerator()

Method Summary

Modifier and Type	Method	Description
double	priority()
String	simpleDescriptions(OpEnvironment env, OpRequest req)	Returns a String with a "simple" description for each Op in env matching request.
String	verboseDescriptions(OpEnvironment env, OpRequest req)	Returns a String with a "simple" description for each Op in env matching request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.priority.Prioritized

compareTo

Constructor Detail

DefaultOpDescriptionGenerator

public DefaultOpDescriptionGenerator()

Method Detail

priority

public double priority()

Specified by:

priority in interface OpDescriptionGenerator

Specified by:

priority in interface Prioritized<OpDescriptionGenerator>

simpleDescriptions

public String simpleDescriptions(OpEnvironment env,
                                 OpRequest req)

Description copied from interface: OpDescriptionGenerator

Returns a String with a "simple" description for each Op in env matching request.

Specified by:

simpleDescriptions in interface OpDescriptionGenerator

Parameters:

env - an OpEnvironment containing Ops that may match request

req - an OpRequest to filter on.

Returns:

a String with a "simple" description for each Op in env matching request.

verboseDescriptions

public String verboseDescriptions(OpEnvironment env,
                                  OpRequest req)

Description copied from interface: OpDescriptionGenerator

Returns a String with a "simple" description for each Op in env matching request.

Specified by:

verboseDescriptions in interface OpDescriptionGenerator

Parameters:

env - an OpEnvironment containing Ops that may match request

req - an OpRequest to filter on.

Returns:

a String with a "simple" description for each Op in env matching request.