Класс Thread

public static final int MIN_PRIORITY

См. также:

• Значения констант полей

public static final int NORM_PRIORITY

См. также:

• Значения констант полей

public static final int MAX_PRIORITY

См. также:

• Значения констант полей

public Thread()

См. также:

• Наследование при создании потоков

public Thread(Runnable task)

Thread.ofPlatform().unstarted(task); 

Параметры:

task — объект, метод run которого вызывается при запуске этого потока. Если null, метод run этого класса ничего не делает.

См. также:

• Наследование при создании потоков

public Thread(ThreadGroup group, Runnable task)

Thread.ofPlatform().group(group).unstarted(task); 

Параметры:

group — группа потоков. Если null, в качестве группы задается группа потоков текущего потока.

task — объект, метод run которого вызывается при запуске этого потока. Если null, вызывается метод run этого потока.

См. также:

• Наследование при создании потоков

public Thread(String name)

Параметры:

name — имя нового потока

См. также:

• Наследование при создании потоков

public Thread(ThreadGroup group, String name)

Параметры:

group — группа потоков. Если null, в качестве группы задается группа потоков текущего потока.

name — имя нового потока

См. также:

• Наследование при создании потоков

public Thread(Runnable task, String name)

Thread.ofPlatform().name(name).unstarted(task); 

Параметры:

task — объект, метод run которого вызывается при запуске этого потока. Если null, вызывается метод run этого потока.

name — имя нового потока

См. также:

• Наследование при создании потоков

public Thread(ThreadGroup group, Runnable task, String name)

Thread.ofPlatform().group(group).name(name).unstarted(task); 

Параметры:

group — группа потоков. Если null, в качестве группы задается группа потоков текущего потока.

task — объект, метод run которого вызывается при запуске этого потока. Если null, вызывается метод run этого потока.

name — имя нового потока

См. также:

• Наследование при создании потоков

public Thread(ThreadGroup group, Runnable task, String name, long stackSize)

Thread.ofPlatform().group(group).name(name).stackSize(stackSize).unstarted(task); 

Параметры:

group — группа потоков. Если null, в качестве группы задается группа потоков текущего потока.

task — объект, метод run которого вызывается при запуске этого потока. Если null, вызывается метод run этого потока.

name — имя нового потока

stackSize — желаемый размер стека нового потока или ноль, если этот параметр следует игнорировать.

С версии:

1.4

См. также:

• Наследование при создании потоков

public Thread(ThreadGroup group, Runnable task, String name, long stackSize, boolean inheritInheritableThreadLocals)

Thread.ofPlatform()
     .group(group)
     .name(name)
     .stackSize(stackSize)
     .inheritInheritableThreadLocals(inheritInheritableThreadLocals)
     .unstarted(task); 

Параметры:

group — группа потоков. Если null, в качестве группы задается группа потоков текущего потока.

task — объект, метод run которого вызывается при запуске этого потока. Если null, вызывается метод run этого потока.

name — имя нового потока

stackSize — желаемый размер стека нового потока или ноль, если этот параметр следует игнорировать

inheritInheritableThreadLocals — если true, наследовать начальные значения наследуемых локальных переменных потока от создающего потока; в противном случае начальные значения не наследуются

С версии:

9

См. также:

• Наследование при создании потоков

public static Thread currentThread()

Возвращает:

текущий поток

public static void yield()

public static void sleep(long millis) throws InterruptedException

Параметры:

millis — продолжительность приостановки в миллисекундах

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

IllegalArgumentException — если значение millis отрицательно

InterruptedException — если какой-либо поток прервал текущий поток. При выбрасывании этого исключения статус прерывания текущего потока сбрасывается.

public static void sleep(long millis, int nanos) throws InterruptedException

Параметры:

millis — продолжительность приостановки в миллисекундах

nanos — дополнительные наносекунды приостановки 0-999999

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

IllegalArgumentException — если значение millis отрицательно или значение nanos не входит в диапазон 0-999999

InterruptedException — если какой-либо поток прервал текущий поток. При выбрасывании этого исключения статус прерывания текущего потока сбрасывается.

public static void sleep(Duration duration) throws InterruptedException

Параметры:

duration — продолжительность приостановки

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

InterruptedException — если текущий поток прерван во время приостановки. При выбрасывании этого исключения статус прерывания текущего потока сбрасывается.

С версии:

19

public static void onSpinWait()

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

Например, рассмотрим метод класса, который выполняет цикл, пока не будет установлен флаг, изменяемый вне этого метода. Внутри цикла активного ожидания следует разместить вызов метода onSpinWait.

    class EventHandler {
        volatile boolean eventNotificationNotReceived;
        void waitForEventAndHandleIt() {
            while ( eventNotificationNotReceived ) {
                Thread.onSpinWait();
            }
            readAndProcessEvent();
        }

        void readAndProcessEvent() {
            // Read event from some source and process it
             . . .
        }
    }

Приведенный выше код останется корректным, даже если метод onSpinWait вообще не вызывать. Однако на некоторых архитектурах виртуальная машина Java может выдавать инструкции процессору, позволяющие эффективнее обрабатывать такие шаблоны кода.

С версии:

9

public static Thread.Builder.OfPlatform ofPlatform()

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

Ниже приведены примеры использования построителя:

  // Start a daemon thread to run a task
  Thread thread = Thread.ofPlatform().daemon().start(runnable);

  // Create an unstarted thread with name "duke", its start() method
  // must be invoked to schedule it to execute.
  Thread thread = Thread.ofPlatform().name("duke").unstarted(runnable);

  // A ThreadFactory that creates daemon threads named "worker-0", "worker-1", ...
  ThreadFactory factory = Thread.ofPlatform().daemon().name("worker-", 0).factory();

Возвращает:

Построитель для создания объектов Thread или ThreadFactory.

С версии:

21

public static Thread.Builder.OfVirtual ofVirtual()

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

Ниже приведены примеры использования построителя:

  // Start a virtual thread to run a task.
  Thread thread = Thread.ofVirtual().start(runnable);

  // A ThreadFactory that creates virtual threads
  ThreadFactory factory = Thread.ofVirtual().factory();

Возвращает:

Построитель для создания объектов Thread или ThreadFactory.

С версии:

21

protected Object clone() throws CloneNotSupportedException

Переопределяет:

clone в классе Object

Возвращает:

клон этого экземпляра.

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

CloneNotSupportedException — всегда

См. также:

• Cloneable

public static Thread startVirtualThread(Runnable task)

Thread.ofVirtual().start(task); 

Параметры:

task — объект, который будет выполнен потоком

Возвращает:

новый запущенный виртуальный поток

С версии:

21

См. также:

• Наследование при создании потоков

public final boolean isVirtual()

Возвращает:

true, если этот поток является виртуальным

С версии:

21

public void start()

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

IllegalThreadStateException — если поток уже был запущен

public void run()

Определено в:

run в интерфейсе Runnable

Требования к реализации:

Реализация по умолчанию выполняет задачу Runnable, с которой был создан объект Thread. Если поток создан без задачи, этот метод ничего не делает.

public void interrupt()

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

В эталонной реализации JDK прерывание неактивного потока все равно сохраняет факт получения запроса на прерывание; его можно проверить с помощью методов interrupted() и isInterrupted().

См. также:

• Прерывание потока
• isInterrupted()

public static boolean interrupted()

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

Этот метод редко требуется использовать напрямую. Он предназначен для случаев, когда обнаруживается прерывание потока и статус прерывания сбрасывается перед выбрасыванием исключения InterruptedException. Он также может быть полезен при реализации непрерываемого метода, использующего прерываемый метод, например LockSupport.park(). Метод interrupted() можно использовать для проверки наличия прерывания и сброса статуса прерывания, чтобы код мог повторить вызов прерываемого метода. Перед завершением непрерываемый метод должен восстановить статус прерывания.

Возвращает:

true, если текущий поток был прерван; в противном случае — false.

См. также:

• Прерывание потока
• isInterrupted()

public boolean isInterrupted()

Возвращает:

true, если этот поток был прерван; в противном случае — false.

См. также:

• Прерывание потока
• interrupt()

public final boolean isAlive()

Возвращает:

true, если этот поток активен; в противном случае — false.

public final void setPriority(int newPriority)

Параметры:

newPriority — новый приоритет потока

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

IllegalArgumentException — если приоритет не входит в диапазон от MIN_PRIORITY до MAX_PRIORITY.

См. также:

• setPriority(int)
• ThreadGroup.getMaxPriority()

public final int getPriority()

Возвращает:

приоритет этого потока.

См. также:

• setPriority(int)

public final void setName(String name)

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

В эталонной реализации JDK, если этот поток является текущим потоком и представляет собой платформенный поток, который не был присоединён к виртуальной машине с помощью функции Java Native Interface AttachCurrentThread, этот метод задаёт имя потока операционной системы. Это может быть полезно для отладки и устранения неполадок.

Параметры:

name — новое имя этого потока.

Внешние спецификации

• Спецификация Java Native Interface

См. также:

• getName()

public final String getName()

Возвращает:

имя этого потока.

См. также:

• setName(String)

public final ThreadGroup getThreadGroup()

Возвращает:

группу потоков этого потока или null

public static int activeCount()

Возвращает:

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

public static int enumerate(Thread[] tarray)

Параметры:

tarray — массив, в который следует поместить список потоков

Возвращает:

количество потоков, помещённых в массив

public final void join(long millis) throws InterruptedException

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

В этой реализации используется цикл вызовов this.wait с условием this.isAlive. При завершении потока вызывается метод this.notifyAll. Рекомендуется не использовать в приложениях wait, notify или notifyAll для экземпляров Thread.

Параметры:

millis — время ожидания в миллисекундах

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

IllegalArgumentException — если значение millis отрицательно

InterruptedException — если какой-либо поток прервал текущий поток. При выбрасывании этого исключения статус прерывания текущего потока сбрасывается.

public final void join(long millis, int nanos) throws InterruptedException

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

В этой реализации используется цикл вызовов this.wait с условием this.isAlive. При завершении потока вызывается метод this.notifyAll. Рекомендуется не использовать в приложениях wait, notify или notifyAll для экземпляров Thread.

Параметры:

millis — время ожидания в миллисекундах

nanos — 0-999999 дополнительные наносекунды ожидания

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

IllegalArgumentException — если значение millis отрицательно или значение nanos не входит в диапазон 0-999999

InterruptedException — если какой-либо поток прервал текущий поток. При выбрасывании этого исключения статус прерывания текущего потока сбрасывается.

public final void join() throws InterruptedException

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

InterruptedException — если какой-либо поток прервал текущий поток. При выбрасывании этого исключения статус прерывания текущего потока сбрасывается.

public final boolean join(Duration duration) throws InterruptedException

Параметры:

duration — максимальное время ожидания

Возвращает:

true, если поток завершил работу, false, если поток не завершил работу

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

InterruptedException — если текущий поток прерван во время ожидания. При выбрасывании этого исключения статус прерывания текущего потока сбрасывается.

IllegalThreadStateException — если этот поток не был запущен.

Начиная с:

19

public static void dumpStack()

public final void setDaemon(boolean on)

Параметры:

on — если true, помечает этот поток как поток-демон

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

IllegalArgumentException — если это виртуальный поток и on равно false

IllegalThreadStateException — если этот поток работает

public final boolean isDaemon()

Возвращает:

true, если этот поток является потоком-демоном; в противном случае — false.

См. также:

• setDaemon(boolean)

@Deprecated(since="17", forRemoval=true) public final void checkAccess()

public String toString()

Переопределяет:

toString в классе Object

Возвращает:

строковое представление этого потока.

public ClassLoader getContextClassLoader()

Возвращает:

контекстный ClassLoader этого потока или null, обозначающий системный загрузчик классов (или, если он недоступен, загрузчик классов начальной загрузки)

Начиная с:

1.2

public void setContextClassLoader(ClassLoader cl)

Параметры:

cl — контекстный загрузчик классов этого потока или null, обозначающий системный загрузчик классов (или, если он недоступен, загрузчик классов начальной загрузки)

Начиная с:

1.2

public static boolean holdsLock(Object obj)

    assert Thread.holdsLock(obj);

Параметры:

obj — объект, для которого проверяется владение блокировкой

Возвращает:

true, если текущий поток удерживает мониторную блокировку указанного объекта.

Начиная с:

1.4

public StackTraceElement[] getStackTrace()

Возвращает:

массив StackTraceElement, каждый элемент которого представляет один кадр стека.

Начиная с:

1.5

См. также:

• Throwable.getStackTrace()

public static Map<Thread, StackTraceElement[]> getAllStackTraces()

Возвращает:

Map, сопоставляющую Thread массив StackTraceElement, представляющий трассировку стека соответствующего потока.

Начиная с:

1.5

См. также:

• getStackTrace()
• Throwable.getStackTrace()

@Deprecated(since="19") public long getId()

Возвращает:

идентификатор этого потока

Начиная с:

1.5

public final long threadId()

Возвращает:

идентификатор этого потока

Начиная с:

19

public Thread.State getState()

Возвращает:

состояние этого потока.

Начиная с:

1.5

public static void setDefaultUncaughtExceptionHandler(Thread.UncaughtExceptionHandler ueh)

Параметры:

ueh — объект, используемый в качестве обработчика неперехваченных исключений по умолчанию. Если значение равно null, обработчик по умолчанию отсутствует.

Начиная с:

1.5

См. также:

• setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler)
• getUncaughtExceptionHandler()
• ThreadGroup.uncaughtException(Thread, Throwable)

public static Thread.UncaughtExceptionHandler getDefaultUncaughtExceptionHandler()

Возвращает:

обработчик неперехваченных исключений по умолчанию для всех потоков

Начиная с:

1.5

См. также:

• setDefaultUncaughtExceptionHandler(Thread.UncaughtExceptionHandler)

public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler()

Возвращает:

обработчик неперехваченных исключений этого потока

Начиная с:

1.5

public void setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler ueh)

Параметры:

ueh — объект, используемый в качестве обработчика неперехваченных исключений этого потока. Если значение равно null, у потока нет явного обработчика.

Начиная с:

1.5

См. также:

• setDefaultUncaughtExceptionHandler(Thread.UncaughtExceptionHandler)
• ThreadGroup.uncaughtException(Thread, Throwable)