com.hfg.bio.seq.Clone 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;

//------------------------------------------------------------------------------
/**
 Sequence clone name container.
 
 @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 Clone implements Comparable
{
   private String mName;
   private String mSubcloneName;


   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

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

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return name() + (getSubcloneName() != null ? " (" + getSubcloneName() + ")" : "");
   }

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

   //---------------------------------------------------------------------------
   public Clone setSubcloneName(String inValue)
   {
      mSubcloneName = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public String getSubcloneName()
   {
      return mSubcloneName;
   }

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

   //---------------------------------------------------------------------------
   @Override
   public boolean equals(Object inObj2)
   {
      boolean result = false;
      if (inObj2 != null
            && inObj2 instanceof Clone)
      {
         result = (0 == compareTo((Clone) inObj2));
      }

      return result;
   }

   //---------------------------------------------------------------------------
   @Override
   public int compareTo(Clone inObj2)
   {
      return toString().compareTo(inObj2.toString());
   }
}