Package com.vaadin.signals.shared

Class SignalUtils

java.lang.Object

com.vaadin.signals.shared.SignalUtils

public class SignalUtils
extends Object

Utility class for accessing/using signals internal API.

Note: This is internal API for Vaadin platform's internal usages. It is not intended for public use and may change or be removed in future releases.

Method Summary

Modifier and Type	Method	Description
static boolean	isValid(AbstractSignal<?> signal, SignalCommand command)	Checks whether the given command is considered valid by the validator instance of the provided signal.
static SignalTree	treeOf(AbstractSignal<?> signal)	Returns the underlying SignalTree instance of the given signal.

Methods inherited from class java.lang.Object

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

Method Details

treeOf

public static SignalTree treeOf(AbstractSignal<?> signal)

Returns the underlying SignalTree instance of the given signal.

Parameters:

signal - the signal to get the tree of, not null

Returns:

the signal tree instance, not null

isValid

public static boolean isValid(AbstractSignal<?> signal,
 SignalCommand command)

Checks whether the given command is considered valid by the validator instance of the provided signal. In case of composite commands such as transactions, this method will recursively check the validity of all commands in the transaction.

Note: This only checks the validity of the commands that might make changes to the data.

Parameters:

signal - the signal to check the command against, notnull

command - the command to check, not null

Returns:

true if the command is valid, false otherwise