tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/lookup/ITmfCallsite.java

   1 /*******************************************************************************
   2  * Copyright (c) 2013, 2014 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are made
   5  * available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Bernd Hufmann - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.core.event.lookup;
  14
  15 import org.eclipse.jdt.annotation.NonNull;
  16
  17 /**
  18  * The generic call site structure in TMF. A call site has:
  19  * <ul>
  20  * <li> a file name
  21  * <li> a function name (optional)
  22  * <li> a line number
  23  * </ul>
  24  *
  25  * @author Bernd Hufmann
  26  *
  27  * @see TmfCallsite
  28  */
  29 public interface ITmfCallsite {
  30
  31     /**
  32      * Returns the file name of the call site.
  33      *
  34      * @return the file name
  35      */
  36     @NonNull String getFileName();
  37
  38     /**
  39      * Returns the function name of the call site.
  40      *
  41      * @return the function name or null
  42      */
  43     String getFunctionName();
  44
  45     /**
  46      * Returns the line number of the call site.
  47      *
  48      * @return the line number
  49      */
  50     long getLineNumber();
  51 }