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.internal.consumer;

    27 

    28 import java.io.IOException;

    29 

    30 /**

    31  * Base class for parsing data from a {@link RecordingInput}.

    32  */

    33 abstract class Parser {

    34     /**

    35      * Parses data from a {@link RecordingInput} and return an object.

    36      *

    37      * @param input input to read from

    38      * @return an object

    39      * @throws IOException if operation couldn't be completed due to I/O

    40      *         problems

    41      */

    42     public abstract Object parse(RecordingInput input) throws IOException;

    43 

    44     /**

    45      * Skips data that would usually be by parsed the {@code #parse(RecordingInput)} method.

    46      *

    47      * @param input input to read from

    48      * @throws IOException if operation couldn't be completed due to I/O

    49      *         problems

    50      */

    51     public abstract void skip(RecordingInput input) throws IOException;

    52 }