org.adroitlogic.x.annotation.config

Annotation Type OutPort

@Target(value=FIELD)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
public @interface OutPort

This annotation is used to indicate a field as an OutPort. Any field that is annotated using this should adhere to the following guidelines. 1. This annotation can only be used on fields. 2. Based on the out port type, the field type must be as follows. +------------------------------------+---------------------------------+ | OutPort Type | Field Type | |------------------------------------+---------------------------------| | PortType.PROCESSOR | XProcessingElement | |- - - - - - - - - - - - - - - - - - | - - - - - - - - - - - - - - - - | | PortType.CONNECTOR | XEgressConnectorElement | +------------------------------------+---------------------------------+ 3. The display name of the out port should be unique within the class.

Since:

17.01

Author:

Udith Gunaratna

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	displayName The name of the annotated out port to be used in the user interface

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Description for the out-port to be used for rendering purposes
int	order The order of the annotated out port to be displayed in the user interface
PortType	targetType The target type of the out-port which could either be PortType.PROCESSOR or PortType.PROCESSOR_LIST or PortType.CONNECTOR

Element Detail

displayName

public abstract String displayName

The name of the annotated out port to be used in the user interface

Returns:

the display name of the out-port

order

public abstract int order

The order of the annotated out port to be displayed in the user interface

Returns:

the order in which the out-port annotated with this annotation is placed among the other

Default:

0

targetType

public abstract PortType targetType

The target type of the out-port which could either be PortType.PROCESSOR or PortType.PROCESSOR_LIST or PortType.CONNECTOR

Returns:

the target port type

Default:

org.adroitlogic.x.api.config.PortType.PROCESSOR

description

public abstract String description

Description for the out-port to be used for rendering purposes

Returns:

the description of the out-port

Default:

""