Класс StackWalker

public static StackWalker getInstance()

Возвращает:

экземпляр StackWalker, настроенный на пропуск всех скрытых кадров; ссылка на класс не сохраняется (ссылка на класс).

public static StackWalker getInstance(StackWalker.Option option)

Параметры:

option - stack walking option

Возвращает:

экземпляр StackWalker, настроенный с указанным параметром

public static StackWalker getInstance(Set<StackWalker.Option> options)

Параметры:

options - stack walking options

Возвращает:

экземпляр StackWalker, настроенный с указанными параметрами

public static StackWalker getInstance(Set<StackWalker.Option> options, int estimateDepth)

Параметры:

options - stack walking options

estimateDepth - предполагаемое количество стековых кадров для обхода.

Возвращает:

экземпляр StackWalker, настроенный с указанными параметрами

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

IllegalArgumentException - если estimateDepth <= 0

public <T> T walk(Function<? super Stream<StackWalker.StackFrame>, ? extends T> function)

Примечание по API:

Например, чтобы найти первые 10 вызывающих кадров, пропустив сначала кадры, класс-объявитель которых находится в пакете com.foo:

List<StackFrame> frames = StackWalker.getInstance().walk(s ->
        s.dropWhile(f -> f.getClassName().startsWith("com.foo."))
         .limit(10)
         .toList());

Этот метод принимает Function, которому передается Stream<StackFrame>, вместо того чтобы возвращать Stream<StackFrame> и позволять вызывающему коду напрямую управлять потоком. Виртуальная машина Java может реорганизовать стек управления потока, например, посредством деоптимизации. Принимая параметр Function, этот метод обеспечивает доступ к стековым кадрам через стабильное представление стека управления потока.

Параллельное выполнение фактически отключено, и конвейер обработки потока выполняется только в текущем потоке.

Примечание по реализации:

Реализация стабилизирует стек, закрепляя кадр, относящийся к обходу стека, и гарантирует, что обход выполняется выше закрепленного кадра. При закрытии объекта потока или его повторном использовании будет выброшено исключение IllegalStateException.

Параметры типа:

T - тип результата применения функции к потоку стековых кадров.

Параметры:

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

Возвращает:

результат применения функции к потоку стековых кадров.

public void forEach(Consumer<? super StackWalker.StackFrame> action)

Параметры:

action - действие, выполняемое для каждого StackFrame стека текущего потока

public Class<?> getCallerClass()

Примечание по API:

Например, Util::getResourceBundle загружает пакет ресурсов от имени вызывающего класса. Он вызывает getCallerClass, чтобы определить класс, метод которого вызвал Util::getResourceBundle. Затем получает загрузчик классов этого класса и использует его для загрузки пакета ресурсов. В этом примере вызывающим классом является MyTool.

class Util {
    private final StackWalker walker =
        StackWalker.getInstance(Set.of(Option.DROP_METHOD_INFO, Option.RETAIN_CLASS_REFERENCE));
    public ResourceBundle getResourceBundle(String bundleName) {
        Class<?> caller = walker.getCallerClass();
        return ResourceBundle.getBundle(bundleName, Locale.getDefault(), caller.getClassLoader());
    }
}

class MyTool {
    private final Util util = new Util();
    private void init() {
        ResourceBundle rb = util.getResourceBundle("mybundle");
    }
}

Эквивалентный способ найти вызывающий класс с помощью метода walk выглядит следующим образом (кадры отражения, MethodHandle и скрытые кадры здесь не показаны):

    Optional<Class<?>> caller = walker.walk(s ->
        s.map(StackFrame::getDeclaringClass)
         .skip(2)
         .findFirst());

Если метод getCallerClass вызван из метода, являющегося самым нижним кадром стека, например метода static public void main, запущенного средством запуска java, или метода, вызванного из потока, подключенного через JNI, выбрасывается исключение IllegalCallerException.

Возвращает:

объект Class вызывающего класса, который вызвал этот метод.

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

UnsupportedOperationException - если этот StackWalker не настроен с параметром Option.RETAIN_CLASS_REFERENCE.

IllegalCallerException - если кадр вызывающего метода отсутствует, то есть когда этот метод getCallerClass вызван из метода, являющегося последним кадром стека.