test/intervalstore/nonc/SimpleFeature.java

   1 /*
   2 BSD 3-Clause License
   3
   4 Copyright (c) 2018, Mungo Carstairs
   5 All rights reserved.
   6
   7 Redistribution and use in source and binary forms, with or without
   8 modification, are permitted provided that the following conditions are met:
   9
  10 * Redistributions of source code must retain the above copyright notice, this
  11   list of conditions and the following disclaimer.
  12
  13 * Redistributions in binary form must reproduce the above copyright notice,
  14   this list of conditions and the following disclaimer in the documentation
  15   and/or other materials provided with the distribution.
  16
  17 * Neither the name of the copyright holder nor the names of its
  18   contributors may be used to endorse or promote products derived from
  19   this software without specific prior written permission.
  20
  21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 */
  32 package intervalstore.nonc;
  33
  34 import jalview.datamodel.SequenceFeature;
  35
  36 /**
  37  * A simplified feature instance sufficient for unit test purposes.
  38  *
  39  * Subclasses SequenceFeature only because otherwise we have to use equals() in
  40  * the Jalview version of nonc.IntervalStore, and that does a class check that
  41  * we were trying to avoid.
  42  *
  43  */
  44 public class SimpleFeature extends SequenceFeature
  45 {
  46   final private int begin;
  47
  48   final private int end;
  49
  50   private String description;
  51
  52   /**
  53    * Constructor
  54    *
  55    * @param from
  56    * @param to
  57    * @param desc
  58    */
  59   public SimpleFeature(int from, int to, String desc)
  60   {
  61     super("", desc, from, to, "");
  62     begin = from;
  63     end = to;
  64     description = desc;
  65   }
  66
  67   /**
  68    * Copy constructor
  69    *
  70    * @param sf1
  71    */
  72   public SimpleFeature(SimpleFeature sf1)
  73   {
  74     this(sf1.begin, sf1.end, sf1.description);
  75   }
  76
  77   @Override
  78   public int getBegin()
  79   {
  80     return begin;
  81   }
  82
  83   @Override
  84   public int getEnd()
  85   {
  86     return end;
  87   }
  88
  89   @Override
  90   public String getDescription()
  91   {
  92     return description;
  93   }
  94
  95   @Override
  96   public int hashCode()
  97   {
  98     return begin + 37 * end
  99             + (description == null ? 0 : description.hashCode());
 100   }
 101
 102   /**
 103    * Equals method that requires two instances to have the same description, as
 104    * well as start and end position.
 105    */
 106   @Override
 107   public boolean equals(Object obj)
 108   {
 109     if (obj != null && obj instanceof SimpleFeature)
 110     {
 111       SimpleFeature o = (SimpleFeature) obj;
 112       if (this.begin == o.begin && this.end == o.end)
 113       {
 114         if (this.description == null)
 115         {
 116           return o.description == null;
 117         }
 118         return this.description.equals(o.description);
 119       }
 120     }
 121     return false;
 122   }
 123
 124   @Override
 125   public String toString()
 126   {
 127     return begin + ":" + end + ":" + description;
 128   }
 129
 130 }