Класс 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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Показывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удалён в будущей версии. Механизм финализации устарел и может быть удалён в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения для этого `Object`.
`int`	`hashCode()`	Возвращает значение хеш-кода этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного времени.

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

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.