Package io.siddhi.annotation.processor

Class SourceValidationAnnotationProcessor

java.lang.Object

io.siddhi.annotation.processor.AbstractAnnotationProcessor

io.siddhi.annotation.processor.SourceValidationAnnotationProcessor

public class SourceValidationAnnotationProcessor
extends AbstractAnnotationProcessor

This processor will extend the validation rules for validate Source specific annotation contents.

Field Summary

Fields inherited from class io.siddhi.annotation.processor.AbstractAnnotationProcessor

CAMEL_CASE_PATTERN, CORE_PACKAGE_PATTERN, extensionClassFullName, PARAMETER_NAME_PATTERN, REPETITIVE_PARAMETER_NOTATION

Constructor Summary

Constructors

Constructor	Description
SourceValidationAnnotationProcessor(String extensionClassFullName)

Method Summary

Modifier and Type	Method	Description
void	basicParameterValidation(String name, String description, String namespace)	Basic @Extension annotation elements validation.
void	parameterValidation(Parameter[] parameters)	This method uses for validate @Extension / @Parameter element.
void	returnAttributesValidation(ReturnAttribute[] returnAttributes)	This method uses for validate @Extension / @ReturnAttribute elements.

Methods inherited from class io.siddhi.annotation.processor.AbstractAnnotationProcessor

examplesValidation, parameterOverloadValidation, systemParametersValidation

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceValidationAnnotationProcessor

public SourceValidationAnnotationProcessor(String extensionClassFullName)

Method Detail

basicParameterValidation

public void basicParameterValidation(String name,
                                     String description,
                                     String namespace)
                              throws AnnotationValidationException

Description copied from class: AbstractAnnotationProcessor

Basic @Extension annotation elements validation.

Overrides:

basicParameterValidation in class AbstractAnnotationProcessor

Parameters:

name - name of the @Extension which needs to be validate.

description - description of the @Extension which needs to be validate.

namespace - namespace of the @Extension which needs to be validate.

Throws:

AnnotationValidationException - whenever if the validate rule violate, throws the annotation validate exception with proper message.

parameterValidation

public void parameterValidation(Parameter[] parameters)
                         throws AnnotationValidationException

Description copied from class: AbstractAnnotationProcessor

This method uses for validate @Extension / @Parameter element.

Overrides:

parameterValidation in class AbstractAnnotationProcessor

Parameters:

parameters - parameter array which needs to be validate.

Throws:

AnnotationValidationException - whenever if the validate rule violate, throws the annotation validate exception with proper message.

returnAttributesValidation

public void returnAttributesValidation(ReturnAttribute[] returnAttributes)
                                throws AnnotationValidationException

Description copied from class: AbstractAnnotationProcessor

This method uses for validate @Extension / @ReturnAttribute elements.

Overrides:

returnAttributesValidation in class AbstractAnnotationProcessor

Parameters:

returnAttributes - returnA attributes array which needs to be validate.

Throws:

AnnotationValidationException - whenever if the validate rule violate, throws the annotation validate exception with proper message.