Package tech.jhipster.lite.module.domain.packagejson

Class JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder

java.lang.Object

tech.jhipster.lite.module.domain.packagejson.JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder

Enclosing class:

JHipsterModulePackageJson

public static final class JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder	addDependency(PackageName packageName, NpmVersionSourceFactory versionSource)	Add a dependency to the package.json dependencies section.
JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder	addDependency(PackageName packageName, NpmVersionSourceFactory versionSource, PackageName versionPackageName)	Add a dependency to the package.json dependencies section with a specific version.
JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder	addDevDependency(PackageName packageName, NpmVersionSourceFactory versionSource)	Add a development dependency to the package.json devDependencies section.
JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder	addDevDependency(PackageName packageName, NpmVersionSourceFactory versionSource, PackageName versionPackageName)	Add a development dependency to the package.json devDependencies section with a specific version.
JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder	addScript(ScriptKey key, ScriptCommand command)	Add a script to the package.json scripts section.
JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder	addType(String moduleFormat)	Deprecated, for removal: This API element is subject to removal in a future version. Use type(NodeModuleFormat) instead
JHipsterModule.JHipsterModuleBuilder	and()	Finish building the package.json configuration and return to the parent module builder.
JHipsterModulePackageJson	build()	Build the JHipsterModulePackageJson instance.
JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder	removeDependency(PackageName packageName)	Remove a dependency from the package.json dependencies section.
JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder	removeDevDependency(PackageName packageName)	Remove a development dependency from the package.json devDependencies section.
JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder	type(NodeModuleFormat moduleFormat)	Defines the module format ("type") in the package.json.

Methods inherited from class java.lang.Object

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

Method Details

addScript

public JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder addScript(ScriptKey key,
 ScriptCommand command)

Add a script to the package.json scripts section.

Parameters:

key - the script key

command - the script command

Returns:

the builder itself

addDependency

public JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder addDependency(PackageName packageName,
 NpmVersionSourceFactory versionSource)

Add a dependency to the package.json dependencies section.

Parameters:

packageName - the name of the package

versionSource - the version source

Returns:

the builder itself

addDependency

public JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder addDependency(PackageName packageName,
 NpmVersionSourceFactory versionSource,
 PackageName versionPackageName)

Add a dependency to the package.json dependencies section with a specific version.

Parameters:

packageName - the name of the package

versionSource - the version source

versionPackageName - the name of the package providing the version

Returns:

the builder itself

removeDependency

public JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder removeDependency(PackageName packageName)

Remove a dependency from the package.json dependencies section.

Parameters:

packageName - the name of the package

Returns:

the builder itself

addDevDependency

public JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder addDevDependency(PackageName packageName,
 NpmVersionSourceFactory versionSource)

Add a development dependency to the package.json devDependencies section.

Parameters:

packageName - the name of the package

versionSource - the version source

Returns:

the builder itself

addDevDependency

public JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder addDevDependency(PackageName packageName,
 NpmVersionSourceFactory versionSource,
 PackageName versionPackageName)

Add a development dependency to the package.json devDependencies section with a specific version.

Parameters:

packageName - the name of the package

versionSource - the version source

versionPackageName - the name of the package providing the version

Returns:

the builder itself

removeDevDependency

public JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder removeDevDependency(PackageName packageName)

Remove a development dependency from the package.json devDependencies section.

Parameters:

packageName - the name of the package

Returns:

the builder itself

addType

@Deprecated(forRemoval=true,
            since="1.17.0")
public JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder addType(String moduleFormat)

Deprecated, for removal: This API element is subject to removal in a future version.

Use type(NodeModuleFormat) instead

Add a type to the package.json.

Parameters:

moduleFormat - the moduleFormat

Returns:

the builder itself

type

public JHipsterModulePackageJson.JHipsterModulePackageJsonBuilder type(NodeModuleFormat moduleFormat)

Defines the module format ("type") in the package.json.

Parameters:

moduleFormat - the module format

Returns:

the builder itself

and

public JHipsterModule.JHipsterModuleBuilder and()

Finish building the package.json configuration and return to the parent module builder.

Returns:

the parent module builder

build

public JHipsterModulePackageJson build()

Build the JHipsterModulePackageJson instance.

Returns:

a new instance of JHipsterModulePackageJson