net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/ISourceRange.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11 package net.sourceforge.phpdt.core;
  12
  13 /**
  14  * A source range defines an element's source coordinates relative to its source
  15  * buffer.
  16  * <p>
  17  * This interface is not intended to be implemented by clients.
  18  * </p>
  19  */
  20 public interface ISourceRange {
  21
  22         /**
  23          * Returns the number of characters of the source code for this element,
  24          * relative to the source buffer in which this element is contained.
  25          *
  26          * @return the number of characters of the source code for this element,
  27          *         relative to the source buffer in which this element is contained
  28          */
  29         int getLength();
  30
  31         /**
  32          * Returns the 0-based index of the first character of the source code for
  33          * this element, relative to the source buffer in which this element is
  34          * contained.
  35          *
  36          * @return the 0-based index of the first character of the source code for
  37          *         this element, relative to the source buffer in which this element
  38          *         is contained
  39          */
  40         int getOffset();
  41 }