com.vaadin.flow.server.frontend.FrontendToolsLocator API 24.7.0.rc2 | Vaadin

com.vaadin.flow.server.frontend.

java.lang.Object

com.vaadin.flow.server.frontend.FrontendToolsLocator

All Implemented Interfaces:

public class FrontendToolsLocator extends Object implements Serializable

Helps to locate the tools in the system by their names.

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

Since:

1.2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

FrontendToolsLocator()
Method Summary

Modifier and Type

Method

Description

Optional<File>

tryLocateTool(String toolName)

Makes an attempt to locate the tool by its name.

boolean

verifyTool(File toolPath)

Verifies that the tool specified works by performing its test launch.

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

Constructor Details
- FrontendToolsLocator
  
  public FrontendToolsLocator()
Method Details
- tryLocateTool
  
  public Optional<File> tryLocateTool(String toolName)
  
  Makes an attempt to locate the tool by its name. If there are multiple tools to pick from, the first one that will be selected.
  
  Parameters:
  
  toolName - the name of a tool to locate, not null
  
  Returns:
  
  absolute path to a tool if it was located and verifyTool(File) returned true for it or Optional.empty() if there are no such tools
- verifyTool
  
  public boolean verifyTool(File toolPath)
  
  Verifies that the tool specified works by performing its test launch.
  
  Parameters:
  
  toolPath - the path to a tool to check
  
  Returns:
  
  true if the test launch had ended with successful error code, false otherwise