com.vaadin.flow.component.polymertemplate.

Class NpmTemplateParser

  • All Implemented Interfaces:

    TemplateParser


    public class NpmTemplateParser
extends Object
implements TemplateParser

    Npm template parser implementation.

    The implementation scans all JsModule annotations for the given template class and tries to find the one that contains template definition using the tag name.

    The class is Singleton. Use getInstance() to get its instance.

    Since:

    2.0

    Author:

    Vaadin Ltd

    See Also:

    BundleParser

    • Constructor Detail

      • NpmTemplateParser

        protected NpmTemplateParser()

        The default constructor. Protected in order to prevent direct instantiation, but not private in order to allow mocking/overrides for testing purposes.

    • Method Detail

      • getSourcesFromTemplate

        protected String getSourcesFromTemplate(String tag,
                                        String url)

        Finds the JavaScript sources for given tag.

        Parameters:

        tag - the value of the Tag annotation, e.g. `my-component`

        url - the URL resolved according to the JsModule spec, for example ./view/my-view.js or @vaadin/vaadin-button.js.

        Returns:

        the .js source which declares given custom element, or null if no such source can be found.

      • isStatsFileReadNeeded

        protected boolean isStatsFileReadNeeded(VaadinService service)
                                 throws IOException

        Check status to see if stats.json needs to be loaded and parsed.

        Always load if jsonStats is null, never load again when we have a bundle as it never changes, always load a new stats if the hash has changed and we do not have a bundle.

        Parameters:

        service - the Vaadin service.

        Returns:

        true if we need to re-load and parse stats.json, else false

        Throws:

        IOException