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\примеры\компилятор.

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\примеры\компилятор. Используйте аргументы имя-значение, чтобы задать выход директории и отключить автоматическое обнаружение файлов данных.

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 объект. Ключи 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. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа 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. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа 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. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

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

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

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

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

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

свернуть все

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

Введенный в R2021a