com.vaadin.flow.server.frontend.TaskGenerateIndexTs API 24.7.0.alpha6

com.vaadin.flow.server.frontend.TaskGenerateIndexTs

All Implemented Interfaces:

FallibleCommand

public class TaskGenerateIndexTs extends AbstractTaskClientGenerator

Generate index.ts if it is missing in frontend folder.

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

Since:

3.0

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

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

com.vaadin.flow.server.frontend.

Class TaskGenerateIndexTs

Method Summary

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

Methods inherited from class java.lang.Object

Method Details

execute

getGeneratedFile

shouldGenerate

getFileContent