exponenta event banner

compiler.build. JavaPackageOptions

Параметры построения пакетов Java

Описание

пример

opts = compiler.build.JavaPackageOptions(Files) создает JavaPackageOptions с использованием функций MATLAB ®, указанных Files. Используйте JavaPackageOptions объект в качестве входных данных для compiler.build.javaPackage функция.

пример

opts = compiler.build.JavaPackageOptions(Files,Name,Value) создает JavaPackageOptions с параметрами, заданными с помощью одного или нескольких аргументов «имя-значение». Параметры включают имя пакета, каталог вывода и дополнительные файлы для включения.

пример

opts = compiler.build.JavaPackageOptions(ClassMap) создает JavaPackageOptions объект с сопоставлением классов, указанным с помощью container.Map объект ClassMap.

пример

opts = compiler.build.JavaPackageOptions(ClassMap,Name,Value) создает JavaPackageOptions объект с сопоставлением классов, указанным с помощью ClassMap и параметры, указанные с помощью одного или нескольких аргументов «имя-значение».

Примеры

свернуть все

Создать JavaPackageOptions с использованием ввода файла.

Для этого примера используйте файл magicsquare.m расположен в 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
                  Verbose: off
                OutputDir: '.\magicsquarejavaPackage'

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

Можно изменить значения свойств существующего JavaPackageOptions с использованием точечной нотации. Например, включить подробный вывод.

opts.Verbose = 'on'
opts = 

  JavaPackageOptions with properties:

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

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

Используйте JavaPackageOptions объект в качестве входных данных для compiler.build.javaPackage для создания пакета Java ®.

buildResults = compiler.build.javaPackage(opts);

Создать JavaPackageOptions и настройте его с помощью аргументов «имя-значение».

Для этого примера используйте файл magicsquare.m расположен в matlabroot\extern\examples\compiler. Используйте аргументы name-value, чтобы указать выходной каталог и отключить автоматическое обнаружение файлов данных.

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
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\MagicJavaPackage'

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

Можно изменить значения свойств существующего JavaPackageOptions с использованием точечной нотации. Например, включить подробный вывод.

opts.Verbose = 'on'
opts = 

  JavaPackageOptions with properties:

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

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

Используйте JavaPackageOptions объект в качестве входных данных для compiler.build.javaPackage для создания пакета Java.

buildResults = compiler.build.javaPackage(opts);

Создать JavaPackageOptions с использованием карты классов.

Создать containers.Map объект, ключи которого являются именами классов, а значения - файлами функций MATLAB.

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

Создать JavaPackageOptions объект с использованием карты классов cmap.

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

  JavaPackageOptions with properties:

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

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

Можно также создать JavaPackageOptions с помощью аргументов «имя-значение» или изменить существующий объект с помощью точечной нотации. В этом примере укажите каталог вывода, включите подробный вывод и отключите автоматическое обнаружение файлов данных.

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
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\MagicJavaPackage'

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

Используйте JavaPackageOptions объект в качестве входных данных для compiler.build.javaPackage для создания пакета Java.

buildResults = compiler.build.javaPackage(opts);

Входные аргументы

свернуть все

Файлы, реализующие функции MATLAB, указанные как символьный вектор, строковый скаляр, строковый массив или массив ячеек символьных векторов. Пути к файлам могут быть относительно текущей рабочей папки или абсолютными. Файлы должны иметь .m расширение.

Пример: ["myfunc1.m","myfunc2.m"]

Типы данных: char | string | cell

Карта классов, заданная как containers.Map объект. Ключи сопоставления - это имена классов, а каждое значение - это набор файлов, сопоставленных соответствующему классу. Файлы должны иметь .m расширение.

Пример: cmap

Аргументы пары «имя-значение»

Укажите дополнительные пары, разделенные запятыми Name,Value аргументы. Name является именем аргумента и Value - соответствующее значение. Name должен отображаться внутри кавычек. Можно указать несколько аргументов пары имен и значений в любом порядке как Name1,Value1,...,NameN,ValueN.

Пример: 'Verbose','on'

Дополнительные файлы для включения в пакет Java, указанные как символьный вектор, строковый скаляр, строковый массив или массив ячеек символьных векторов. Пути к файлам могут быть относительно текущей рабочей папки или абсолютными.

Пример: 'AdditionalFiles',["myvars.mat","data.txt"]

Типы данных: char | string | cell

Флажок для автоматического включения файлов данных, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on', то файлы данных, которые вы предоставляете в качестве входных данных для определенных функций (таких как load и fopen) автоматически включаются в пакет Java.

  • Если для этого свойства задано значение 'off', то необходимо добавить файлы данных в пакет с помощью AdditionalFiles собственность.

Пример: 'AutoDetectDataFiles','off'

Типы данных: logical

Имя класса Java, указанное как вектор символов или строковый скаляр. Этот параметр нельзя указать, если используется ClassMap вход. Имена классов должны соответствовать требованиям к именам классов Java.

Значением по умолчанию является имя первого файла, указанного в Files аргумент, добавленный с Class.

Пример: 'ClassName','magicsquareClass'

Типы данных: char | string

Флаг для включения символов отладки, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on', то скомпилированный пакет содержит символы отладки.

  • Если для этого свойства задано значение 'off', то скомпилированный пакет не содержит символов отладки.

Пример: 'DebugBuild','on'

Типы данных: logical

Путь к выходному каталогу, в котором сохраняются файлы построения, определяемый как вектор символов или строковый скаляр. Путь может быть относительно текущего рабочего каталога или абсолютным.

Имя по умолчанию папки построения - это имя пакета, добавленное с javaPackage.

Пример: 'OutputDir','D:\Documents\MATLAB\work\mymagicjavaPackage'

Типы данных: char | string

Имя пакета Java, указанное как вектор символов или скаляр строки. Определить 'PackageName' в качестве пространства имен, представляющего собой список, разделенный периодами, например companyname.groupname.component. Имя созданного пакета устанавливается в последнюю запись списка, разделенного на периоды. Имя должно начинаться с буквы и содержать только буквенные символы и точки.

Пример: 'PackageName','mathworks.javapackage.mymagic'

Типы данных: char | string

Образцы файлов MATLAB, используемые для создания образцов файлов драйвера Java для функций, включенных в пакет, указанных как вектор символов, скаляр строк, массив строк или массив ячеек векторов символов. Пути к файлам могут быть относительно текущей рабочей папки или абсолютными. Файлы должны иметь .m расширение.

Пример: 'SampleGenerationFiles',["sample1.m","sample2.m"]

Типы данных: char | string | cell

Флаг для управления подробностью построения, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on'затем в окне команд MATLAB отображается информация о ходе выполнения, указывающая на вывод компилятора в процессе построения.

  • Если для этого свойства задано значение 'off', то командное окно не отображает информацию о ходе выполнения.

Пример: 'Verbose','on'

Типы данных: logical

Выходные аргументы

свернуть все

Параметры сборки пакета Java, возвращенные как JavaPackageOptions объект.

Представлен в R2021a