Package com.vaadin.flow.internal.nodefeature

Class ClientCallableHandlers

java.lang.Object

com.vaadin.flow.internal.nodefeature.NodeFeature

com.vaadin.flow.internal.nodefeature.NodeList<T>

com.vaadin.flow.internal.nodefeature.SerializableNodeList<String>

com.vaadin.flow.internal.nodefeature.AbstractServerHandlers<Component>

com.vaadin.flow.internal.nodefeature.ClientCallableHandlers

All Implemented Interfaces:

Serializable

public class ClientCallableHandlers
extends AbstractServerHandlers<Component>

Methods which are published as element.$server.<name> on the client side.

For internal use only. May be renamed or removed in a future release.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.internal.nodefeature.NodeList

NodeList.SetView<T extends Serializable>

Constructor Summary

Constructors

Constructor	Description
ClientCallableHandlers(StateNode node)	Creates a new meta information list for the given state node.

Method Summary

Modifier and Type	Method	Description
protected void	ensureSupportedParameterTypes(Method method)	Validate parameter support for given method.
protected void	ensureSupportedReturnType(Method method)	Validate return type support for given method.
protected Class<? extends ClientCallable>	getHandlerAnnotation()	Gets the annotation which is used to mark methods as handlers.
protected DisabledUpdateMode	getUpdateMode(Method method)	Returns method's RPC communication mode from the client side to the server side when the element is disabled.

Methods inherited from class com.vaadin.flow.internal.nodefeature.AbstractServerHandlers

addHandlerMethod, collectHandlerMethods, collectHandlerMethods, componentSet, getDisabledUpdateMode, getHandlerAnnotationFqn, hasHandler

Methods inherited from class com.vaadin.flow.internal.nodefeature.SerializableNodeList

add

Methods inherited from class com.vaadin.flow.internal.nodefeature.NodeList

add, addAll, clear, collectChanges, forEachChild, generateChangesFromEmpty, get, getChangeTracker, indexOf, isNodeValues, iterator, onDetach, remove, size

Methods inherited from class com.vaadin.flow.internal.nodefeature.NodeFeature

allowsChanges, attachPotentialChild, detatchPotentialChild, getNode, onAttach

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientCallableHandlers

public ClientCallableHandlers(StateNode node)

Creates a new meta information list for the given state node.

Parameters:

node - the state node this list belongs to

Method Detail

getHandlerAnnotation

protected Class<? extends ClientCallable> getHandlerAnnotation()

Description copied from class: AbstractServerHandlers

Gets the annotation which is used to mark methods as handlers.

Specified by:

getHandlerAnnotation in class AbstractServerHandlers<Component>

Returns:

the handler marker annotation

ensureSupportedParameterTypes

protected void ensureSupportedParameterTypes(Method method)

Description copied from class: AbstractServerHandlers

Validate parameter support for given method. Should validate parameter amount and parameter types.

Specified by:

ensureSupportedParameterTypes in class AbstractServerHandlers<Component>

Parameters:

method - Method to check parameters for

ensureSupportedReturnType

protected void ensureSupportedReturnType(Method method)

Description copied from class: AbstractServerHandlers

Validate return type support for given method.

Overrides:

ensureSupportedReturnType in class AbstractServerHandlers<Component>

Parameters:

method - method to check return type for

getUpdateMode

protected DisabledUpdateMode getUpdateMode(Method method)

Description copied from class: AbstractServerHandlers

Returns method's RPC communication mode from the client side to the server side when the element is disabled.

Specified by:

getUpdateMode in class AbstractServerHandlers<Component>

Parameters:

method - the method to get its update mode

Returns:

RPC communication mode for the method, not null