Класс Configuration

java.lang.Object
- jdk.jfr.Configuration

public final class Configuration
extends Object

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

Since:: 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()`	Возвращает настройки, определяющие, как настроено запись.

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

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

Методы

getSettings

public Map<String,String> getSettings()

Возвращает настройки, определяющие, как настроено запись.

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

Returns:: настройки, а не null

getName

public String getName()

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

Returns:: имя или null, если его нет

getLabel

public String getLabel()

Возвращает удобочитаемое имя (например, "Continuous" or "Profiling").

Returns:: метку или null, если её нет

getDescription

public String getDescription()

Возвращает краткое предложение, описывающее конфигурацию (например, "Low overhead configuration safe for continuous use in production environments").

Returns:: описание или null, если его нет

getProvider

public String getProvider()

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

Returns:: поставщик или null, если его нет

getContents

public String getContents()

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

Returns:: содержимое или null, если его нет
См. также:: getContents()

create

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

Считывает конфигурацию из файла.

Parameters:: path - файл, содержащий конфигурацию, а не null
Returns:: прочитанная Configuration, а не null
Throws:: ParseException - если файл невозможно разобрать; IOException - если файл невозможно прочитать; SecurityException - если менеджер безопасности существует и его метод checkRead запрещает чтение файла.
См. также:: File.getPath(), SecurityManager.checkRead(java.lang.String)

create

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

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

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

getConfiguration

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

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

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

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

getConfigurations

public static List<Configuration> getConfigurations()

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

Returns:: список предопределённых конфигураций, а не null