Main Content

compiler.build.JavaPackageOptions

Options for building Java packages

Description

example

opts = compiler.build.JavaPackageOptions(Files) creates a JavaPackageOptions object using MATLAB® functions specified by Files. Use the JavaPackageOptions object as an input to the compiler.build.javaPackage function.

example

opts = compiler.build.JavaPackageOptions(Files,Name,Value) 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 = compiler.build.JavaPackageOptions(ClassMap) creates a JavaPackageOptions object with a class mapping specified using a container.Map object ClassMap.

example

opts = compiler.build.JavaPackageOptions(ClassMap,Name,Value) creates a JavaPackageOptions object with a class mapping specified using ClassMap and options specified using one or more name-value arguments.

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
        SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: '.\magicsquarejavaPackage'

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

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

opts.Verbose = 'on'
opts = 

  JavaPackageOptions with properties:

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

   Class Map Information
         magicsquareClass: {'C:\Program Files\MATLAB\R2021b\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
        SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\MagicJavaPackage'

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

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

opts.Verbose = 'on'
opts = 

  JavaPackageOptions with properties:

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

   Class Map Information
         magicsquareClass: {'C:\Program Files\MATLAB\R2021b\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 map cmap.

opts = compiler.build.JavaPackageOptions(cmap)
opts = 

  JavaPackageOptions with properties:

                 ClassMap: [1×1 containers.Map]
               DebugBuild: off
              PackageName: 'example.magicsquare'
    SampleGenerationFiles: {}
          AdditionalFiles: {}
      AutoDetectDataFiles: on
        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
          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 a .m extension.

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 a .m extension.

Example: cmap

Name-Value Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'Verbose','on'

Additional files to include in the Java package, 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.

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

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

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 the compiled package contains debug symbols.

  • If you set this property to 'off', then the compiled package does not contain debug symbols.

Example: 'DebugBuild','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 with javaPackage.

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

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

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

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

collapse all

Java package build options, returned as a JavaPackageOptions object.

Introduced in R2021a