FileDocCategorySizeDatePackage
ThreadInfo.javaAPI DocJava SE 5 API18585Fri Aug 26 14:57:06 BST 2005java.lang.management

ThreadInfo

public class ThreadInfo extends Object
Thread information. ThreadInfo contains the information about a thread including:

General thread information

  • Thread ID.
  • Name of the thread.

Execution information

  • Thread state.
  • The object upon which the thread is blocked waiting to enter a synchronization block or waiting to be notified in a {@link Object#wait Object.wait} call.
  • The ID of the thread that owns the object that the thread is blocked.
  • Stack trace of the thread.

Synchronization statistics

  • The number of times that the thread has blocked for synchronization or waited for notification.
  • The accumulated elapsed time that the thread has blocked for synchronization or waited for notification since thread contention monitoring was enabled. Some Java virtual machine implementation may not support this. The {@link ThreadMXBean#isThreadContentionMonitoringSupported()} method can be used to determine if a Java virtual machine supports this.

This thread information class is designed for use in monitoring of the system, not for synchronization control.

MXBean Mapping

ThreadInfo is mapped to a {@link CompositeData CompositeData} with attributes as specified in the {@link #from from} method.
see
ThreadMXBean#isThreadContentionMonitoringSupported
author
Mandy Chung
version
1.16, 04/18/04
since
1.5

Fields Summary
private final String
threadName
private final long
threadId
private final long
blockedTime
private final long
blockedCount
private final long
waitedTime
private final long
waitedCount
private final String
lockName
private final long
lockOwnerId
private final String
lockOwnerName
private final boolean
inNative
private final boolean
suspended
private final Thread$State
threadState
private final StackTraceElement[]
stackTrace
private static final StackTraceElement[]
NO_STACK_TRACE
Constructors Summary
private ThreadInfo(Thread t, int state, Object lockObj, Thread lockOwner, long blockedCount, long blockedTime, long waitedCount, long waitedTime, StackTraceElement[] stackTrace)
Constructor of ThreadInfo created by the JVM

param
t Thread
param
state Thread state
param
lockObj Object on which the thread is blocked to enter or waiting
param
lockOwner the thread holding the lock
param
blockedCount Number of times blocked to enter a lock
param
blockedTime Approx time blocked to enter a lock
param
waitedCount Number of times waited on a lock
param
waitedTime Approx time waited on a lock
param
stackTrace Thread stack trace

        this.threadId = t.getId();
        this.threadName = t.getName();
        this.threadState = 
            sun.management.ManagementFactory.toThreadState(state);
        this.suspended =
            sun.management.ManagementFactory.isThreadSuspended(state);
        this.inNative =
            sun.management.ManagementFactory.isThreadRunningNative(state);
        this.blockedCount = blockedCount;
        this.blockedTime = blockedTime;
        this.waitedCount = waitedCount;
        this.waitedTime = waitedTime;

        if (lockObj == null) {
            this.lockName = null;
        } else {
            this.lockName = 
                lockObj.getClass().getName() + '@" +
                    Integer.toHexString(System.identityHashCode(lockObj));
        }
        if (lockOwner == null) {
            this.lockOwnerId = -1; 
            this.lockOwnerName = null;
        } else {;
            this.lockOwnerId = lockOwner.getId();
            this.lockOwnerName = lockOwner.getName();
        }
        this.stackTrace = stackTrace;
    
private ThreadInfo(CompositeData cd)

        ThreadInfoCompositeData.validateCompositeData(cd);

        threadId = ThreadInfoCompositeData.getThreadId(cd); 
        threadName = ThreadInfoCompositeData.getThreadName(cd); 
        blockedTime = ThreadInfoCompositeData.getBlockedTime(cd);
        blockedCount = ThreadInfoCompositeData.getBlockedCount(cd);
        waitedTime = ThreadInfoCompositeData.getWaitedTime(cd);
        waitedCount = ThreadInfoCompositeData.getWaitedCount(cd);
        lockName = ThreadInfoCompositeData.getLockName(cd);
        lockOwnerId = ThreadInfoCompositeData.getLockOwnerId(cd);
        lockOwnerName = ThreadInfoCompositeData.getLockOwnerName(cd);
        threadState = ThreadInfoCompositeData.getThreadState(cd);
        suspended = ThreadInfoCompositeData.isSuspended(cd);
        inNative = ThreadInfoCompositeData.isInNative(cd);
        stackTrace = ThreadInfoCompositeData.getStackTrace(cd);
    
Methods Summary
public static java.lang.management.ThreadInfofrom(javax.management.openmbean.CompositeData cd)
Returns a ThreadInfo object represented by the given CompositeData. The given CompositeData must contain the following attributes:
Attribute Name Type
threadId java.lang.Long
threadName java.lang.String
threadState java.lang.String
suspended java.lang.Boolean
inNative java.lang.Boolean
blockedCount java.lang.Long
blockedTime java.lang.Long
waitedCount java.lang.Long
waitedTime java.lang.Long
lockName java.lang.String
lockOwnerId java.lang.Long
lockOwnerName java.lang.String
stackTrace javax.management.openmbean.CompositeData[]

Each element is a CompositeData representing StackTraceElement containing the following attributes:

Attribute Name Type
className java.lang.String
methodName java.lang.String
fileName java.lang.String
lineNumber java.lang.Integer
nativeMethod java.lang.Boolean

param
cd CompositeData representing a ThreadInfo
throws
IllegalArgumentException if cd does not represent a ThreadInfo with the attributes described above.
return
a ThreadInfo object represented by cd if cd is not null; null otherwise.

        if (cd == null) {
            return null;
        }

        if (cd instanceof ThreadInfoCompositeData) {
            return ((ThreadInfoCompositeData) cd).getThreadInfo();
        } else {
            return new ThreadInfo(cd);
        }
    
public longgetBlockedCount()
Returns the total number of times that the thread associated with this ThreadInfo blocked to enter or reenter a monitor. I.e. the number of times a thread has been in the {@link java.lang.Thread.State#BLOCKED BLOCKED} state.

return
the total number of times that the thread entered the BLOCKED state.

        return blockedCount;
    
public longgetBlockedTime()
Returns the approximate accumulated elapsed time (in milliseconds) that the thread associated with this ThreadInfo has blocked to enter or reenter a monitor since thread contention monitoring is enabled. I.e. the total accumulated time the thread has been in the {@link java.lang.Thread.State#BLOCKED BLOCKED} state since thread contention monitoring was last enabled. This method returns -1 if thread contention monitoring is disabled.

The Java virtual machine may measure the time with a high resolution timer. This statistic is reset when the thread contention monitoring is reenabled.

return
the approximate accumulated elapsed time in milliseconds that a thread entered the BLOCKED state; -1 if thread contention monitoring is disabled.
throws
java.lang.UnsupportedOperationException if the Java virtual machine does not support this operation.
see
ThreadMXBean#isThreadContentionMonitoringSupported
see
ThreadMXBean#setThreadContentionMonitoringEnabled

        return blockedTime;
    
public java.lang.StringgetLockName()
Returns the string representation of the monitor lock that the thread associated with this ThreadInfo is blocked to enter or waiting to be notified through the {@link Object#wait Object.wait} method. The returned string representation of a monitor lock consists of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the identity hash code of the object. The returned string may not be unique depending on the implementation of the {@link System#identityHashCode} method. This method returns a string equals to the value of:
lock.getClass().getName() + '@' + Integer.toHexString(System.identityHashCode(lock))
where lock is the monitor lock object.

If the thread is not blocking to enter on any monitor object, or is not waiting on a monitor object for notification in a Object.wait call, this method returns null.

return
the string representation of the monitor lock that the thread is blocking to enter or waiting to be notified through the Object.wait method if any; null otherwise.

        return lockName;
    
public longgetLockOwnerId()
Returns the ID of the thread which holds the monitor lock of an object on which the thread associated with this ThreadInfo is blocking. This method will return -1 if this thread is not blocked or waiting on any monitor, or if the monitor lock is not held by any thread.

return
the thread ID of the owner thread of the monitor lock of the object this thread is blocking on; -1 if this thread is not blocked or waiting on any monitor, or if the monitor lock is not held by any thread.
see
#getLockName

        return lockOwnerId;
    
public java.lang.StringgetLockOwnerName()
Returns the name of the thread which holds the monitor lock of an object on which the thread associated with this ThreadInfo is blocking. This method will return null if this thread is not blocked or waiting on any monitor, or if the monitor lock is not held by any thread.

return
the name of the thread that holds the monitor lock of the object this thread is blocking on; null if this thread is not blocked or waiting on any monitor, or if the monitor lock is not held by any thread.
see
#getLockName

        return lockOwnerName;
    
public java.lang.StackTraceElement[]getStackTrace()
Returns the stack trace of the thread associated with this ThreadInfo. If no stack trace was requested for this thread info, this method will return a zero-length array. If the returned array is of non-zero length then the first element of the array represents the top of the stack, which is the most recent method invocation in the sequence. The last element of the array represents the bottom of the stack, which is the least recent method invocation in the sequence.

Some Java virtual machines may, under some circumstances, omit one or more stack frames from the stack trace. In the extreme case, a virtual machine that has no stack trace information concerning the thread associated with this ThreadInfo is permitted to return a zero-length array from this method.

return
an array of StackTraceElement objects of the thread.

        if (stackTrace == null) {
            return NO_STACK_TRACE;
        } else {
            return stackTrace;
        }
    
public longgetThreadId()
Returns the ID of the thread associated with this ThreadInfo.

return
the ID of the associated thread.

        return threadId;
    
public java.lang.StringgetThreadName()
Returns the name of the thread associated with this ThreadInfo.

return
the name of the associated thread.

        return threadName;
    
public java.lang.Thread$StategetThreadState()
Returns the state of the thread associated with this ThreadInfo.

return
Thread.State of the associated thread.

         return threadState;
    
public longgetWaitedCount()
Returns the total number of times that the thread associated with this ThreadInfo waited for notification. I.e. the number of times that a thread has been in the {@link java.lang.Thread.State#WAITING WAITING} or {@link java.lang.Thread.State#TIMED_WAITING TIMED_WAITING} state.

return
the total number of times that the thread was in the WAITING or TIMED_WAITING state.

        return waitedCount;
    
public longgetWaitedTime()
Returns the approximate accumulated elapsed time (in milliseconds) that the thread associated with this ThreadInfo has waited for notification since thread contention monitoring is enabled. I.e. the total accumulated time the thread has been in the {@link java.lang.Thread.State#WAITING WAITING} or {@link java.lang.Thread.State#TIMED_WAITING TIMED_WAITING} state since thread contention monitoring is enabled. This method returns -1 if thread contention monitoring is disabled.

The Java virtual machine may measure the time with a high resolution timer. This statistic is reset when the thread contention monitoring is reenabled.

return
the approximate accumulated elapsed time in milliseconds that a thread has been in the WAITING or TIMED_WAITING state; -1 if thread contention monitoring is disabled.
throws
java.lang.UnsupportedOperationException if the Java virtual machine does not support this operation.
see
ThreadMXBean#isThreadContentionMonitoringSupported
see
ThreadMXBean#setThreadContentionMonitoringEnabled

        return waitedTime;
    
public booleanisInNative()
Tests if the thread associated with this ThreadInfo is executing native code via the Java Native Interface (JNI). The JNI native code does not include the virtual machine support code or the compiled native code generated by the virtual machine.

return
true if the thread is executing native code; false otherwise.

         return inNative;
    
public booleanisSuspended()
Tests if the thread associated with this ThreadInfo is suspended. This method returns true if {@link Thread#suspend} has been called.

return
true if the thread is suspended; false otherwise.

         return suspended;
    
public java.lang.StringtoString()
Returns a string representation of this thread info.

return
a string representation of this thread info.

        return "Thread " + getThreadName() + " (Id = " + getThreadId() + ") " + 
               getThreadState() + " " + getLockName();