Класс Configuration

java.lang.Object

jdk.jfr.Configuration

public final class Configuration extends Object

Набор параметров и метаданных, описывающих конфигурацию.

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

public static void main(String... args) throws Exception {
    if (args.length == 0) {
        System.out.println("Configurations:");
        for (Configuration c : Configuration.getConfigurations()) {
            System.out.println("Name: " + c.getName());
            System.out.println("Label: " + c.getLabel());
            System.out.println("Description: " + c.getDescription());
            System.out.println("Provider: " + c.getProvider());
            System.out.println();
        }
    } else {
        String name = args[0];
        Configuration c = Configuration.getConfiguration(name);
        try (Recording r = new Recording(c)) {
            System.out.println("Starting recording with settings:");
            for (Map.Entry<String, String> setting : c.getSettings().entrySet()) {
                System.out.println(setting.getKey() + " = " + setting.getValue());
            }
            r.start();
        }
    }
}

Начиная с версии:: 9

Краткое описание методов

Модификатор и тип	Метод	Описание
`static Configuration`	`create(Reader reader)`	Читает конфигурацию из символьного потока.
`static Configuration`	`create(Path path)`	Читает конфигурацию из файла.
`static Configuration`	`getConfiguration(String name)`	Возвращает предопределённую конфигурацию.
`static List<Configuration>`	`getConfigurations()`	Возвращает неизменяемый список предопределённых конфигураций для этой виртуальной машины Java (JVM).
`String`	`getContents()`	Возвращает текстовое представление конфигурации (например, содержимое файла JFC).
`String`	`getDescription()`	Возвращает короткое предложение, описывающее конфигурацию (например, `"Low overhead configuration safe for continuous use in production environments"`)
`String`	`getLabel()`	Возвращает понятное человеку имя (например, `"Continuous" or "Profiling"`}.
`String`	`getName()`	Возвращает идентифицирующее имя (например, `"default" or "profile")`.
`String`	`getProvider()`	Возвращает сведения о создателе конфигурации (например, `"OpenJDK"`).
`Map<String,String>`	`getSettings()`	Возвращает параметры, определяющие конфигурацию записи.

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание методов

getSettings

public Map<String,String> getSettings()

Возвращает параметры, определяющие конфигурацию записи.

Изменение возвращённого объекта Map не меняет конфигурацию.

Возвращает:: параметры, не null

getName

public String getName()

Возвращает идентифицирующее имя (например, "default" or "profile").

Возвращает:: имя или null, если оно отсутствует

getLabel

public String getLabel()

Возвращает понятное человеку имя (например, "Continuous" or "Profiling"}.

Возвращает:: метку или null, если она отсутствует

getDescription

public String getDescription()

Возвращает короткое предложение, описывающее конфигурацию (например,

"Low
overhead configuration safe for continuous use in production
environments"

)

Возвращает:: описание или null, если оно отсутствует

getProvider

public String getProvider()

Возвращает сведения о создателе конфигурации (например, "OpenJDK").

Возвращает:: поставщика или null, если он отсутствует

getContents

public String getContents()

Возвращает текстовое представление конфигурации (например, содержимое файла JFC).

Возвращает:

содержимое или null, если оно отсутствует

См. также:

create

public static Configuration create(Path path) throws IOException, ParseException

Читает конфигурацию из файла.

Параметры:

path — файл, содержащий конфигурацию, не null

Возвращает:

прочитанную конфигурацию Configuration, не null

Выбрасывает:

ParseException — если файл не удаётся разобрать

IOException — если файл не удаётся прочитать

См. также:

create

public static Configuration create(Reader reader) throws IOException, ParseException

Читает конфигурацию из символьного потока.

Параметры:: reader — Reader, предоставляющий содержимое конфигурации, не null
Возвращает:: конфигурацию, не null
Выбрасывает:: IOException — если при чтении содержимого из Reader произошла ошибка ввода-вывода; ParseException — если файл не удаётся разобрать

getConfiguration

public static Configuration getConfiguration(String name) throws IOException, ParseException

Возвращает предопределённую конфигурацию.

Список доступных имён конфигураций см. в разделе getConfigurations().

Параметры:: name — имя конфигурации (например, "default" или "profile")
Возвращает:: конфигурацию, не null
Выбрасывает:: IOException — если конфигурация с указанным именем не существует или при чтении файла конфигурации произошла ошибка ввода-вывода; ParseException — если файл конфигурации не удаётся разобрать

getConfigurations

public static List<Configuration> getConfigurations()

Возвращает неизменяемый список предопределённых конфигураций для этой виртуальной машины Java (JVM).

Возвращает:: список предопределённых конфигураций, не null

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/jdk.jfr/jdk/jfr/Configuration.html