cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/IParsable.java

   1 /**
   2 * Copyright (C) 2007 EDIT
   3 * European Distributed Institute of Taxonomy
   4 * http://www.e-taxonomy.eu
   5 *
   6 * The contents of this file are subject to the Mozilla Public License Version 1.1
   7 * See LICENSE.TXT at the top of this package for the full license terms.
   8 */
   9
  10 package eu.etaxonomy.cdm.model.common;
  11
  12
  13 /**
  14  * @author a.mueller
  15  * @created 21.05.2008
  16  * @version 1.0
  17  */
  18 public interface IParsable {
  19
  20         /**
  21          * Returns the boolean value of the flag indicating whether the used parser
  22          * method was able to parse a string successfully into this object (<code>false</code>)
  23          * or not (<code>true</code>).
  24          *
  25          * @return  the boolean value of the hasProblem flag
  26          */
  27         public boolean getHasProblem();
  28
  29         /**
  30          * @see  #getHasProblem()
  31          */
  32         public void setHasProblem(boolean hasProblem);
  33
  34         /**
  35          * Returns exactly the same boolean value as the {@link #getHasProblem() getHasProblem} method.
  36          *
  37          * @see  #getHasProblem()
  38          */
  39         public boolean hasProblem();
  40
  41         /**
  42          * Returns the integer value of the position where a parsing problem starts.
  43          * If no problem exists -1 is returned.
  44          * This method will be removed by a more sophisticated method in future versions,
  45          * therefore it is deprecated.<BR>
  46          * Default: -1
  47          * @see  #getHasProblem()
  48          */
  49         @Deprecated
  50         public int getProblemStarts();
  51
  52         /**
  53          * Returns the integer value of the position where a parsing problem ends.
  54          * If no problem exists -1 is returned.
  55          * This method will be removed by a more sophisticated method in future versions,
  56          * therefore it is deprecated. <BR>
  57          * Default: -1
  58          * @see  #getHasProblem()
  59          */
  60         @Deprecated
  61         public int getProblemEnds();
  62
  63         /**
  64          * @see  #getProblemStarts()
  65          */
  66         @Deprecated
  67         public void setProblemStarts(int start);
  68
  69         /**
  70          * @see  #getProblemEnds()
  71          */
  72         @Deprecated
  73         public void setProblemEnds(int end);
  74
  75 }