com.vaadin.fusion.

Class ExplicitNullableTypeChecker


  • public class ExplicitNullableTypeChecker
extends Object

    A checker for TypeScript null compatibility in Vaadin endpoint methods parameter and return types.

    • Constructor Detail

      • ExplicitNullableTypeChecker

        public ExplicitNullableTypeChecker()

    • Method Detail

      • isRequired

        public static boolean isRequired(AnnotatedElement element)

        Checks if the reflected element should be required (not nullable) in the generated Typescript code based on annotations.

        Parameters:

        element - an element to be required

        Returns:

        a result of check

      • isRequired

        public static boolean isRequired(List<com.github.javaparser.ast.expr.AnnotationExpr> annotations)

        Checks if the parsed node should be required (not nullable) in the generated Typescript code based on the list of annotations.

        Parameters:

        annotations - a list of node annotations to check

        Returns:

        a result of check

      • checkValueForAnnotatedElement

        public String checkValueForAnnotatedElement(Object value,
                                            AnnotatedElement annotatedElement)

        Validates the given value for the given expected method return value type.

        Parameters:

        value - the value to validate

        annotatedElement - the entity to be type checked

        Returns:

        error message when the value is null while the expected type does not explicitly allow null, or null meaning the value is OK.