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