com.vaadin.flow.plugin.production

Class WebJarPackage

java.lang.Object

com.vaadin.flow.plugin.production.WebJarPackage

public class WebJarPackage
extends Object

Wrapper around ArtifactData that holds information about a package located in the corresponding WebJar.

Since:

1.0.

Author:

Vaadin Ltd

Constructor Summary

Constructors

Constructor and Description
WebJarPackage(ArtifactData webJar, String packageName, String pathToPackage) Creates new wrapper instance.

Method Summary

Modifier and Type	Method and Description
String	getPackageName() Gets the name of the package in the WebJar.
String	getPathToPackage() Gets path to package that in the WebJar.
ArtifactData	getWebJar() Gets the WebJar that holds the package.
static WebJarPackage	selectCorrectPackage(WebJarPackage package1, WebJarPackage package2) Attempts to select correct package out of two WebJar package data, resolving common WebJar issues: https://github.com/webjars/webjars/issues/1656 https://github.com/webjars/webjars/issues/1452 Versions of the parent packages are considered, even if they are different from the package's one.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebJarPackage

public WebJarPackage(ArtifactData webJar,
                     String packageName,
                     String pathToPackage)

Creates new wrapper instance.

Parameters:

webJar - the WebJar that holds the package in, not null

packageName - name of a package inside the WebJar, not null

pathToPackage - path to package inside the WebJar, not null

Method Detail

getWebJar

public ArtifactData getWebJar()

Gets the WebJar that holds the package.

Returns:

web jar data

getPackageName

public String getPackageName()

Gets the name of the package in the WebJar.

Returns:

name of the package

getPathToPackage

public String getPathToPackage()

Gets path to package that in the WebJar.

Returns:

path to package

selectCorrectPackage

public static WebJarPackage selectCorrectPackage(WebJarPackage package1,
                                                 WebJarPackage package2)

Attempts to select correct package out of two WebJar package data, resolving common WebJar issues:

• https://github.com/webjars/webjars/issues/1656
• https://github.com/webjars/webjars/issues/1452

Versions of the parent packages are considered, even if they are different from the package's one. The reason for this is: bower.json version field deprecation notes

Parameters:

package1 - first package data

package2 - second package data

Returns:

package with as less issues as possible

Throws:

IllegalArgumentException - when packages have different names or versions