src/jdk.jfr/share/classes/jdk/jfr/internal/consumer/Parser.java
author mgronlun
Wed, 30 Oct 2019 19:43:52 +0100
changeset 58863 c16ac7a2eba4
parent 50113 src/jdk.jfr/share/classes/jdk/jfr/consumer/Parser.java@caf115bb98ad
permissions -rw-r--r--
8226511: Implement JFR Event Streaming Reviewed-by: egahlin, mseledtsov, mgronlun Contributed-by: erik.gahlin@oracle.com, mikhailo.seledtsov@oracle.com, markus.gronlund@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     1
/*
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
     2
 * Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     4
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    10
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    15
 * accompanied this code).
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    16
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    20
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    23
 * questions.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    24
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    25
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
    26
package jdk.jfr.internal.consumer;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
import java.io.IOException;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
/**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
 * Base class for parsing data from a {@link RecordingInput}.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
abstract class Parser {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
     * Parses data from a {@link RecordingInput} and return an object.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
     * @param input input to read from
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
     * @return an object
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
     * @throws IOException if operation couldn't be completed due to I/O
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
     *         problems
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
     */
58863
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
    42
    public abstract Object parse(RecordingInput input) throws IOException;
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
    43
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
    44
    /**
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
    45
     * Skips data that would usually be by parsed the {@code #parse(RecordingInput)} method.
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
    46
     *
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
    47
     * @param input input to read from
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
    48
     * @throws IOException if operation couldn't be completed due to I/O
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
    49
     *         problems
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
    50
     */
c16ac7a2eba4 8226511: Implement JFR Event Streaming
mgronlun
parents: 50113
diff changeset
    51
    public abstract void skip(RecordingInput input) throws IOException;
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
}