--- /dev/null 2017-11-09 09:38:01.297999907 +0100 +++ new/src/jdk.jfr/share/classes/jdk/jfr/consumer/RecordedObject.java 2018-04-09 15:49:03.491546297 +0200 @@ -0,0 +1,883 @@ +/* + * 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.io.IOException; +import java.io.PrintWriter; +import java.io.StringWriter; +import java.time.Duration; +import java.time.Instant; +import java.util.List; +import java.util.Objects; + +import jdk.jfr.Timespan; +import jdk.jfr.Timestamp; +import jdk.jfr.ValueDescriptor; +import jdk.jfr.internal.PrivateAccess; +import jdk.jfr.internal.Type; +import jdk.jfr.internal.cmd.PrettyWriter; + +/** + * A complex data type that consists of one or more fields. + *
+ * This class provides methods to select and query nested objects by passing a
+ * dot {@code "."} delimited {@code String} object (for instance,
+ * {@code "aaa.bbb"}). A method evaluates a nested object from left to right,
+ * and if a part is {@code null}, it throws {@code NullPointerException}.
+ *
+ * @since 9
+ */
+public class RecordedObject {
+
+ private final static class UnsignedValue {
+ private final Object o;
+
+ UnsignedValue(Object o) {
+ this.o = o;
+ }
+
+ Object value() {
+ return o;
+ }
+ }
+
+ private final Object[] objects;
+ private final List
+ * The return type may be a primitive type or a subclass of
+ * {@link RecordedObject}.
+ *
+ * It's possible to index into a nested object by using {@code "."} (for
+ * instance {@code "thread.group.parent.name}").
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * Example
+ *
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "aaa.bbb"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name name of the field to get, not {@code null}
+ *
+ * @return the value of the field, {@code true} or {@code false}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field is
+ * not of type {@code boolean}
+ *
+ * @see #hasField(String)
+ * @see #getValue(String)
+ */
+ public final boolean getBoolean(String name) {
+ Object o = getValue(name);
+ if (o instanceof Boolean) {
+ return ((Boolean) o).booleanValue();
+ }
+ throw newIllegalArgumentException(name, "boolean");
+ }
+
+ /**
+ * Returns the value of a field of type {@code byte}.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "foo.bar"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return the value of the field
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field is
+ * not of type {@code byte}
+ *
+ * @see #hasField(String)
+ * @see #getValue(String)
+ */
+ public final byte getByte(String name) {
+ Object o = getValue(name);
+ if (o instanceof Byte) {
+ return ((Byte) o).byteValue();
+ }
+ throw newIllegalArgumentException(name, "byte");
+ }
+
+ /**
+ * Returns the value of a field of type {@code char}.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "aaa.bbb"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return the value of the field as a {@code char}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field is
+ * not of type {@code char}
+ *
+ * @see #hasField(String)
+ * @see #getValue(String)
+ */
+ public final char getChar(String name) {
+ Object o = getValue(name);
+ if (o instanceof Character) {
+ return ((Character) o).charValue();
+ }
+
+ throw newIllegalArgumentException(name, "char");
+ }
+
+ /**
+ * Returns the value of a field of type {@code short} or of another primitive
+ * type convertible to type {@code short} by a widening conversion.
+ *
+ * This method can be used on the following types: {@code short} and {@code byte}.
+ *
+ * If the field has the {@code @Unsigned} annotation and is of a narrower type
+ * than {@code short}, then the value is returned as an unsigned.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "aaa.bbb"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return the value of the field converted to type {@code short}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field
+ * value can't be converted to the type {@code short} by a widening
+ * conversion
+ *
+ * @see #hasField(String)
+ * @set #getValue(String)
+ */
+ public final short getShort(String name) {
+ Object o = getValue(name, true);
+ if (o instanceof Short) {
+ return ((Short) o).shortValue();
+ }
+ if (o instanceof Byte) {
+ return ((Byte) o).byteValue();
+ }
+ if (o instanceof UnsignedValue) {
+ Object u = ((UnsignedValue) o).value();
+ if (u instanceof Short) {
+ return ((Short) u).shortValue();
+ }
+ if (u instanceof Byte) {
+ return (short) Byte.toUnsignedInt(((Byte) u));
+ }
+ }
+ throw newIllegalArgumentException(name, "short");
+ }
+
+ /**
+ * Returns the value of a field of type {@code int} or of another primitive type
+ * that is convertible to type {@code int} by a widening conversion.
+ *
+ * This method can be used on fields of the following types: {@code int},
+ * {@code short}, {@code char}, and {@code byte}.
+ *
+ * If the field has the {@code @Unsigned} annotation and is of a narrower type
+ * than {@code int}, then the value will be returned as an unsigned.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "aaa.bbb"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return the value of the field converted to type {@code int}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field
+ * value can't be converted to the type {@code int} by a widening
+ * conversion
+ *
+ * @see #hasField(String)
+ * @set #getValue(String)
+ */
+ public final int getInt(String name) {
+ Object o = getValue(name, true);
+ if (o instanceof Integer) {
+ return ((Integer) o).intValue();
+ }
+ if (o instanceof Short) {
+ return ((Short) o).intValue();
+ }
+ if (o instanceof Character) {
+ return ((Character) o).charValue();
+ }
+ if (o instanceof Byte) {
+ return ((Byte) o).intValue();
+ }
+ if (o instanceof UnsignedValue) {
+ Object u = ((UnsignedValue) o).value();
+ if (u instanceof Integer) {
+ return ((Integer) u).intValue();
+ }
+ if (u instanceof Short) {
+ return Short.toUnsignedInt(((Short) u));
+ }
+ if (u instanceof Byte) {
+ return Byte.toUnsignedInt(((Byte) u));
+ }
+ }
+ throw newIllegalArgumentException(name, "int");
+ }
+
+ /**
+ * Returns the value of a field of type {@code float} or of another primitive
+ * type convertible to type {@code float} bby a widening conversion.
+ *
+ * This method can be used on fields of the following types: {@code float},
+ * {@code long}, {@code int}, {@code short}, {@code char}, and {@code byte}.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "aaa.bbb"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return the value of the field converted to type {@code float}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field
+ * value can't be converted to the type {@code float} by a widening
+ * conversion
+ *
+ * @see #hasField(String)
+ * @set #getValue(String)
+ */
+ public final float getFloat(String name) {
+ Object o = getValue(name);
+ if (o instanceof Float) {
+ return ((Float) o).floatValue();
+ }
+ if (o instanceof Long) {
+ return ((Long) o).floatValue();
+ }
+ if (o instanceof Integer) {
+ return ((Integer) o).floatValue();
+ }
+ if (o instanceof Short) {
+ return ((Short) o).floatValue();
+ }
+ if (o instanceof Byte) {
+ return ((Byte) o).byteValue();
+ }
+ if (o instanceof Character) {
+ return ((Character) o).charValue();
+ }
+ throw newIllegalArgumentException(name, "float");
+ }
+
+ /**
+ * Returns the value of a field of type {@code long} or of another primitive
+ * type that is convertible to type {@code long} by a widening conversion.
+ *
+ * This method can be used on fields of the following types: {@code long},
+ * {@code int}, {@code short}, {@code char}, and {@code byte}.
+ *
+ * If the field has the {@code @Unsigned} annotation and is of a narrower type
+ * than {@code long}, then the value will be returned as an unsigned.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "aaa.bbb"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return the value of the field converted to type {@code long}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field
+ * value can't be converted to the type {@code long} via a widening
+ * conversion
+ *
+ * @see #hasField(String)
+ * @set #getValue(String)
+ */
+ public final long getLong(String name) {
+ Object o = getValue(name, true);
+ if (o instanceof Long) {
+ return ((Long) o).longValue();
+ }
+ if (o instanceof Integer) {
+ return ((Integer) o).longValue();
+ }
+ if (o instanceof Short) {
+ return ((Short) o).longValue();
+ }
+ if (o instanceof Character) {
+ return ((Character) o).charValue();
+ }
+ if (o instanceof Byte) {
+ return ((Byte) o).longValue();
+ }
+ if (o instanceof UnsignedValue) {
+ Object u = ((UnsignedValue) o).value();
+ if (u instanceof Integer) {
+ return Integer.toUnsignedLong(((Integer) u));
+ }
+ if (u instanceof Short) {
+ return Short.toUnsignedLong(((Short) u));
+ }
+ if (u instanceof Byte) {
+ return Byte.toUnsignedLong(((Byte) u));
+ }
+ }
+ throw newIllegalArgumentException(name, "long");
+ }
+
+ /**
+ * Returns the value of a field of type {@code double} or of another primitive
+ * type that is convertible to type {@code double} by a widening conversion.
+ *
+ * This method can be used on fields of the following types: {@code double}, {@code float},
+ * {@code long}, {@code int}, {@code short}, {@code char}, and {@code byte}.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "aaa.bbb"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return the value of the field converted to type {@code double}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field
+ * value can't be converted to the type {@code double} by a widening
+ * conversion
+ *
+ * @see #hasField(String)
+ * @set #getValue(String)
+ */
+ public final double getDouble(String name) {
+ Object o = getValue(name);
+ if (o instanceof Double) {
+ return ((Double) o).doubleValue();
+ }
+ if (o instanceof Float) {
+ return ((Float) o).doubleValue();
+ }
+ if (o instanceof Long) {
+ return ((Long) o).doubleValue();
+ }
+ if (o instanceof Integer) {
+ return ((Integer) o).doubleValue();
+ }
+ if (o instanceof Short) {
+ return ((Short) o).doubleValue();
+ }
+ if (o instanceof Byte) {
+ return ((Byte) o).byteValue();
+ }
+ if (o instanceof Character) {
+ return ((Character) o).charValue();
+ }
+ throw newIllegalArgumentException(name, "double");
+ }
+
+ /**
+ * Returns the value of a field of type {@code String}.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "foo.bar"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return the value of the field as a {@code String}, can be {@code null}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field
+ * isn't of type {@code String}
+ *
+ * @see #hasField(String)
+ * @set #getValue(String)
+ */
+ public final String getString(String name) {
+ return getTypedValue(name, "java.lang.String");
+ }
+
+ /**
+ * Returns the value of a timespan field.
+ *
+ * This method can be used on fields annotated with {@code @Timespan}, and of
+ * the following types: {@code long}, {@code int}, {@code short}, {@code char},
+ * and {@code byte}.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "aaa.bbb"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return a time span represented as a {@code Duration}, not {@code null}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field
+ * value can't be converted to a {@code Duration} object
+ *
+ * @see #hasField(String)
+ * @set #getValue(String)
+ */
+ public final Duration getDuration(String name) {
+ Object o = getValue(name);
+ if (o instanceof Long) {
+ return getDuration(((Long) o).longValue(), name);
+ }
+ if (o instanceof Integer) {
+ return getDuration(((Integer) o).longValue(), name);
+ }
+ if (o instanceof Short) {
+ return getDuration(((Short) o).longValue(), name);
+ }
+ if (o instanceof Character) {
+ return getDuration(((Character) o).charValue(), name);
+ }
+ if (o instanceof Byte) {
+ return getDuration(((Byte) o).longValue(), name);
+ }
+ if (o instanceof UnsignedValue) {
+ Object u = ((UnsignedValue) o).value();
+ if (u instanceof Integer) {
+ return getDuration(Integer.toUnsignedLong((Integer) u), name);
+ }
+ if (u instanceof Short) {
+ return getDuration(Short.toUnsignedLong((Short) u), name);
+ }
+ if (u instanceof Byte) {
+ return getDuration(Short.toUnsignedLong((Byte) u), name);
+ }
+ }
+ throw newIllegalArgumentException(name, "java,time.Duration");
+ }
+
+ private Duration getDuration(long timespan, String name) throws InternalError {
+ ValueDescriptor v = getValueDescriptor(descriptors, name, null);
+ Timespan ts = v.getAnnotation(Timespan.class);
+ if (ts != null) {
+ switch (ts.value()) {
+ case Timespan.MICROSECONDS:
+ return Duration.ofNanos(1000 * timespan);
+ case Timespan.SECONDS:
+ return Duration.ofSeconds(timespan);
+ case Timespan.MILLISECONDS:
+ return Duration.ofMillis(timespan);
+ case Timespan.NANOSECONDS:
+ return Duration.ofNanos(timespan);
+ case Timespan.TICKS:
+ return Duration.ofNanos(timeConverter.convertTimespan(timespan));
+ }
+ throw new IllegalArgumentException("Attempt to get " + v.getTypeName() + " field \"" + name + "\" with illegal timespan unit " + ts.value());
+ }
+ throw new IllegalArgumentException("Attempt to get " + v.getTypeName() + " field \"" + name + "\" with missing @Timespan");
+ }
+
+ /**
+ * Returns the value of a timestamp field.
+ *
+ * This method can be used on fields annotated with {@code @Timestamp}, and of
+ * the following types: {@code long}, {@code int}, {@code short}, {@code char}
+ * and {@code byte}.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "aaa.bbb"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return a timstamp represented as an {@code Instant}, not {@code null}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field
+ * value can't be converted to an {@code Instant} object
+ *
+ * @see #hasField(String)
+ * @set #getValue(String)
+ */
+ public final Instant getInstant(String name) {
+ Object o = getValue(name, true);
+ if (o instanceof Long) {
+ return getInstant(((Long) o).longValue(), name);
+ }
+ if (o instanceof Integer) {
+ return getInstant(((Integer) o).longValue(), name);
+ }
+ if (o instanceof Short) {
+ return getInstant(((Short) o).longValue(), name);
+ }
+ if (o instanceof Character) {
+ return getInstant(((Character) o).charValue(), name);
+ }
+ if (o instanceof Byte) {
+ return getInstant(((Byte) o).longValue(), name);
+ }
+ if (o instanceof UnsignedValue) {
+ Object u = ((UnsignedValue) o).value();
+ if (u instanceof Integer) {
+ return getInstant(Integer.toUnsignedLong((Integer) u), name);
+ }
+ if (u instanceof Short) {
+ return getInstant(Short.toUnsignedLong((Short) u), name);
+ }
+ if (u instanceof Byte) {
+ return getInstant(Short.toUnsignedLong((Byte) u), name);
+ }
+ }
+ throw newIllegalArgumentException(name, "java,time.Instant");
+ }
+
+ private Instant getInstant(long timestamp, String name) {
+ ValueDescriptor v = getValueDescriptor(descriptors, name, null);
+ Timestamp ts = v.getAnnotation(Timestamp.class);
+ if (ts != null) {
+ switch (ts.value()) {
+ case Timestamp.MILLISECONDS_SINCE_EPOCH:
+ return Instant.ofEpochMilli(timestamp);
+ case Timestamp.TICKS:
+ return Instant.ofEpochSecond(0, timeConverter.convertTimestamp(timestamp));
+ }
+ throw new IllegalArgumentException("Attempt to get " + v.getTypeName() + " field \"" + name + "\" with illegal timestamp unit " + ts.value());
+ }
+ throw new IllegalArgumentException("Attempt to get " + v.getTypeName() + " field \"" + name + "\" with missing @Timestamp");
+ }
+
+ /**
+ * Returns the value of a field of type {@code Class}.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "aaa.bbb"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return the value of the field as a {@code RecordedClass}, can be
+ * {@code null}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field
+ * isn't of type {@code Class}
+ *
+ * @see #hasField(String)
+ * @set #getValue(String)
+ */
+ public final RecordedClass getClass(String name) {
+ return getTypedValue(name, "java.lang.Class");
+ }
+
+ /**
+ * Returns the value of a field of type {@code Thread}.
+ *
+ * It's possible to index into a nested object using {@code "."} (for example,
+ * {@code "foo.bar"}).
+ *
+ * A field might change or be removed in a future JDK release. A best practice
+ * for callers of this method is to validate the field before attempting access.
+ *
+ * @param name of the field to get, not {@code null}
+ *
+ * @return the value of the field as a {@code RecordedThread} object, can be
+ * {@code null}
+ *
+ * @throws IllegalArgumentException if the field doesn't exist, or the field
+ * isn't of type {@code Thread}
+ *
+ * @see #hasField(String)
+ * @set #getValue(String)
+ */
+ public final RecordedThread getThread(String name) {
+ return getTypedValue(name, "java.lang.Thread");
+ }
+
+ /**
+ * Returns a textual representation of this object.
+ *
+ * @return textual description of this object
+ */
+ @Override
+ final public String toString() {
+ StringWriter s = new StringWriter();
+ PrettyWriter p = new PrettyWriter(new PrintWriter(s));
+ try {
+ if (this instanceof RecordedEvent) {
+ p.print((RecordedEvent) this);
+ } else {
+ p.print(this, "");
+ }
+
+ } catch (IOException e) {
+ // Ignore, should not happen with StringWriter
+ }
+ p.flush();
+ return s.toString();
+ }
+
+ private static IllegalArgumentException newIllegalArgumentException(String name, String typeName) {
+ return new IllegalArgumentException("Attempt to get field \"" + name + "\" with illegal data type conversion " + typeName);
+ }
+}
+ *
+ *
+ * @param
+ * if (event.hasField("intValue")) {
+ * int intValue = event.getValue("intValue");
+ * System.out.println("Int value: " + intValue);
+ * }
+ *
+ * if (event.hasField("objectClass")) {
+ * RecordedClass clazz = event.getValue("objectClass");
+ * System.out.println("Class name: " + clazz.getName());
+ * }
+ *
+ * if (event.hasField("sampledThread")) {
+ * RecordedThread sampledThread = event.getValue("sampledThread");
+ * System.out.println("Sampled thread: " + sampledThread.getName());
+ * }
+ *
+ *