org.adroitlogic.x.annotation.config

Annotation Type BeanRef

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

This annotation is used to indicate a field as a BeanRef. 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 Bean type, the field type must be as follows

   Bean Type	Field Type
   BeanType.CONNECTOR_OPERATION	XConnectorOperationElement

3. The display name of the BeanRef should be unique within the class

This annotation and the relevant configurations embedded in this annotation are used to specify the information related to the rendering of the integration point of either a processing element annotated with Processor or a connector annotated with either an EgressConnector or IngressConnector annotations

Since:

17.01

Author:

Ruwan Linton

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
BeanType	beanType The type of the bean reference that this integration point expects.
String	description The description to be shown in the integration point of the bean reference
String	displayName The name that is used for the reference integration point in the pallet

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	order The order at which the integration point will be displayed in the processor or connector icon in the pallet

Element Detail

displayName

public abstract String displayName

The name that is used for the reference integration point in the pallet

Returns:

the display name of the bean reference

beanType

public abstract BeanType beanType

The type of the bean reference that this integration point expects. The supported bean types include, BeanType.CONNECTOR_OPERATION

Returns:

the bean type of the integration point

description

public abstract String description

The description to be shown in the integration point of the bean reference

Returns:

the description of the bean reference

order

public abstract int order

The order at which the integration point will be displayed in the processor or connector icon in the pallet

Returns:

the rendering order of the integration point in the specified element

Default:

0