Module org.scijava.ops.api

Package org.scijava.ops.api

Class OpBuilder.Arity0_OT<O>

java.lang.Object

org.scijava.ops.api.OpBuilder.Arity0_OT<O>

Type Parameters:

O - The type of the output.

Enclosing class:

OpBuilder

public final class OpBuilder.Arity0_OT<O>
extends Object

Builder with arity 0, output type given.

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor	Description
Arity0_OT(Nil<O> outType)

Method Summary

Modifier and Type	Method	Description
Computers.Arity0<O>	computer()	Match a Computers op, based on the choices made with this builder, for operating on pre-allocated output.
O	create()	Match then immediately run a Producer op and get its output.
String	help()	Finds all Ops matching the current partial OpBuilder request
String	helpVerbose()	Finds all Ops matching the current partial OpBuilder request
Producer<O>	producer()	Match a Producer op, based on the choices made with this builder, for creating O-typed instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

Arity0_OT

public Arity0_OT(Nil<O> outType)

Method Detail

producer

public Producer<O> producer()

Match a Producer op, based on the choices made with this builder, for creating O-typed instances.

Returns:

An instance of the matched op, e.g. for reuse.

Throws:

OpMatchingException - if the Op request cannot be satisfied.

See Also:

For a reusable Op to process pre-allocated outputs without re-matching., To match then immediately run a Producer Op, creating an instance of this builder's output type.

computer

public Computers.Arity0<O> computer()

Match a Computers op, based on the choices made with this builder, for operating on pre-allocated output.

Returns:

An instance of the matched op, e.g. for reuse.

Throws:

OpMatchingException - if the Op request cannot be satisfied.

See Also:

To match then immediately run a Producer Op, creating an instance of this builder's output type., For a reusable Op to create objects of this builder's output type without re-matching.

create

public O create()

Match then immediately run a Producer op and get its output.

Returns:

The O created by this op

Throws:

OpMatchingException - if the Op request cannot be satisfied.

See Also:

For a reusable Op to process pre-allocated outputs without re-matching., For a reusable Op to create objects of this builder's output type without re-matching.

help

public String help()

Finds all Ops matching the current partial OpBuilder request

Returns:

a String with a simple entry for each Op satisfying the partial request

helpVerbose

public String helpVerbose()

Finds all Ops matching the current partial OpBuilder request

Returns:

a String with a verbose entry for each Op satisfying the partial request