compiler.build.javaPackage

Create Java package for deployment outside MATLAB

Since R2021a

Syntax

compiler.build.javaPackage(Files)

compiler.build.javaPackage(Files,Name,Value)

compiler.build.javaPackage(ClassMap)

compiler.build.javaPackage(ClassMap,Name,Value)

compiler.build.javaPackage(opts)

results = compiler.build.javaPackage(___)

Description

compiler.build.javaPackage(Files) creates a Java^® package using the MATLAB^® functions specified by Files. Before creating Java packages, see Configure Your Environment for Generating Java Packages.

compiler.build.javaPackage(Files,Name,Value) creates a Java package with additional options specified using one or more name-value arguments. Options include the class name, output directory, and additional files to include.

compiler.build.javaPackage(ClassMap) creates a Java package with a class mapping specified using a container.Map object ClassMap.

compiler.build.javaPackage(ClassMap,Name,Value) creates a Java package using ClassMap and additional options specified using one or more name-value arguments. Options include the package name, output directory, and additional files to include.

compiler.build.javaPackage(opts) creates a Java package with options specified using a compiler.build.JavaPackageOptions object opts. You cannot specify any other options using name-value arguments.

results = compiler.build.javaPackage(___) returns build information as a compiler.build.Results object using any of the input argument combinations in previous syntaxes. The build information consists of the build type, paths to the compiled files, and build options.

Examples

Create Java Package Using File Input

Create a Java package using a function file that generates a magic square.

In MATLAB, locate the MATLAB function that you want to deploy as a Java package. For this example, use the file magicsquare.m located in matlabroot\extern\examples\compiler.

appFile = which('magicsquare.m');

Build a Java package using the compiler.build.javaPackage command.

compiler.build.javaPackage(appFile);

This syntax generates the following within a folder named magicsquarejavaPackage in your current working directory:

• classes — Folder that contains the Java class files and the deployable archive file.

• doc — Folder that contains HTML documentation for all classes in the package.

• examples — Folder that contains Java source code files.

• GettingStarted.html — File that contains information on integrating your package.

• includedSupportPackages.txt — Text file that lists all support files included in the package.

• magicsquare.jar — Java archive file.

• mccExcludedFiles.log — Log file that contains a list of any toolbox functions that were not included in the application. For information on non-supported functions, see Functions Not Supported For Compilation.

• readme.txt — Readme file that contains information on deployment prerequisites and the list of files to package for deployment.

• requiredMCRProducts.txt — Text file that contains product IDs of products required by MATLAB Runtime to run the application.

• unresolvedSymbols.txt — Text file that contains information on unresolved symbols.

Customize Java Package

Create a Java package and customize it using name-value arguments.

For this example, use the files flames.m and flames.mat located in matlabroot\extern\examples\compiler.

appFile = which('flames.m');
MATFile = which('flames.mat');

Build a Java package using the compiler.build.javaPackage command. Use name-value arguments to specify the package name, add a MAT-file, and enable verbose output.

compiler.build.javaPackage(appFile,'PackageName','JavaFlames', ...
'AdditionalFiles',MATFile,'Verbose','on');

Create Java Package Using Class Map Input

Create a Java package using a class map and multiple MATLAB functions.

Create a containers.Map object whose keys are class names and whose values are the locations of function files.

cmap = containers.Map;
cmap('Class1') = {'exampleFcn1.m','exampleFcn2.m'};
cmap('Class2') = {'exampleFcn3.m','exampleFcn4.m'};

Build a Java package using the compiler.build.javaPackage command.

compiler.build.javaPackage(cmap);

You can also specify options using name-value arguments when you build the Java package.

compiler.build.javaPackage(cmap, ...
'PackageName','ExamplePackage','Verbose','on');

Customize Multiple Components Using Options Object

Customize multiple Java packages using a compiler.build.JavaPackageOptions object on a Windows^® system to specify a common output directory, use debug symbols, and enable verbose output.

For this example, use the file magicsquare.m located in matlabroot\extern\examples\compiler.

appFile = which('magicsquare.m');

Create a JavaPackageOptions object using appFile and additional options specified using name-value arguments.

opts = compiler.build.JavaPackageOptions(appFile, ...
'OutputDir','D:\Documents\MATLAB\work\JavaPackageBatch', ...
'DebugBuild','on','Verbose','on')

opts =

  JavaPackageOptions with properties:

                 ClassMap: [1×1 containers.Map]
               DebugBuild: on
              PackageName: 'example.magicsquare'
    SampleGenerationFiles: {}
          AdditionalFiles: {}
      AutoDetectDataFiles: on
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\JavaPackageBatch'

   Class Map Information
         magicsquareClass: {'C:\Program Files\MATLAB\R2024b\extern\examples\compiler\magicsquare.m'}

Build the Java package using the JavaPackageOptions object.

compiler.build.javaPackage(opts);

To compile using the function file hello.m with the same options, use dot notation to modify the ClassMap of the existing JavaPackageOptions object before running the build function again.

remove(opts.ClassMap, keys(opts.ClassMap));
opts.ClassMap('helloClass') = which('hello.m');
compiler.build.javaPackage(opts);

By modifying the ClassMap argument and recompiling, you can compile multiple components using the same options object.

Get Build Information from Java Package

Create a Java package and save information about the build type, generated files, included support packages, and build options to a compiler.build.Results object.

Compile using the file magicsquare.m.

results = compiler.build.javaPackage('magicsquare.m')

results = 

  Results with properties:

              BuildType: 'javaPackage'
                  Files: {3×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.JavaPackageOptions]

The Files property contains the paths to the following:

• doc folder

• magicsquare.jar

• GettingStarted.html

Input Arguments

Files — Files implementing MATLAB functions

character vector | string scalar | cell array of character vectors | string array

Files implementing MATLAB functions, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. File paths can be relative to the current working directory or absolute. Files must have one of the following extensions: .m, .p, .mlx, or .mexa64.

Example: ["myfunc1.m","myfunc2.m"]

Data Types: char | string | cell

ClassMap — Class map

containers.Map object

Class map, specified as a containers.Map object. Map keys are class names and each value is the set of files mapped to the corresponding class. Files must have one of the following extensions: .m, .p, .mlx, or .mexa64.

Example: cmap

opts — Java package build options

compiler.build.JavaPackageOptions object

Java package build options, specified as a compiler.build.JavaPackageOptions object.

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.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Verbose','on'

AdditionalFiles — Additional files

character vector | string scalar | cell array of character vectors | string array

Additional files and folders to include in the Java package, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. Paths can be relative to the current working directory or absolute.

Example: 'AdditionalFiles',["myvars.mat","data.txt"]

Data Types: char | string | cell

AutoDetectDataFiles — Flag to automatically include data files

'on' (default) | on/off logical value

Flag to automatically include data files, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• If you set this property to 'on', then data files that you provide as inputs to certain functions (such as load and fopen) are automatically included in the Java package.

• If you set this property to 'off', then you must add data files to the package using the AdditionalFiles property.

Example: 'AutoDetectDataFiles','off'

Data Types: logical

ClassName — Name of Java class

character vector | string scalar

Name of the Java class, specified as a character vector or a string scalar. You cannot specify this option if you use a ClassMap input. Class names must meet Java class name requirements.

The default value is the name of the first file listed in the Files argument appended with Class.

Example: 'ClassName','magicsquareClass'

Data Types: char | string

DebugBuild — Flag to enable debug symbols

'off' (default) | on/off logical value

Flag to enable debug symbols, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• If you set this property to 'on', then debugging symbol information is included in the compiled artifact. This option also causes mbuild to pass appropriate debugging flags to the system compiler. The debug option lets you back trace up to the point where you can identify if the failure occurred in the initialization of MATLAB Runtime, the function call, or the termination routine. This option does not let you debug your MATLAB files with an external debugger.

• If you set this property to 'off', then debug symbols are not included. This is the default option.

Example: 'DebugBuild','on'

Data Types: logical

ExternalEncryptionKey — Paths to encryption key and loader files

scalar struct

Since R2024b

Paths to the external AES encryption key and MEX key loader files, specified as a scalar struct with exactly two row char vector or string scalar fields named EncryptionKeyFile and RuntimeKeyLoaderFile, respectively. Both struct fields are required. File paths can be relative to the current working directory or absolute.

For example, specify the encryption key as encrypt.key and loader file as loader.mexw64 using struct keyValueStruct.

keyValueStruct.EncryptionKeyFile='encrypt.key'; keyValueStruct.RuntimeKeyLoaderFile='loader.mexw64'

The encryption key file must be in one of the following supported formats:

• Binary 256-bit AES key, with a 32 byte file size

• Hex encoded AES key, with a 64 byte file size

The MEX file loader retrieves the decryption key at runtime and must be an interface with the following arguments:

• prhs[0] — Input, char array specified as the static value 'get'

• prhs[1] — Input, char array specified as the CTF component UUID

• plhs[0] — Output, 32 byte UINT8 numeric array or 64 byte hex encoded char array, depending on the key format

Avoid sharing the same key across multiple CTFs.

Example: 'ExternalEncryptionKey',keyValueStruct

Data Types: struct

ObfuscateArchive — Flag to obfuscate deployable archive

'off' (default) | on/off logical value

Flag to obfuscate the deployable archive, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• If you set this property to 'on', then folder structures and file names in the deployable archive are obfuscated from the end user, and user code and data contained in MATLAB files are placed into a user package within the archive. Additionally, all .m files are converted to P-files before packaging. This option is equivalent to using mcc with -j and -s specified.

• If you set this property to 'off', then the deployable archive is not obfuscated. This is the default behavior.

Example: 'ObfuscateArchive','on'

Data Types: logical

OutputDir — Path to output directory

character vector | string scalar

Path to the output directory where the build files are saved, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.

The default name of the build folder is the package name appended with javaPackage.

Example: 'OutputDir','D:\Documents\MATLAB\work\mymagicjavaPackage'

Data Types: char | string

PackageName — Name of Java package

character vector | string scalar

Name of the Java package, specified as a character vector or a string scalar. Specify 'PackageName' as a namespace, which is a period-separated list, such as companyname.groupname.component. The name of the generated package is set to the last entry of the period-separated list. The name must begin with a letter and contain only alphabetic characters and periods.

Example: 'PackageName','mathworks.javapackage.mymagic'

Data Types: char | string

SampleGenerationFiles — MATLAB sample files

character vector | string scalar | cell array of character vectors | string array

MATLAB sample files used to generate sample Java driver files for functions included within the package, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. Paths can be relative to the current working directory or absolute. Files must have a .m extension.

Example: 'SampleGenerationFiles',["sample1.m","sample2.m"]

Data Types: char | string | cell

SecretsManifest — Path to JSON manifest file

character vector | string scalar

Since R2024b

Path to a secret manifest JSON file that specifies the secret keys to be embedded in the deployable archive, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.

If your MATLAB code calls the getSecret, getSecretMetadata, or isSecret function, you must specify the secret keys to embed in the deployable archive in a JSON secret manifest file. If your code calls getSecret and you do not specify the SecretsManifest option, MATLAB Compiler™ issues a warning and generates a template JSON file in the output folder named <component_name>_secrets_manifest.json. Modify this file by specifying the secret key names in the Embedded field.

The setSecret function is not deployable. To embed secret keys in a deployable archive, you must call setSecret in MATLAB before you build the archive.

For more information on deployment using secrets, see Handle Sensitive Information in Deployed Applications.

Example: 'SecretsManifest','D:\Documents\MATLAB\work\mycomponent\mycomponent_secrets_manifest.json'

Data Types: char | string

SupportPackages — Support packages

'autodetect' (default) | 'none' | string scalar | cell array of character vectors | string array

Support packages to include, specified as one of the following options:

• 'autodetect' (default) — The dependency analysis process detects and includes the required support packages automatically.

• 'none' — No support packages are included. Using this option can cause runtime errors.

• A string scalar, character vector, or cell array of character vectors — Only the specified support packages are included. To list installed support packages or those used by a specific file, see compiler.codetools.deployableSupportPackages.

Example: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

Data Types: char | string | cell

Verbose — Flag to control build verbosity

'off' (default) | on/off logical value

Flag to control build verbosity, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• If you set this property to 'on', then the MATLAB command window displays progress information indicating compiler output during the build process.

• If you set this property to 'off', then the command window does not display progress information.

Example: 'Verbose','on'

Data Types: logical

Output Arguments

results — Build results

compiler.build.Results object

Build results, returned as a compiler.build.Results object. The Results object contains:

• The build type, which is 'javaPackage'

• Paths to the compiled files

• A list of included support packages

• Build options, specified as a JavaPackageOptions object

Version History

Introduced in R2021a