We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.server.frontend.
Package com.vaadin.flow.server.frontend
Class AbstractFileGeneratorFallibleCommand
java.lang.Object
com.vaadin.flow.server.frontend.AbstractFileGeneratorFallibleCommand
All Implemented Interfaces:
Direct Known Subclasses:
AbstractTaskClientGenerator, TaskCopyFrontendFiles, TaskCopyLocalFrontendFiles, TaskGenerateReactFiles, TaskUpdateThemeImport
public abstract class AbstractFileGeneratorFallibleCommand
extends Object
implements FallibleCommand
A base class for commands providing helpers for common file generation actions.
By extending this class, commands can track generated files for subsequent processes. In addition, it allows to avoid writes on disk of the file already exists and has exactly the same generated content, preventing file system watchers to trigger unnecessary events.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAccepts
GeneratedFilesSupportutility allows to track generated files but write them only when the content is changed, preventing filesystem watchers to be triggered when not required.protected voidMarks the give file as generated by the task.
protected voidtrack(Collection<File> files) Marks the give files as generated by the task.
protected booleanwriteIfChanged(File file, String content) Writes the given content into the given file unless the file already contains that content.
protected booleanwriteIfChanged(File file, List<String> content) Writes the given content into the given file unless the file already contains that content.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.server.frontend.FallibleCommand
execute
-
Constructor Details
-
AbstractFileGeneratorFallibleCommand
public AbstractFileGeneratorFallibleCommand()
-
-
Method Details
-
setGeneratedFileSupport
Description copied from interface:
FallibleCommandAccepts
GeneratedFilesSupportutility allows to track generated files but write them only when the content is changed, preventing filesystem watchers to be triggered when not required.Specified by:
setGeneratedFileSupportin interfaceFallibleCommandParameters:
support- the generated file support utility to use. -
writeIfChanged
Writes the given content into the given file unless the file already contains that content.
Parameters:
file- the file to write tocontent- the lines to writeReturns:
true if the content was written to the file, false otherwise
Throws:
IOException- if something went wrong -
writeIfChanged
Writes the given content into the given file unless the file already contains that content.
Parameters:
file- the file to write tocontent- the content to writeReturns:
true if the content was written to the file, false otherwise
Throws:
IOException- if something went wrong -
track
Marks the give file as generated by the task.
Parameters:
file- the file to be marked as generated. -
track
Marks the give files as generated by the task.
Parameters:
files- the collection of files to be marked as generated.
-