Package com.vaadin.flow.server.frontend

Class TaskGenerateIndexHtml

java.lang.Object

com.vaadin.flow.server.frontend.AbstractFileGeneratorFallibleCommand

com.vaadin.flow.server.frontend.AbstractTaskClientGenerator

com.vaadin.flow.server.frontend.TaskGenerateIndexHtml

All Implemented Interfaces:

FallibleCommand

public class TaskGenerateIndexHtml
extends AbstractTaskClientGenerator

Generate the default index.html into the frontend generated/ folder so the file is not committed to source control. A user-provided index.html placed directly in the frontend folder overrides it.

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

Since:

3.0

Method Summary

Modifier and Type	Method	Description
protected String	getFileContent()	Get file content for writing to the generated file.
protected File	getGeneratedFile()	Get the generated file where content will be written.
protected boolean	shouldGenerate()	Check if it should generate the file or not.

Methods inherited from class com.vaadin.flow.server.frontend.AbstractTaskClientGenerator

execute

Methods inherited from class com.vaadin.flow.server.frontend.AbstractFileGeneratorFallibleCommand

setGeneratedFileSupport, track, track, writeIfChanged, writeIfChanged

Methods inherited from class java.lang.Object

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

Method Details

getFileContent

protected String getFileContent()
                         throws IOException

Description copied from class: AbstractTaskClientGenerator

Get file content for writing to the generated file.

Specified by:

getFileContent in class AbstractTaskClientGenerator

Returns:

content of the file.

Throws:

IOException - if IO error happens while reading file content.

getGeneratedFile

protected File getGeneratedFile()

Description copied from class: AbstractTaskClientGenerator

Get the generated file where content will be written.

Specified by:

getGeneratedFile in class AbstractTaskClientGenerator

Returns:

the generated file.

shouldGenerate

protected boolean shouldGenerate()

Description copied from class: AbstractTaskClientGenerator

Check if it should generate the file or not.

Specified by:

shouldGenerate in class AbstractTaskClientGenerator

Returns:

true if it should generate, false otherwise.