com.vaadin.flow.server.frontend.NodeUpdater API 24.0.5 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.server.frontend.

java.lang.Object

com.vaadin.flow.server.frontend.NodeUpdater

All Implemented Interfaces:

FallibleCommand

Direct Known Subclasses:

TaskGeneratePackageJson, TaskUpdateImports, TaskUpdatePackages

public abstract class NodeUpdater extends Object implements FallibleCommand

Base abstract class for frontend updaters that needs to be run when in dev-mode or from the flow maven plugin.

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

Since:

2.0

Field Summary

Fields

Modifier and Type

Field

Description

protected static final String

DEP_NAME_FLOW_DEPS

Deprecated.

protected static final String

DEP_NAME_FLOW_JARS

Deprecated.

protected final FrontendDependenciesScanner

frontDeps

The FrontendDependencies object representing the application dependencies.

static final String

GENERATED_PREFIX

Relative paths of generated should be prefixed with this value, so they can be correctly separated from {projectDir}/frontend files.

protected Options

options
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

NodeUpdater(ClassFinder finder, FrontendDependenciesScanner frontendDependencies, Options options)

Constructor.
Method Summary

Modifier and Type

Method

Description

protected String

generateVersionsJson(elemental.json.JsonObject packageJson)

Generate versions json file for version locking.

protected File

getPackageJsonFile()

protected File

getPackageLockFile()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.server.frontend.FallibleCommand
execute

Field Details
- GENERATED_PREFIX
  
  public static final String GENERATED_PREFIX
  
  Relative paths of generated should be prefixed with this value, so they can be correctly separated from {projectDir}/frontend files.
  See Also:
  
  Constant Field Values
- DEP_NAME_FLOW_DEPS
  
  @Deprecated protected static final String DEP_NAME_FLOW_DEPS
  
  Deprecated.
  See Also:
  
  Constant Field Values
- DEP_NAME_FLOW_JARS
  
  @Deprecated protected static final String DEP_NAME_FLOW_JARS
  
  Deprecated.
  See Also:
  
  Constant Field Values
- frontDeps
  
  protected final FrontendDependenciesScanner frontDeps
  
  The FrontendDependencies object representing the application dependencies.
- options
  
  protected Options options
Constructor Details
- NodeUpdater
  
  protected NodeUpdater(ClassFinder finder, FrontendDependenciesScanner frontendDependencies, Options options)
  
  Constructor.
  
  Parameters:
  
  finder - a reusable class finder
  
  frontendDependencies - a reusable frontend dependencies
  
  options - the task options
Method Details
- getPackageJsonFile
  
  protected File getPackageJsonFile()
- getPackageLockFile
  
  protected File getPackageLockFile()
- generateVersionsJson
  
  protected String generateVersionsJson(elemental.json.JsonObject packageJson) throws IOException
  
  Generate versions json file for version locking.
  
  Returns:
  
  generated versions json file path
  
  Throws:
  
  IOException - when file IO fails