org.ysb33r.gradle.jsecosystem.packages

Interface PackageDescriptor

public interface PackageDescriptor

Specifies various characteristics of a package which can be used for various commands, especially for installation or search.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPackageCoordinates() Returns a string that can be passed for installation purposes.
java.lang.String	getPackageName() Name of the executable without tags
java.lang.String	getScope() Package scope
java.lang.String	getTagName() Name of NPM tag
boolean	isJsr() Whether this is a JSR package.
static PackageDescriptor	of(java.lang.String pkgName, java.lang.String tagName) A simple package without a scope.
static PackageDescriptor	of(java.lang.String scope, java.lang.String pkgName, java.lang.String tagName) A scoped package.
static PackageDescriptor	ofJsr(java.lang.String scope, java.lang.String pkgName, java.lang.String tagName) A scoped JSR package.

Method Detail

of

static PackageDescriptor of(java.lang.String pkgName,
                            java.lang.String tagName)

A simple package without a scope.

Parameters:

pkgName - Package name.

tagName - Package version.

Returns:

A description of a package.

of

static PackageDescriptor of(java.lang.String scope,
                            java.lang.String pkgName,
                            java.lang.String tagName)

A scoped package.

Parameters:

scope - Package scope.

pkgName - Package name.

tagName - Package version.

Returns:

A description of a package.

ofJsr

static PackageDescriptor ofJsr(java.lang.String scope,
                               java.lang.String pkgName,
                               java.lang.String tagName)

A scoped JSR package.

Parameters:

scope - Package scope.

pkgName - Package name.

tagName - Package version.

Returns:

A description of a package.

getPackageName

java.lang.String getPackageName()

Name of the executable without tags

Returns:

NPM name

getTagName

java.lang.String getTagName()

Name of NPM tag

Returns:

NPM tag (or null if not defined).

getScope

java.lang.String getScope()

Package scope

Returns:

NPM scope (or null if not defined).

getPackageCoordinates

java.lang.String getPackageCoordinates()

Returns a string that can be passed for installation purposes.

Returns:

Package name

isJsr

boolean isJsr()

Whether this is a JSR package.

Returns:

true if JSR package.