com.hfg.datetime.DateSortDirection 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.datetime;

import java.io.Serializable;
import java.util.List;
import java.util.ArrayList;

//------------------------------------------------------------------------------
/**
 * Enum-like date sort direction class.
 *
 * @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding 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 DateSortDirection implements Serializable
{
   private String mName;
   private int    mIndex;

   private static List sList = new ArrayList(2);

   public static final DateSortDirection OLDER_TO_NEWER = new DateSortDirection("->");
   public static final DateSortDirection NEWER_TO_OLDER = new DateSortDirection("<-");

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

   //--------------------------------------------------------------------------
   private DateSortDirection(String inName)
   {
      mName = inName;
      mIndex = sList.size();
      sList.add(this);
   }

   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################

   //--------------------------------------------------------------------------
   public final String getName()
   {
      return mName;
   }

   //--------------------------------------------------------------------------
   public final String toString()
   {
      return mName;
   }


   //--------------------------------------------------------------------------
   public final int hashCode()
   {
      return super.hashCode();
   }

   //--------------------------------------------------------------------------
   public final boolean equals(Object inObj)
   {
      DateSortDirection o2 = (DateSortDirection) inObj;
      return (mIndex == o2.mIndex);
   }

   //--------------------------------------------------------------------------
   public static final DateSortDirection getFromString(String inValue)
   {
      DateSortDirection direction = null;

      if (inValue != null)
      {
         if (inValue.equalsIgnoreCase("<-"))
         {
            direction = DateSortDirection.NEWER_TO_OLDER;
         }
         else if (inValue.equalsIgnoreCase("->"))
         {
            direction = DateSortDirection.OLDER_TO_NEWER;
         }
         else
         {
            throw new RuntimeException("'" + inValue + "' is not a recognized DateSortDirection value.");
         }
      }

      return direction;
   }

   //--------------------------------------------------------------------------
   /**
    * This method is called after de-serialization, allowing the object
    * to nominate a replacement object to be used in the output
    * graph instead of this object. We don't want multiple objects of each type
    * to exist in a target VM, so instances replace themselves with
    * local objects.
    */
   private Object readResolve()
   {
      return sList.get(mIndex);
   }
}