Spec-Zone.ru › OpenJDK 17

Класс SettingControl

java.lang.Object
jdk.jfr.SettingControl
public abstract class SettingControl extends Object
Базовый класс для расширения при создании элементов управления настройками.

Следующий пример демонстрирует простое реализацию элемента управления настройками для регулярных выражений:

 final class RegExpControl extends SettingControl {
   private Pattern pattern = Pattern.compile(".*");

   @Override
   public void setValue(String value) {
     this.pattern = Pattern.compile(value);
   }

   @Override
   public String combine(Set<String> values) {
     return String.join("|", values);
   }

   @Override
   public String getValue() {
     return pattern.toString();
   }

   public boolean matches(String s) {
     return pattern.matcher(s).find();
   }
 }
 
Методы setValue(String), getValue() и combine(Set<String>) вызываются при изменении значения настройки, что обычно происходит при запуске или остановке записи. Метод combine(Set<String>) вызывается для определения значения, используемого при одновременном выполнении нескольких записей.

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

Чтобы использовать элемент управления настройками с событием, добавьте метод, возвращающий значение boolean и принимающий элемент управления настройками в качестве параметра. Отметьте метод аннотацией @SettingDefinition. По умолчанию имя метода используется в качестве имени настройки, но имя можно явно задать с помощью аннотации @Name. Если метод возвращает true, событие будет подтверждено.

Рекомендуется, чтобы метод setValue(String) обновлял эффективную структуру данных, которую можно быстро проверить при подтверждении события.

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

 abstract class HTTPRequest extends Event {
   @Label("Request URI")
   protected String uri;

   @Label("Servlet URI Filter")
   @SettingDefinition
   protected boolean uriFilter(RegExpControl regExp) {
     return regExp.matches(uri);
   }
 }

 @Label("HTTP Get Request")
 class HTTPGetRequest extends HTTPRequest {
 }

 @Label("HTTP Post Request")
 class HTTPPostRequest extends HTTPRequest {
 }

 class ExampleServlet extends HttpServlet {
   protected void doGet(HttpServletRequest req, HttpServletResponse resp) {
     HTTPGetRequest request = new HTTPGetRequest();
     request.begin();
     request.uri = req.getRequestURI();
     ...
     request.commit();
   }

   protected void doPost(HttpServletRequest req, HttpServletResponse resp) {
     HTTPPostRequest request = new HTTPPostRequest();
     request.begin();
     request.uri = req.getRequestURI();
     ...
     request.commit();
   }
 }
 

Следующий пример показывает, как событие можно отфильтровать, присвоив настройке "uriFilter" заданные регулярные выражения.

 Recording r = new Recording();
 r.enable("HTTPGetRequest").with("uriFilter", "https://www.example.com/list/.*");
 r.enable("HTTPPostRequest").with("uriFilter", "https://www.example.com/login/.*");
 r.start();
 
Since:
9
See Also:
  • SettingDefinition

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

SettingControl()
Модификатор Конструктор Описание
protected
Конструктор для вызова подклассами.

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

Модификатор и тип Метод Описание
abstract String combine(Set<String> settingValues)
Объединяет значения настроек для всех активных записей в одно значение при одновременном выполнении нескольких записей.
abstract String getValue()
Возвращает текущее используемое значение для этой настройки, а не null.
abstract void setValue(String settingValue)
Устанавливает значение для этой настройки.

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

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

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

SettingControl

protected SettingControl()
Конструктор для вызова подклассами.

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

combine

public abstract String combine(Set<String> settingValues)
Объединяет значения настроек для всех активных записей в одно значение при одновременном выполнении нескольких записей,

Семантика объединения значений настроек зависит от реализованного элемента управления настройками, но все записи должны получить, по крайней мере, все запрошенные события.

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

Примеры:

если элемент управления настройками представляет собой порог, а три записи выполняются одновременно со значениями настроек "10 ms", "8 s" и "1 ms", этот метод возвращает "1 ms", так как это означает, что все записи получают по крайней мере все запрошенные данные.

Если элемент управления настройками представляет собой набор имен, а две записи выполняются одновременно со значениями настроек "Smith, Jones" и "Jones, Williams", возвращаемое значение равно "Smith, Jones, Williams", поскольку все имена будут приняты.

Если элемент управления настройками представляет собой булево условие, а четыре записи выполняются одновременно со значениями "true", "false", "false" и "incorrect", этот метод возвращает "true", так как все записи получают, по крайней мере, все запрошенные данные.

Parameters:
settingValues - набор значений, а не null
Returns:
используемое значение, а не null

setValue

public abstract void setValue(String settingValue)
Устанавливает значение для этой настройки.

Если значение настройки недействительно для этого элемента управления настройками, этот метод не генерирует исключение. Вместо этого значение игнорируется.

Parameters:
settingValue - строковое значение, а не null

getValue

public abstract String getValue()
Возвращает текущее используемое значение для этой настройки, а не null.

Возвращаемое значение этого метода является допустимым аргументом для метода setValue(String) и метода combine(Set).

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

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

© 1993, 2021, 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/17/docs/api/jdk.jfr/jdk/jfr/SettingControl.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API