Module org.scijava.ops.engine

Package org.scijava.ops.engine.struct

Class AnnotatedOpDependencyMember<T>

java.lang.Object

org.scijava.ops.engine.struct.AnnotatedOpDependencyMember<T>

All Implemented Interfaces:

OpDependencyMember<T>, Member<T>

Direct Known Subclasses:

FieldOpDependencyMember, MethodParameterOpDependencyMember

public abstract class AnnotatedOpDependencyMember<T>
extends Object
implements OpDependencyMember<T>

Author:

Marcel Wiedenmann

Constructor Summary

Constructors

Constructor	Description
AnnotatedOpDependencyMember(String key, String description, Type type, OpDependency annotation)	This constructor is ideal for situations where the key and description are readily available
AnnotatedOpDependencyMember(Supplier<String> keyGenerator, Supplier<String> descriptionGenerator, Type type, OpDependency annotation)	This constructor is ideal for situations where obtaining the key or description are computationally expensive.

Method Summary

Modifier and Type	Method	Description
String	description()
OpDependency	getAnnotation()
String	getDependencyName()
Hints	hints()
String	key()
String	toString()
Type	type()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.struct.Member

childStruct, createInstance, isInput, isOutput, isRequired, isStruct, rawType

Methods inherited from interface org.scijava.ops.engine.OpDependencyMember

getIOType

Constructor Detail

AnnotatedOpDependencyMember

public AnnotatedOpDependencyMember(String key,
                                   String description,
                                   Type type,
                                   OpDependency annotation)

This constructor is ideal for situations where the key and description are readily available

Parameters:

key - the key

description - the description

type - the Type of this Member

annotation - the OpDependency annotation

AnnotatedOpDependencyMember

public AnnotatedOpDependencyMember(Supplier<String> keyGenerator,
                                   Supplier<String> descriptionGenerator,
                                   Type type,
                                   OpDependency annotation)

This constructor is ideal for situations where obtaining the key or description are computationally expensive.

Parameters:

keyGenerator - the Supplier able to generate the key

descriptionGenerator - the Supplier able to generate the description

type - the Type of this Member

annotation - the OpDependency annotation

Method Detail

getAnnotation

public OpDependency getAnnotation()

getDependencyName

public String getDependencyName()

Specified by:

getDependencyName in interface OpDependencyMember<T>

hints

public Hints hints()

Specified by:

hints in interface OpDependencyMember<T>

key

public String key()

Specified by:

key in interface Member<T>

description

public String description()

Specified by:

description in interface Member<T>

type

public Type type()

Specified by:

type in interface Member<T>

toString

public String toString()

Overrides:

toString in class Object