Module org.scijava.ops.api

Package org.scijava.ops.api

Class OpBuilder.Arity2_IT_OU<I1,I2>

java.lang.Object

org.scijava.ops.api.OpBuilder.Arity2_IT_OU<I1,I2>

Type Parameters:

I1 - The type of input 1.

I2 - The type of input 2.

Enclosing class:

OpBuilder

public final class OpBuilder.Arity2_IT_OU<I1,I2>
extends Object

Builder with arity 2, input type given, output unspecified.

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor	Description
Arity2_IT_OU(Nil<I1> in1Type, Nil<I2> in2Type)

Method Summary

Modifier and Type	Method	Description
BiFunction<I1,I2,?>	function()	Match a Functions op based on the choices made with this builder.
String	help()	Finds all Ops matching the current partial OpBuilder request
String	helpVerbose()	Finds all Ops matching the current partial OpBuilder request
Inplaces.Arity2_1<I1,I2>	inplace1()	Match an Inplaces op, based on the choices made with this builder, to mutate the 1st parameter.
Inplaces.Arity2_2<I1,I2>	inplace2()	Match an Inplaces op, based on the choices made with this builder, to mutate the 2nd parameter.
<O> OpBuilder.Arity2_IT_OT<I1,I2,O>	outType(Class<O> outType)	Matches with this builder will use the indicated output class.
<O> OpBuilder.Arity2_IT_OT<I1,I2,O>	outType(Nil<O> outType)	Matches with this builder will use the output type of the indicated Nil's generic parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Arity2_IT_OU

public Arity2_IT_OU(Nil<I1> in1Type,
                    Nil<I2> in2Type)

Method Detail

outType

public <O> OpBuilder.Arity2_IT_OT<I1,I2,O> outType(Class<O> outType)

Matches with this builder will use the indicated output class.

See Also:

For a reusable Op that generates output instances based on its inputs., For a reusable Op that modifies a provided input parameter in-place., To specify the output type, preserving its generic parameters.

outType

public <O> OpBuilder.Arity2_IT_OT<I1,I2,O> outType(Nil<O> outType)

Matches with this builder will use the output type of the indicated Nil's generic parameter.

See Also:

For a reusable Op that generates output instances based on its inputs., For a reusable Op that modifies a provided input parameter in-place., To specify the output type without providing a concrete instance.

function

public BiFunction<I1,I2,?> function()

Match a Functions op based on the choices made with this builder.

Returns:

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

Throws:

OpMatchingException - if the Op request cannot be satisfied.

See Also:

To specify the output type without providing a concrete instance., To specify the output type, preserving its generic parameters., For a reusable Op that modifies a provided input parameter in-place.

inplace1

public Inplaces.Arity2_1<I1,I2> inplace1()

Match an Inplaces op, based on the choices made with this builder, to mutate the 1st parameter.

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 that generates output instances based on its inputs., To specify the output type without providing a concrete instance., To specify the output type, preserving its generic parameters.

inplace2

public Inplaces.Arity2_2<I1,I2> inplace2()

Match an Inplaces op, based on the choices made with this builder, to mutate the 2nd parameter.

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 that generates output instances based on its inputs., To specify the output type without providing a concrete instance., To specify the output type, preserving its generic parameters.

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