Package software.aws.awsprototypingsdk.nxmonorepo

Class SyncpackConfig.Builder

java.lang.Object

software.aws.awsprototypingsdk.nxmonorepo.SyncpackConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SyncpackConfig>

Enclosing interface:

SyncpackConfig

@Stability(Stable)
public static final class SyncpackConfig.Builder
extends Object
implements software.amazon.jsii.Builder<SyncpackConfig>

A builder for SyncpackConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SyncpackConfig	build()	Builds the configured instance.
SyncpackConfig.Builder	dependencyTypes(List<String> dependencyTypes)	Sets the value of SyncpackConfig.getDependencyTypes()
SyncpackConfig.Builder	dev(Boolean dev)	Sets the value of SyncpackConfig.getDev()
SyncpackConfig.Builder	filter(String filter)	Sets the value of SyncpackConfig.getFilter()
SyncpackConfig.Builder	indent(String indent)	Sets the value of SyncpackConfig.getIndent()
SyncpackConfig.Builder	overrides(Boolean overrides)	Sets the value of SyncpackConfig.getOverrides()
SyncpackConfig.Builder	peer(Boolean peer)	Sets the value of SyncpackConfig.getPeer()
SyncpackConfig.Builder	pnpmOverrides(Boolean pnpmOverrides)	Sets the value of SyncpackConfig.getPnpmOverrides()
SyncpackConfig.Builder	prod(Boolean prod)	Sets the value of SyncpackConfig.getProd()
SyncpackConfig.Builder	resolutions(Boolean resolutions)	Sets the value of SyncpackConfig.getResolutions()
SyncpackConfig.Builder	semverGroups(List<? extends SemverGroup> semverGroups)	Sets the value of SyncpackConfig.getSemverGroups()
SyncpackConfig.Builder	semverRange(String semverRange)	Sets the value of SyncpackConfig.getSemverRange()
SyncpackConfig.Builder	sortAz(List<String> sortAz)	Sets the value of SyncpackConfig.getSortAz()
SyncpackConfig.Builder	sortFirst(List<String> sortFirst)	Sets the value of SyncpackConfig.getSortFirst()
SyncpackConfig.Builder	source(List<String> source)	Sets the value of SyncpackConfig.getSource()
SyncpackConfig.Builder	versionGroups(List<? extends VersionGroup> versionGroups)	Sets the value of SyncpackConfig.getVersionGroups()
SyncpackConfig.Builder	workspace(Boolean workspace)	Sets the value of SyncpackConfig.getWorkspace()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

dependencyTypes

@Stability(Stable)
public SyncpackConfig.Builder dependencyTypes(List<String> dependencyTypes)

Sets the value of SyncpackConfig.getDependencyTypes()

Parameters:

dependencyTypes - which dependency properties to search within. This parameter is required.

Returns:

this

dev

@Stability(Stable)
public SyncpackConfig.Builder dev(Boolean dev)

Sets the value of SyncpackConfig.getDev()

Parameters:

dev - whether to search within devDependencies. This parameter is required.

Returns:

this

filter

@Stability(Stable)
public SyncpackConfig.Builder filter(String filter)

Sets the value of SyncpackConfig.getFilter()

Parameters:

filter - a string which will be passed to `new RegExp()` to match against package names that should be included. This parameter is required.

Returns:

this

indent

@Stability(Stable)
public SyncpackConfig.Builder indent(String indent)

Sets the value of SyncpackConfig.getIndent()

Parameters:

indent - the character(s) to be used to indent your package.json files when writing to disk. This parameter is required.

Returns:

this

overrides

@Stability(Stable)
public SyncpackConfig.Builder overrides(Boolean overrides)

Sets the value of SyncpackConfig.getOverrides()

Parameters:

overrides - whether to search within npm overrides. This parameter is required.

Returns:

this

peer

@Stability(Stable)
public SyncpackConfig.Builder peer(Boolean peer)

Sets the value of SyncpackConfig.getPeer()

Parameters:

peer - whether to search within peerDependencies. This parameter is required.

Returns:

this

pnpmOverrides

@Stability(Stable)
public SyncpackConfig.Builder pnpmOverrides(Boolean pnpmOverrides)

Sets the value of SyncpackConfig.getPnpmOverrides()

Parameters:

pnpmOverrides - whether to search within pnpm overrides. This parameter is required.

Returns:

this

prod

@Stability(Stable)
public SyncpackConfig.Builder prod(Boolean prod)

Sets the value of SyncpackConfig.getProd()

Parameters:

prod - whether to search within dependencies. This parameter is required.

Returns:

this

resolutions

@Stability(Stable)
public SyncpackConfig.Builder resolutions(Boolean resolutions)

Sets the value of SyncpackConfig.getResolutions()

Parameters:

resolutions - whether to search within yarn resolutions. This parameter is required.

Returns:

this

semverGroups

@Stability(Stable)
public SyncpackConfig.Builder semverGroups(List<? extends SemverGroup> semverGroups)

Sets the value of SyncpackConfig.getSemverGroups()

Parameters:

semverGroups - the value to be set. This parameter is required.

Returns:

this

semverRange

@Stability(Stable)
public SyncpackConfig.Builder semverRange(String semverRange)

Sets the value of SyncpackConfig.getSemverRange()

Parameters:

semverRange - defaults to `""` to ensure that exact dependency versions are used instead of loose ranges. This parameter is required.

Returns:

this

sortAz

@Stability(Stable)
public SyncpackConfig.Builder sortAz(List<String> sortAz)

Sets the value of SyncpackConfig.getSortAz()

Parameters:

sortAz - which fields within package.json files should be sorted alphabetically. This parameter is required.

Returns:

this

sortFirst

@Stability(Stable)
public SyncpackConfig.Builder sortFirst(List<String> sortFirst)

Sets the value of SyncpackConfig.getSortFirst()

Parameters:

sortFirst - which fields within package.json files should appear at the top, and in what order. This parameter is required.

Returns:

this

source

@Stability(Stable)
public SyncpackConfig.Builder source(List<String> source)

Sets the value of SyncpackConfig.getSource()

Parameters:

source - glob patterns for package.json file locations. This parameter is required.

Returns:

this

versionGroups

@Stability(Stable)
public SyncpackConfig.Builder versionGroups(List<? extends VersionGroup> versionGroups)

Sets the value of SyncpackConfig.getVersionGroups()

Parameters:

versionGroups - the value to be set. This parameter is required.

Returns:

this

workspace

@Stability(Stable)
public SyncpackConfig.Builder workspace(Boolean workspace)

Sets the value of SyncpackConfig.getWorkspace()

Parameters:

workspace - whether to include the versions of the `--source` packages developed in your workspace/monorepo as part of the search for versions to sync. This parameter is required.

Returns:

this

build

@Stability(Stable)
public SyncpackConfig build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<SyncpackConfig>

Returns:

a new instance of SyncpackConfig

Throws:

NullPointerException - if any required attribute was not provided