1 /*
   2  * Copyright (c) 2012, 2018, 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.events;
  27 
  28 import jdk.jfr.Category;
  29 import jdk.jfr.Description;
  30 import jdk.jfr.Label;
  31 import jdk.jfr.DataAmount;
  32 import jdk.jfr.Name;
  33 import jdk.jfr.internal.Type;
  34 
  35 @Name(Type.EVENT_NAME_PREFIX + "FileRead")
  36 @Label("File Read")
  37 @Category("Java Application")
  38 @Description("Reading data from a file")
  39 public final class FileReadEvent extends AbstractJDKEvent {
  40 
  41     public static final ThreadLocal<FileReadEvent> EVENT =
  42         new ThreadLocal<FileReadEvent>() {
  43             @Override protected FileReadEvent initialValue() {
  44                 return new FileReadEvent();
  45             }
  46         };
  47 
  48     @Label("Path")
  49     @Description("Full path of the file")
  50     public String path;
  51 
  52     @Label("Bytes Read")
  53     @Description("Number of bytes read from the file (possibly 0)")
  54     @DataAmount
  55     public long bytesRead;
  56 
  57     @Label("End of File")
  58     @Description("If end of file was reached")
  59     public boolean endOfFile;
  60 
  61     public void reset() {
  62         path = null;
  63         endOfFile = false;
  64         bytesRead = 0;
  65     }
  66 }