1 /* 2 * Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package jdk.jfr.consumer; 27 28 import java.util.List; 29 30 import jdk.jfr.ValueDescriptor; 31 import jdk.jfr.internal.Type; 32 33 /** 34 * A recorded thread. 35 * 36 * @since 9 37 */ 38 public final class RecordedThread extends RecordedObject { 39 40 static ObjectFactory<RecordedThread> createFactory(Type type, TimeConverter timeConverter) { 41 return new ObjectFactory<RecordedThread>(type) { 42 @Override 43 RecordedThread createTyped(List<ValueDescriptor> desc, long id, Object[] object) { 44 return new RecordedThread(desc, id, object, timeConverter); 45 } 46 }; 47 } 48 49 private final long uniqueId; 50 51 private RecordedThread(List<ValueDescriptor> descriptors, long id, Object[] values, TimeConverter timeConverter) { 52 super(descriptors, values, timeConverter); 53 this.uniqueId = id; 54 } 55 56 /** 57 * Returns the thread name used by the operating system. 58 * 59 * @return the OS thread name, or {@code null} if not available 60 */ 61 public String getOSName() { 62 return getTyped("osName", String.class, null); 63 } 64 65 /** 66 * Returns the thread ID used by the operating system. 67 * 68 * @return The Java thread ID, or {@code -1} if not available 69 */ 70 public long getOSThreadId() { 71 Long l = getTyped("osThreadId", Long.class, -1L); 72 return l.longValue(); 73 } 74 75 /** 76 * Returns the Java thread group, if available. 77 * 78 * @return the thread group, or {@code null} if not available 79 */ 80 public RecordedThreadGroup getThreadGroup() { 81 return getTyped("group", RecordedThreadGroup.class, null); 82 } 83 84 /** 85 * Returns the Java thread name, or {@code null} if not available. 86 * <p> 87 * Returns {@code java.lang.Thread.getName()} if the thread has a Java 88 * representation. {@code null} otherwise. 89 * 90 * @return the Java thread name, or {@code null} if not available 91 */ 92 public String getJavaName() { 93 return getTyped("javaName", String.class, null); 94 } 95 96 /** 97 * Returns the Java thread ID, or {@code -1} if it's not a Java thread. 98 * 99 * @return the Java thread ID, or {@code -1} if it's not a Java thread 100 */ 101 public long getJavaThreadId() { 102 Long l = getTyped("javaThreadId", Long.class, -1L); 103 return l.longValue(); 104 } 105 106 /** 107 * Returns a unique ID for both native threads and Java threads that can't be 108 * reused within the lifespan of the JVM. 109 * 110 * See {@link #getJavaThreadId()} for the ID that is returned by 111 * {@code java.lang.Thread.getId()} 112 * 113 * @return a unique id for the thread 114 */ 115 public long getId() { 116 return uniqueId; 117 } 118 }