matlab.mpm.PackageFolder

Package member folder

Since R2024b

Description

Use matlab.mpm.PackageFolder objects to specify package member folders for a matlab.mpm.Package object. A matlab.mpm.PackageFolder object stores package member folder information.

Creation

Syntax

pkgfolder = matlab.mpm.PackageFolder(path)

pkgfolder = matlab.mpm.PackageFolder(path,Languages=language)

Description

pkgfolder = matlab.mpm.PackageFolder(path) creates a package folder object with the specified path relative to the root folder. This object stores information for matlab.mpm.Package object metadata and does not actually create a folder.

pkgfolder = matlab.mpm.PackageFolder(path,Languages=language) specifies the Language property of the added folder as "matlab" or "java". (since R2025a)

Input Arguments

path — Folder path

string scalar | character vector

Folder path, specified as a string scalar or character vector containing the package member folder path relative to the package root folder. For example, for a package located at C:\MyCode\MyPackage, specify the member folder path as "MyPackage\MySubfolder".

This argument sets the Path property.

language — Folder Language

string array

Since R2025a

Folder Language, specified as a string array with values of "matlab" or "java". A folder can be designated as one or more languages. Folders designated as matlab are automatically added to the MATLAB search path when the package is installed. Folders designated as java are added to the Java class path, allowing Java resources to be accessible within MATLAB.

This argument sets the Languages property.

Properties

Path — Folder path

string scalar

Folder path, specified as a string scalar containing the package member folder path relative to the package root folder.

Languages — Folder Language

matlab.mpm.PackageFolderLanguage array

Since R2025a

Folder Language, returned as a matlab.mpm.PackageFolderLanguage array with values of matlab (default) or java. A folder can be designated as one or more languages.

Folders designated as matlab are automatically added to the MATLAB search path when the package is installed. Folders designated as java are added to the Java class path, allowing Java resources to be accessible within MATLAB. If a package folder is not designated as matlab, MATLAB files in that folder are ignored. If a package folder is not designated as java, JAR files in that folder are ignored.

Examples

Create a Package Folder

Create a matlab.mpm.PackageFolder object that represents a package member folder NewFolder located in the MyPackage root folder.

pkgfolder = matlab.mpm.PackageFolder("MyPackage/NewFolder")

pkgfolder = 

  PackageFolder with properties:

         Path: "MyPackage/NewFolder"
    Languages: matlab

Create Package Folder for Java Files

Create a matlab.mpm.PackageFolder object that represents a package member folder Java_Library_Folder located in the MyPackage root folder. Specify that this folder is for java files.

pkgfolder = matlab.mpm.PackageFolder("MyPackage/NewFolder","Languages","java")

pkgfolder = 

  PackageFolder with properties:

         Path: "MyPackage/NewFolder"
    Languages: java

Extended Capabilities

Thread-Based Environment

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

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

Version History

Introduced in R2024b

R2025a: Java files supported in packages

You can add Java code to MATLAB^® Packages. You can specify the language of package folders by setting the languages property of the matlab.mpm.PackageFolder object. When package is installed, all Java resources in a folder designated as java are added to both the dynamic and static class path.

If the languages property of a package folder is not designated as matlab, MATLAB files in that folder are ignored. If a package folder is not designated as java, JAR files in that folder are ignored.