Package io.micronaut.validation.websocket

Class WebSocketVisitor

java.lang.Object

io.micronaut.validation.websocket.WebSocketVisitor

All Implemented Interfaces:

Ordered, Toggleable, TypeElementVisitor<WebSocketComponent,WebSocketMapping>

@SupportedOptions("micronaut.websocket.validation")
public class WebSocketVisitor
extends Object
implements TypeElementVisitor<WebSocketComponent,WebSocketMapping>

A TypeElementVisitor that validates WebSocket implementations at compile time.

Since:

1.0

Author:

graemerocher

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.inject.visitor.TypeElementVisitor

TypeElementVisitor.VisitorKind

Field Summary

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
WebSocketVisitor()

Method Summary

Modifier and Type	Method	Description
Set<String>	getSupportedAnnotationNames()
@NonNull TypeElementVisitor.VisitorKind	getVisitorKind()
TypeElementQuery	query()	The query which allows to reduce the scope which the visitor is visiting.
void	start(VisitorContext visitorContext)	Called once when visitor processing starts.
void	visitMethod(MethodElement element, VisitorContext context)	Executed when a method is encountered that matches the <E> generic.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Methods inherited from interface io.micronaut.core.util.Toggleable

isEnabled

Methods inherited from interface io.micronaut.inject.visitor.TypeElementVisitor

finish, getClassType, getElementType, getSupportedOptions, visitClass, visitConstructor, visitEnumConstant, visitField

Constructor Details

WebSocketVisitor

public WebSocketVisitor()

Method Details

getVisitorKind

@NonNull
public @NonNull TypeElementVisitor.VisitorKind getVisitorKind()

Specified by:

getVisitorKind in interface TypeElementVisitor<WebSocketComponent,WebSocketMapping>

Returns:

The visitor kind.

getSupportedAnnotationNames

public Set<String> getSupportedAnnotationNames()

Specified by:

getSupportedAnnotationNames in interface TypeElementVisitor<WebSocketComponent,WebSocketMapping>

Returns:

The supported default annotation names.

query

public TypeElementQuery query()

Description copied from interface: TypeElementVisitor

The query which allows to reduce the scope which the visitor is visiting.

Specified by:

query in interface TypeElementVisitor<WebSocketComponent,WebSocketMapping>

Returns:

The query if the visitor.

visitMethod

public void visitMethod(MethodElement element,
 VisitorContext context)

Description copied from interface: TypeElementVisitor

Executed when a method is encountered that matches the <E> generic.

Specified by:

visitMethod in interface TypeElementVisitor<WebSocketComponent,WebSocketMapping>

Parameters:

element - The element

context - The visitor context

start

public void start(VisitorContext visitorContext)

Description copied from interface: TypeElementVisitor

Called once when visitor processing starts.

Specified by:

start in interface TypeElementVisitor<WebSocketComponent,WebSocketMapping>

Parameters:

visitorContext - The visitor context