compiler.build.JavaPackageOptions - Options for building Java packages - MATLAB (original) (raw)

Options for building Java packages

Since R2021a

Syntax

Description

[opts](#mw%5Fe3a1109d-7426-4de6-86d7-462f7e84e274) = compiler.build.JavaPackageOptions([Files](#mw%5Fd04398d3-7362-48f1-b175-1e660504fa08)) creates a JavaPackageOptions object using MATLAB® functions specified by Files. Use theJavaPackageOptions object as an input to the compiler.build.javaPackage function.

example

[opts](#mw%5Fe3a1109d-7426-4de6-86d7-462f7e84e274) = compiler.build.JavaPackageOptions([Files](#mw%5Fd04398d3-7362-48f1-b175-1e660504fa08),[Name,Value](#namevaluepairarguments)) creates a JavaPackageOptions object with options specified using one or more name-value arguments. Options include the package name, output directory, and additional files to include.

example

[opts](#mw%5Fe3a1109d-7426-4de6-86d7-462f7e84e274) = compiler.build.JavaPackageOptions([ClassMap](#mw%5Ffc68c051-f565-4380-9ec5-2b8cc37c519b)) creates a JavaPackageOptions object with a class mapping specified using acontainer.Map object ClassMap.

example

[opts](#mw%5Fe3a1109d-7426-4de6-86d7-462f7e84e274) = compiler.build.JavaPackageOptions([ClassMap](#mw%5Ffc68c051-f565-4380-9ec5-2b8cc37c519b),[Name,Value](#namevaluepairarguments)) creates a JavaPackageOptions object with a class mapping specified usingClassMap and options specified using one or more name-value arguments.

example

Examples

collapse all

Create a JavaPackageOptions object using file input.

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

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m'); opts = compiler.build.JavaPackageOptions(appFile)

opts =

JavaPackageOptions with properties:

             ClassMap: [1×1 containers.Map]
           DebugBuild: off
          PackageName: 'example.magicsquare'
SampleGenerationFiles: {}
      AdditionalFiles: {}
  AutoDetectDataFiles: on
     ObfuscateArchive: off
      SupportPackages: {'autodetect'}
              Verbose: off
            OutputDir: '.\magicsquarejavaPackage'

Class Map Information magicsquareClass: {'C:\Program Files\MATLAB\R2025a\extern\examples\compiler'}

You can modify the property values of an existingJavaPackageOptions object using dot notation. For example, enable verbose output.

opts =

JavaPackageOptions with properties:

             ClassMap: [1×1 containers.Map]
           DebugBuild: off
          PackageName: 'example.magicsquare'
SampleGenerationFiles: {}
      AdditionalFiles: {}
  AutoDetectDataFiles: on
     ObfuscateArchive: off
      SupportPackages: {'autodetect'}
              Verbose: on
            OutputDir: '.\magicsquarejavaPackage'

Class Map Information magicsquareClass: {'C:\Program Files\MATLAB\R2025a\extern\examples\compiler'}

Use the JavaPackageOptions object as an input to the compiler.build.javaPackage function to build a Java® package.

buildResults = compiler.build.javaPackage(opts);

Create a JavaPackageOptions object and customize it using name-value arguments.

For this example, use the file magicsquare.m located in_`matlabroot`_\extern\examples\compiler. Use name-value arguments to specify the output directory and disable automatic detection of data files.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m'); opts = compiler.build.JavaPackageOptions(appFile,... 'OutputDir','D:\Documents\MATLAB\work\MagicJavaPackage',... 'AutoDetectDataFiles','off')

opts =

JavaPackageOptions with properties:

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

Class Map Information magicsquareClass: {'C:\Program Files\MATLAB\R2025a\extern\examples\compiler'}

You can modify the property values of an existingJavaPackageOptions object using dot notation. For example, enable verbose output.

opts =

JavaPackageOptions with properties:

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

Class Map Information magicsquareClass: {'C:\Program Files\MATLAB\R2025a\extern\examples\compiler'}

Use the JavaPackageOptions object as an input to the compiler.build.javaPackage function to build a Java package.

buildResults = compiler.build.javaPackage(opts);

Create a JavaPackageOptions object using a class map.

Create a containers.Map object whose keys are class names and whose values are MATLAB function files.

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

Create the JavaPackageOptions object using the class mapcmap.

opts = compiler.build.JavaPackageOptions(cmap)

opts =

JavaPackageOptions with properties:

             ClassMap: [1×1 containers.Map]
           DebugBuild: off
          PackageName: 'example.magicsquare'
SampleGenerationFiles: {}
      AdditionalFiles: {}
  AutoDetectDataFiles: on
     ObfuscateArchive: off
     ObfuscateArchive: off
      SupportPackages: {'autodetect'}
              Verbose: off
            OutputDir: '.\magicsquarejavaPackage'

Class Map Information Class1: {2×1 cell} Class2: {2×1 cell}

You can also create a JavaPackageOptions object using name-value arguments or modify an existing object using dot notation. For this example, specify an output directory, enable verbose output, and disable automatic detection of data files.

opts = compiler.build.JavaPackageOptions(cmap,... 'OutputDir','D:\Documents\MATLAB\work\MagicJavaPackage',... 'Verbose','On'); opts.AutoDetectDataFiles = 'off';

opts =

JavaPackageOptions with properties:

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

Class Map Information Class1: {2×1 cell} Class2: {2×1 cell}

Use the JavaPackageOptions object as an input to the compiler.build.javaPackage function to build a Java package.

buildResults = compiler.build.javaPackage(opts);

Input Arguments

collapse all

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

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

Name-Value Arguments

collapse all

Specify optional pairs of arguments asName1=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'

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

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 totrue, and 'off' is equivalent tofalse. 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 asload 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 theAdditionalFiles property.

Example: 'AutoDetectDataFiles','off'

Data Types: logical

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 theFiles argument appended withClass.

Example: 'ClassName','magicsquareClass'

Data Types: char | string

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 totrue, and 'off' is equivalent tofalse. 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

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 andRuntimeKeyLoaderFile, 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 structkeyValueStruct.

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

Flag to obfuscate the deployable archive, specified as'on'/1/true or 'off'/0/false. 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 .m,.mlapp, .p, .mat, MLX, SFX, and MEX files are placed into a user package within the archive. Additionally, all .m files are converted to P-files before packaging.

During runtime, MATLAB code and data is decrypted and loaded directly from the user package rather than extracted to the file system. MEX files are temporarily extracted from the user package before being loaded.

To manually include additional file types in the user package, add each file type in a separate extension tag to the file_`matlabroot`_/toolbox/compiler/advanced_package_supported_files.xml.

The following are not supported:

ver function
Calling external libraries such as DLLs
Out-of-process MATLAB Runtime (C++ shared library for MATLAB Data Array)
Out-of-process MEX file execution (mexhost,feval,matlab.mex.MexHost)
Before R2023b: .mat files other than v7.3

Enabling 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

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 withjavaPackage.

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

Data Types: char | string

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 ascompanyname.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

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

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 callsgetSecret and you do not specify theSecretsManifest option, MATLAB Compiler™ issues a warning and generates a template JSON file in the output folder named_`<componentname>`__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

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, seecompiler.codetools.deployableSupportPackages.

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

Data Types: char | string | cell

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 totrue, and 'off' is equivalent tofalse. 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

collapse all

Java package build options, returned as a JavaPackageOptions object.

Version History

Introduced in R2021a

expand all

Use the ExternalEncryptionKey option to specify a 256-bit AES encryption key and a MEX-file loader interface to retrieve the decryption key at runtime. This option is equivalent to the mcc -k option.

Use the SecretsManifest option to include a JSON file that specifies secrets to embed within your deployable code archive. This option is equivalent to themcc -J option.

Use the ObfuscateArchive option to obfuscate folder structures and file names, and place MATLAB file data and user code 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.

Use the SupportPackages option to specify support packages to include in the deployable code archive.