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 import org.eclipse.jdt.annotation.Nullable;
  17
  18 /**
  19  * The generic call site structure in TMF. A call site has:
  20  * <ul>
  21  * <li> a file name
  22  * <li> a function name (optional)
  23  * <li> a line number
  24  * </ul>
  25  *
  26  * @author Bernd Hufmann
  27  *
  28  * @see TmfCallsite
  29  */
  30 public interface ITmfCallsite {
  31
  32     /**
  33      * Returns the file name of the call site.
  34      *
  35      * @return the file name
  36      */
  37     @NonNull String getFileName();
  38
  39     /**
  40      * Returns the function name of the call site.
  41      *
  42      * @return the function name or null
  43      * @deprecated Should not be part of this interface anymore.
  44      */
  45     @Deprecated
  46     @Nullable String getFunctionName();
  47
  48     /**
  49      * Returns the line number of the call site.
  50      *
  51      * @return the line number
  52      * @deprecated Use {@link #getLineNo()} instead, which can return null.
  53      */
  54     @Deprecated
  55     long getLineNumber();
  56
  57     /**
  58      * Returns the line number of the call site.
  59      *
  60      * @return The line number, or 'null' if unavailable
  61      * @since 2.1
  62      */
  63     default @Nullable Long getLineNo() {
  64         /* TODO Change to abstract method once getLineNumber() is removed */
  65         return getLineNumber();
  66     }
  67 }