Package com.vaadin.copilot

Class NewRouteTemplateHandler

java.lang.Object

com.vaadin.copilot.NewRouteTemplateHandler

public class NewRouteTemplateHandler
extends Object

Handles listing, supplying templates of new views that will be created by New Route Panel.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	NewRouteTemplateHandler.FlowTemplateRequest	Contains information to generate new Flow view
static final record	NewRouteTemplateHandler.HillaTemplateRequest	Contains information to generate new Flow view

Constructor Summary

Constructors

Constructor	Description
NewRouteTemplateHandler()

Method Summary

Modifier and Type	Method	Description
CompletableFuture<String>	getFlowTemplate(NewRouteTemplateHandler.FlowTemplateRequest flowTemplateRequest)	Creates a view template string that will have view configuration based on given parameters and invoke the template handler with it.
CompletableFuture<String>	getHillaTemplate(NewRouteTemplateHandler.HillaTemplateRequest hillaTemplateRequest)	Creates a view template string that will have view configuration based on given parameters and invoke the template handler with it.
List<String>	getTemplateNames(String framework)	It returns the template list for the given framework.
List<String>	getTemplateNames(String framework, SourceLanguage language)	Lists the templates that can be generated for the given framework and language.

Methods inherited from class java.lang.Object

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

Constructor Details

NewRouteTemplateHandler

public NewRouteTemplateHandler()

Method Details

getFlowTemplate

public CompletableFuture<String> getFlowTemplate(NewRouteTemplateHandler.FlowTemplateRequest flowTemplateRequest)

Creates a view template string that will have view configuration based on given parameters and invoke the template handler with it. It returns the empty template when template name is blank or equals to EMPTY or null.

Parameters:

flowTemplateRequest - Required parameters to create flow template

Returns:

a CompletableFuture with the template string

getHillaTemplate

public CompletableFuture<String> getHillaTemplate(NewRouteTemplateHandler.HillaTemplateRequest hillaTemplateRequest)

Creates a view template string that will have view configuration based on given parameters and invoke the template handler with it. It returns the empty template when template name is blank or equals to EMPTY or null.

Parameters:

hillaTemplateRequest - Required parameters to create hilla template

getTemplateNames

public List<String> getTemplateNames(String framework)

It returns the template list for the given framework. Label is the base file name, value is the file name.

Parameters:

framework - Either "hilla" or "flow"

Returns:

list of summary templates, which model has label and value properties

getTemplateNames

public List<String> getTemplateNames(String framework,
 SourceLanguage language)

Lists the templates that can be generated for the given framework and language.

Only the templates ported to Kotlin are offered for a Kotlin project, since offering one that cannot be generated would fail only after the user had picked it and named the view.

Parameters:

framework - either "hilla" or "flow"

language - the language the view will be written in

Returns:

the template labels