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

   1 /*******************************************************************************
   2  * Copyright (c) 2013 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.linuxtools.tmf.core.event.lookup;
  14
  15
  16 /**
  17  * The generic call site structure in TMF. A call site has:
  18  * <ul>
  19  * <li> a file name
  20  * <li> a function name (optional)
  21  * <li> a line number
  22  * </ul>
  23  *
  24  * @author Bernd Hufmann
  25  * @since 2.0
  26  *
  27  * @see TmfCallsite
  28  */
  29 public interface ITmfCallsite {
  30     /**
  31      * Returns the file name of the call site.
  32      * @return the file name
  33      */
  34     public String getFileName();
  35
  36     /**
  37      * Returns the function name of the call site.
  38      * @return the function name or null
  39      */
  40     public String getFunctionName();
  41
  42     /**
  43      * Returns the line number of the call site.
  44      * @return the line number
  45      */
  46     public long getLineNumber();
  47 }