net.sf.mpxj.mpp.ProgressLineDay Maven / Gradle / Ivy

Go to download

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

Library that provides facilities to allow project information to be manipulated in Java and .Net. Supports a range of data formats: Microsoft Project Exchange (MPX), Microsoft Project (MPP,MPT), Microsoft Project Data Interchange (MSPDI XML), Microsoft Project Database (MPD), Planner (XML), Primavera (PM XML, XER, and database), Asta Powerproject (PP, MDB), Asta Easyplan (PP), Phoenix Project Manager (PPX), FastTrack Schedule (FTS), and the Standard Data Exchange Format (SDEF).

There is a newer version: 13.6.0

Show newest version

/*
 * file:       ProgressLineDay.java
 * author:     Jon Iles
 * copyright:  (c) Packwood Software 2005
 * date:       26/03/2005
 */

/*
 * 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.
 */

package net.sf.mpxj.mpp;

import java.time.DayOfWeek;
import net.sf.mpxj.MpxjEnum;
import net.sf.mpxj.common.EnumHelper;

/**
 * Instances of this class represent enumerated day values used as to
 * define when progress lines are drawn.
 */
public enum ProgressLineDay implements MpxjEnum
{
   SUNDAY(1, DayOfWeek.SUNDAY),
   MONDAY(2, DayOfWeek.MONDAY),
   TUESDAY(3, DayOfWeek.TUESDAY),
   WEDNESDAY(4, DayOfWeek.WEDNESDAY),
   THURSDAY(5, DayOfWeek.THURSDAY),
   FRIDAY(6, DayOfWeek.FRIDAY),
   SATURDAY(7, DayOfWeek.SATURDAY),
   DAY(8, null),
   WORKINGDAY(9, null),
   NONWORKINGDAY(10, null);

   /**
    * Private constructor.
    *
    * @param value day value
    * @param day equivalent Day instance
    */
   ProgressLineDay(int value, DayOfWeek day)
   {
      m_value = value;
      m_day = day;
   }

   /**
    * Retrieves the int representation of the day.
    *
    * @return task type value
    */
   @Override public int getValue()
   {
      return m_value;
   }

   /**
    * Retrieve the Day instance which is equivalent to this ProgressLine.
    *
    * @return Day instance
    */
   public DayOfWeek getDay()
   {
      return m_day;
   }

   /**
    * This method provides a simple mechanism to retrieve
    * the next day in correct sequence, including the transition
    * from Sunday to Monday.
    *
    * @return ProgressLineDay instance
    */
   public ProgressLineDay getNextDay()
   {
      int value = m_value + 1;
      if (value > 7)
      {
         value = 1;
      }
      return (getInstance(value));
   }

   /**
    * Retrieve a ProgressLineDay instance representing the supplied value.
    *
    * @param type type value
    * @return ProgressLineDay instance
    */
   public static ProgressLineDay getInstance(int type)
   {
      ProgressLineDay result;

      if (type < 0 || type >= TYPE_VALUES.length)
      {
         result = null;
      }
      else
      {
         result = TYPE_VALUES[type];
      }
      return result;
   }

   /**
    * Array mapping int types to enums.
    */
   private static final ProgressLineDay[] TYPE_VALUES = EnumHelper.createTypeArray(ProgressLineDay.class, 1);

   private final int m_value;
   private final DayOfWeek m_day;

}