matlab.mpm.PackageSpecifier

Specify package qualifiers

Since R2024b

Description

A matlab.mpm.PackageSpecifier object can be used to match one or more packages based on the specified package identifying information , Name, Version, and UUID. Version and UUID are optional and Version can be specified as a version range. You can use a package specifier to search for or install packages using mpmsearch or mpminstall.

Creation

Syntax

pkgspec = matlab.mpm.PackageSpecifier(spec)

pkgspec = matlab.mpm.PackageSpecifier(spec,Name=Value)

Description

pkgspec = matlab.mpm.PackageSpecifier(spec) creates the package specifier object using the specified string or PackageIdentifier object.

pkgspec = matlab.mpm.PackageSpecifier(spec,Name=Value), if spec is just a package name, specifies the VersionRange property, ID property, or both using one or more name-value arguments.

Input Arguments

spec — Package specifier

string scalar | matlab.mpm.PackageIdentifier object

Package specifier string, specified as a string scalar containing a package specifier with the format "Name", "Name@VersionRange", or "Name@VersionRange@ID" or a matlab.mpm.PackageIdentifier object.

Based on the format of the string, this argument sets the Name, VersionRange, and ID properties.

Example: "MyPackage"

Example: "MyPackage@>1.2.3"

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: pkgspec = matlab.mpm.PackageSpecifier("MyPackage",VersionRange="1.0.0")

VersionRange — Version range

string scalar | character vector

Version range, specified as a string scalar or character vector.

Version syntax follows the Semantic Versioning 2.0.0 format: <major>.<minor>.<patch>, where each version number must be a nonnegative integer, for example 1.2.3. You can optionally specify a pre-release version by adding -<prerelease> to the end of the version, for example 1.2.3-alpha. Optionally specify a build version by adding +<build>.

Specify a range of versions by including the <, <=, >, or >= operators in front of a version number. For example, >2.1.13 specifies all versions greater than 2.1.13. Specify more than one range separated by white space to further limit matches. For example, >2.1.13 <=2.1.15 includes versions 2.1.14 and 2.1.15, but not 2.1.13 or 2.1.16. Use the || operator to designate multiple acceptable version ranges. For example, <2.1.13 || >2.1.15 includes versions less than 2.1.13 and greater than 2.1.15, but not 2.1.14.

This argument sets the VersionRange property.

Example: VersionRange="1.2.3"

Example: VersionRange="1.2.3-alpha"

Example: VersionRange="1.2.3-alpha+exp"

Example: VersionRange=">2.1.13"

Example: VersionRange=">2.1.13 <=2.1.15"

Example: VersionRange="<2.1.13 || >2.1.15"

ID — Package UUID

string scalar

Package UUID, specified as a string scalar containing a universally unique identifier (UUID).

Example: "9ecfea6b-1710-4fb9-aa66-e4750f0e8251"

Properties

Name — Package name

string scalar

Package name, specified as a string scalar containing the name of the package.

VersionRange — Version range

* (default) | string scalar

Version range, specified as a string scalar containing a semantic version range. By default, this property is "*", which represents all versions.

ID — Package UUID

string scalar

Package UUID, specified as a string scalar containing a universally unique identifier (UUID).

Examples

Create Package Specifier

Create a package specifier for a package named MyPackage.

pkgspec = matlab.mpm.PackageSpecifier("MyPackage")

pkgspec = 

  PackageSpecifier with properties:

            Name: "MyPackage"
    VersionRange: "*"
              ID: <missing>

Create Package Specifier with Version

Create a package specifier for a package named MyPackage, specifying that it is version 1.0.0.

pkgspec = matlab.mpm.PackageSpecifier("MyPackage",VersionRange="1.0.0")

pkgspec = 

  PackageSpecifier with properties:

            Name: "MyPackage"
    VersionRange: "1.0.0"
              ID: <missing>

Extended Capabilities

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

The matlab.mpm.PackageSpecifier function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History

Introduced in R2024b