src/jdk.jfr/share/classes/jdk/jfr/consumer/RecordedEvent.java
changeset 50113 caf115bb98ad
child 52850 f527b24990d7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/jdk.jfr/share/classes/jdk/jfr/consumer/RecordedEvent.java	Tue May 15 20:24:34 2018 +0200
@@ -0,0 +1,123 @@
+/*
+ * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.jfr.consumer;
+
+import java.time.Duration;
+import java.time.Instant;
+import java.util.List;
+
+import jdk.jfr.EventType;
+import jdk.jfr.ValueDescriptor;
+import jdk.jfr.internal.EventInstrumentation;
+
+/**
+ * A recorded event.
+ *
+ * @since 9
+ */
+public final class RecordedEvent extends RecordedObject {
+    private final EventType eventType;
+    private final long startTime;
+    private final long endTime;
+
+    // package private
+    RecordedEvent(EventType type, List<ValueDescriptor> vds, Object[] values, long startTime, long endTime, TimeConverter timeConverter) {
+        super(vds, values, timeConverter);
+        this.eventType = type;
+        this.startTime = startTime;
+        this.endTime = endTime;
+    }
+
+    /**
+     * Returns the stack trace that was created when the event was committed, or
+     * {@code null} if the event lacks a stack trace.
+     *
+     * @return stack trace, or {@code null} if doesn't exist for the event
+     */
+    public RecordedStackTrace getStackTrace() {
+        return getTyped(EventInstrumentation.FIELD_STACK_TRACE, RecordedStackTrace.class, null);
+    }
+
+    /**
+     * Returns the thread from which the event was committed, or {@code null} if
+     * the thread was not recorded.
+     *
+     * @return thread, or {@code null} if doesn't exist for the event
+     */
+    public RecordedThread getThread() {
+        return getTyped(EventInstrumentation.FIELD_EVENT_THREAD, RecordedThread.class, null);
+    }
+
+    /**
+     * Returns the event type that describes the event.
+     *
+     * @return the event type, not {@code null}
+     */
+    public EventType getEventType() {
+        return eventType;
+    }
+
+    /**
+     * Returns the start time of the event.
+     * <p>
+     * If the event is an instant event, then the start time and end time are the same.
+     *
+     * @return the start time, not {@code null}
+     */
+    public Instant getStartTime() {
+        return Instant.ofEpochSecond(0, startTime);
+    }
+
+    /**
+     * Returns the end time of the event.
+     * <p>
+     * If the event is an instant event, then the start time and end time are the same.
+     *
+     * @return the end time, not {@code null}
+     */
+    public Instant getEndTime() {
+        return Instant.ofEpochSecond(0, endTime);
+    }
+
+    /**
+     * Returns the duration of the event, measured in nanoseconds.
+     *
+     * @return the duration in nanoseconds, not {@code null}
+     */
+    public Duration getDuration() {
+        return Duration.ofNanos(endTime - startTime);
+    }
+
+    /**
+     * Returns the list of descriptors that describes the fields of the event.
+     *
+     * @return descriptors, not {@code null}
+     */
+    @Override
+    public List<ValueDescriptor> getFields() {
+        return getEventType().getFields();
+    }
+}