com.hfg.bio.seq.format.feature.BasicFeatureKey Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation

com.hfg xml, html, svg, and bioinformatics utility library

There is a newer version: 20240423

package com.hfg.bio.seq.format.feature;

//------------------------------------------------------------------------------
/**
 Basic implementation of FeatureKey interface.
 
  @author J. Alex Taylor, hairyfatguy.com
 
 */
//------------------------------------------------------------------------------
// com.hfg Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class BasicFeatureKey implements FeatureKey
{
   private String mName;
   private String mDescription;

   //---------------------------------------------------------------------------
   public BasicFeatureKey(String inName)
   {
      mName = inName;
   }

   //---------------------------------------------------------------------------
   @Override
   public String name()
   {
      return mName;
   }

   //---------------------------------------------------------------------------
   public BasicFeatureKey setDescription(String inValue)
   {
      mDescription = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   @Override
   public String getDescription()
   {
      return mDescription;
   }

   //---------------------------------------------------------------------------
   @Override
   public boolean equals(Object inObj2)
   {
      return inObj2 instanceof FeatureKey
             && name().equals(((FeatureKey)inObj2).name());
   }

   //---------------------------------------------------------------------------
   @Override
   public int hashCode()
   {
      return name().hashCode();
   }

}