com.asakusafw.vocabulary.flow.graph

Class FlowPartDescription.Builder

java.lang.Object

com.asakusafw.vocabulary.flow.graph.FlowPartDescription.Builder

Enclosing class:

FlowPartDescription

public static class FlowPartDescription.Builder
extends Object

A builder for building FlowPartDescription.

Since:

0.1.0

Version:

0.5.0

Constructor Summary

Constructors

Constructor and Description
Builder(Class<? extends FlowDescription> declaring) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
<T> FlowIn<T>	addInput(String name, Source<T> typeReference) Add a new input port into the target flow-part.
<T> FlowIn<T>	addInput(String name, Type type) Add a new input port into the target flow-part.
<T> FlowOut<T>	addOutput(String name, Source<T> typeReference) Add a new output port into the target flow-part.
<T> FlowOut<T>	addOutput(String name, Type type) Add a new output port into the target flow-part.
void	addParameter(String parameterName, Type parameterType, Object argument) Adds a parameter and its argument value for this flow-part.
FlowPartDescription	toDescription() Creates a new description object from the previously information.
FlowElementResolver	toResolver(FlowDescription desc) Creates a new FlowElementResolver object from the previously information.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(Class<? extends FlowDescription> declaring)

Creates a new instance.

Parameters:

declaring - the class declaring the target flow-part

Throws:

IllegalArgumentException - if the parameter is null

Method Detail

addInput

public <T> FlowIn<T> addInput(String name,
                              Type type)

Add a new input port into the target flow-part.

Type Parameters:

T - the data type

Parameters:

name - the port name

type - the data type

Returns:

the FlowIn object that represents the defined port

Throws:

IllegalArgumentException - if some parameters are null

addOutput

public <T> FlowOut<T> addOutput(String name,
                                Type type)

Add a new output port into the target flow-part.

Type Parameters:

T - the data type

Parameters:

name - the port name

type - the data type

Returns:

the FlowOut object that represents the defined port

Throws:

IllegalArgumentException - if some parameters are null

addInput

public <T> FlowIn<T> addInput(String name,
                              Source<T> typeReference)

Add a new input port into the target flow-part.

Type Parameters:

T - the data type

Parameters:

name - the port name

typeReference - a source that has the data type as same to the creating port

Returns:

the FlowIn object that represents the defined port

Throws:

IllegalArgumentException - if some parameters are null

addOutput

public <T> FlowOut<T> addOutput(String name,
                                Source<T> typeReference)

Add a new output port into the target flow-part.

Type Parameters:

T - the data type

Parameters:

name - the port name

typeReference - a source that has the data type as same to the creating port

Returns:

the FlowOut object that represents the defined port

Throws:

IllegalArgumentException - if some parameters are null

addParameter

public void addParameter(String parameterName,
                         Type parameterType,
                         Object argument)

Adds a parameter and its argument value for this flow-part.

Parameters:

parameterName - the parameter name

parameterType - the parameter value

argument - the actual parameter argument, or null if the argument is just null

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.5.0

toDescription

public FlowPartDescription toDescription()

Creates a new description object from the previously information.

Returns:

the created description

toResolver

public FlowElementResolver toResolver(FlowDescription desc)

Creates a new FlowElementResolver object from the previously information.

Parameters:

desc - the original flow description object

Returns:

the created object