com.asakusafw.vocabulary.flow.graph

Class FlowElement

java.lang.Object

com.asakusafw.vocabulary.flow.graph.FlowElement

All Implemented Interfaces:

FlowElementAttributeProvider

public final class FlowElement
extends Object
implements FlowElementAttributeProvider

Represents a node in flow graph. Application developers should not use this class directly.

Since:

0.1.0

Version:

0.9.1

Constructor Summary

Constructors

Constructor and Description
FlowElement(FlowElementDescription description) Creates a new instance.
FlowElement(FlowElementDescription description, Collection<? extends FlowElementAttribute> attributeOverride) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
FlowElement	copy() Creates a new copy without any connections.
<T extends FlowElementAttribute> T	getAttribute(Class<T> attributeClass) Returns the attribute of this.
Collection<FlowElementAttribute>	getAttributeOverride() Returns the overwritten attributes.
Set<? extends Class<? extends FlowElementAttribute>>	getAttributeTypes() Returns the all available attribute types of this.
FlowElementDescription	getDescription() Returns the description of this element.
Object	getIdentity() Returns the original identity.
List<FlowElementInput>	getInputPorts() Returns input ports of this element.
List<FlowElementOutput>	getOutputPorts() Returns input ports of this element.
boolean	hasAttribute(FlowElementAttribute attribute) Returns whether this element has the specified attribute or not.
void	override(FlowElementAttribute attribute) Overwrites the attribute into this element.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowElement

public FlowElement(FlowElementDescription description)

Creates a new instance.

Parameters:

description - definition description

Throws:

IllegalArgumentException - if some parameters were null

FlowElement

public FlowElement(FlowElementDescription description,
                   Collection<? extends FlowElementAttribute> attributeOverride)

Creates a new instance.

Parameters:

description - definition description

attributeOverride - extra attributes for this element

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

copy

public FlowElement copy()

Creates a new copy without any connections. This copy only has same identity.

Returns:

the created copy

getIdentity

public Object getIdentity()

Returns the original identity.

Returns:

the identity

Since:

0.4.0

getDescription

public FlowElementDescription getDescription()

Returns the description of this element.

Returns:

the description

getInputPorts

public List<FlowElementInput> getInputPorts()

Returns input ports of this element.

Returns:

input ports

getOutputPorts

public List<FlowElementOutput> getOutputPorts()

Returns input ports of this element.

Returns:

output ports

hasAttribute

public boolean hasAttribute(FlowElementAttribute attribute)

Returns whether this element has the specified attribute or not.

Parameters:

attribute - the target attribute

Returns:

true if this element has the specified attribute, otherwise false

Throws:

IllegalArgumentException - if the parameter is null

getAttributeTypes

public Set<? extends Class<? extends FlowElementAttribute>> getAttributeTypes()

Description copied from interface: FlowElementAttributeProvider

Returns the all available attribute types of this.

Specified by:

getAttributeTypes in interface FlowElementAttributeProvider

Returns:

the available attribute types

getAttribute

public <T extends FlowElementAttribute> T getAttribute(Class<T> attributeClass)

Description copied from interface: FlowElementAttributeProvider

Returns the attribute of this.

Specified by:

getAttribute in interface FlowElementAttributeProvider

Type Parameters:

T - target class

Parameters:

attributeClass - target class

Returns:

attribute, or null if not defined

override

public void override(FlowElementAttribute attribute)

Overwrites the attribute into this element. This does not change the attribute of the description.

Parameters:

attribute - the attribute to be overwritten

getAttributeOverride

public Collection<FlowElementAttribute> getAttributeOverride()

Returns the overwritten attributes.

Returns:

the overwritten attributes

toString

public String toString()

Overrides:

toString in class Object