io.siddhi.annotation

Annotation Type Extension

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @IndexAnnotated
public @interface Extension

Annotation for specifying it as a Siddhi Extension.

 eg:-
       @Extension(
                      name = "customExtensionName",
                      namespace = "customExtensionNamespace",
                      description = "Description of the custom extension.",
                      parameters = {
                           @Parameter(name = "firstParameterName", type = {DataType.INT, DataType.LONG}),
                           @Parameter(name = "SecondParameterName", type = {DataType.STRING})
                      },
                      parameterOverloads = {
                            @ParameterOverload(parameterNames={"firstParameterName","secondParameterName"}),
                            @ParameterOverload(parameterNames={"firstParameterName"})
                       },
                      returnAttributes =  @ReturnAttribute(type = {DataType.INT, DataType.LONG}),
                      examples = { @Example({"Example of the CustomExtension usage 1"}),
                                   @Example({"Example of the CustomExtension usage 2"})}
      )
      public CustomExtension extends ExtensionSuperClass {
          ...
      }
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	deprecated
String	description
Example[]	examples
String	name
String	namespace
ParameterOverload[]	parameterOverloads
Parameter[]	parameters
ReturnAttribute[]	returnAttributes
SystemParameter[]	systemParameter

Element Detail

name

public abstract String name

Default:

""

namespace

public abstract String namespace

Default:

""

description

public abstract String description

Default:

""

deprecated

public abstract boolean deprecated

Default:

false

parameters

public abstract Parameter[] parameters

Default:

{}

parameterOverloads

public abstract ParameterOverload[] parameterOverloads

Default:

{}

systemParameter

public abstract SystemParameter[] systemParameter

Default:

{}

returnAttributes

public abstract ReturnAttribute[] returnAttributes

Default:

{}

examples

public abstract Example[] examples

Default:

{}