com.vaadin.flow.component.polymertemplate

Class NpmTemplateParser

java.lang.Object

com.vaadin.flow.component.polymertemplate.NpmTemplateParser

All Implemented Interfaces:

TemplateParser

Deprecated.

Use LitTemplateParserImpl class for LitTemplate components. Polymer template support is deprecated - we recommend you to use LitTemplate instead. Read more details from the Vaadin blog.

@Deprecated
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.

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

Since:

2.0

Author:

Vaadin Ltd

See Also:

BundleParser

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.component.polymertemplate.TemplateParser

TemplateParser.TemplateData, TemplateParser.TemplateParserFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NpmTemplateParser() Deprecated. The default constructor.

Method Summary

Modifier and Type	Method and Description
static TemplateParser	getInstance() Deprecated.
protected String	getSourcesFromTemplate(VaadinService service, String tag, String url) Deprecated. Finds the JavaScript sources for given tag.
TemplateParser.TemplateData	getTemplateContent(Class<? extends PolymerTemplate<?>> clazz, String tag, VaadinService service) Deprecated. Gets the template data which contains a JSOUP Element representing the template content and the template uri.
protected boolean	isStatsFileReadNeeded(VaadinService service) Deprecated. Check status to see if stats.json needs to be loaded and parsed.

Methods inherited from class java.lang.Object

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

Constructor Detail

NpmTemplateParser

protected NpmTemplateParser()

Deprecated.

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

Method Detail

getInstance

public static TemplateParser getInstance()

Deprecated.

getTemplateContent

public TemplateParser.TemplateData getTemplateContent(Class<? extends PolymerTemplate<?>> clazz,
                                                      String tag,
                                                      VaadinService service)

Deprecated.

Description copied from interface: TemplateParser

Gets the template data which contains a JSOUP Element representing the template content and the template uri.

Specified by:

getTemplateContent in interface TemplateParser

Parameters:

clazz - the template class

tag - the template tag name

service - the related Vaadin service

Returns:

the template data

getSourcesFromTemplate

protected String getSourcesFromTemplate(VaadinService service,
                                        String tag,
                                        String url)

Deprecated.

Finds the JavaScript sources for given tag.

Parameters:

service - the related Vaadin service

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

Deprecated.

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