Package com.vaadin.flow.server.frontend

Class TaskGenerateTsDefinitions

java.lang.Object

com.vaadin.flow.server.frontend.AbstractFileGeneratorFallibleCommand

com.vaadin.flow.server.frontend.AbstractTaskClientGenerator

com.vaadin.flow.server.frontend.TaskGenerateTsDefinitions

All Implemented Interfaces:

FallibleCommand

public class TaskGenerateTsDefinitions
extends AbstractTaskClientGenerator

Generate types.d.ts if it is missing in project folder and tsconfig.json exists in project folder.

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

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
protected static boolean	warningEmitted	Keeps track of whether a warning update has already been logged.

Method Summary

Modifier and Type	Method	Description
void	execute()	Runs the given command.
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.AbstractFileGeneratorFallibleCommand

setGeneratedFileSupport, track, track, writeIfChanged, writeIfChanged

Methods inherited from class java.lang.Object

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

Field Details

warningEmitted

protected static boolean warningEmitted

Keeps track of whether a warning update has already been logged. This is used to avoid spamming the log with the same message.

Method Details

execute

public void execute()
             throws ExecutionFailedException

Description copied from interface: FallibleCommand

Runs the given command.

If execution fails then the command may throw an exception which may give a message and a cause of the failure.

Specified by:

execute in interface FallibleCommand

Overrides:

execute in class AbstractTaskClientGenerator

Throws:

ExecutionFailedException - if there is an execution error

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.