net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/corext/textmanipulation/TextRegion.java

   1 /*
   2  * (c) Copyright IBM Corp. 2000, 2001.
   3  * All Rights Reserved.
   4  */
   5 package net.sourceforge.phpdt.internal.corext.textmanipulation;
   6
   7 /**
   8  * A text region describes a certain range in an <code>ITextBuffer</code>. A
   9  * region is defined by its offset into the text buffer and its length.
  10  * <p>
  11  * A region is considered a value object. Its offset or length do not change
  12  * over time.
  13  * </p>
  14  * <p>
  15  * <bf>NOTE:<bf> This class/interface is part of an interim API that is still
  16  * under development and expected to change significantly before reaching
  17  * stability. It is being made available at this early stage to solicit feedback
  18  * from pioneering adopters on the understanding that any code that uses this
  19  * API will almost certainly be broken (repeatedly) as the API evolves.
  20  * </p>
  21  */
  22
  23 // This class avoids contamination of clients with wrong imports.
  24 public abstract class TextRegion {
  25
  26         /**
  27          * Returns the offset of the region.
  28          *
  29          * @return the offset of the region
  30          */
  31         public abstract int getOffset();
  32
  33         /**
  34          * Returns the length of the region.
  35          *
  36          * @return the length of the region
  37          */
  38         public abstract int getLength();
  39
  40 }