net.sf.mpxj.ProjectCalendarDateRanges 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.8.0

Show newest version

/*
 * file:       ProjectCalendarDateRanges.java
 * author:     Jon Iles
 * copyright:  (c) Packwood Software 2002-2008
 * date:       11/11/2008
 */

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

import java.util.Iterator;
import java.util.LinkedList;

/**
 * An abstract class representing a collection of date ranges
 * with supporting methods.
 */
public abstract class ProjectCalendarDateRanges implements Iterable
{
   /**
    * Add a date range to the list of date ranges.
    *
    * @param range date range
    */
   public void addRange(DateRange range)
   {
      m_ranges.add(range);
   }

   /**
    * Retrieve the date range at the specified index.
    * The index is zero based, and this method will return
    * null if the requested date range does not exist.
    *
    * @param index range index
    * @return date range instance
    */
   public DateRange getRange(int index)
   {
      DateRange result;

      if (index >= 0 && index < m_ranges.size())
      {
         result = m_ranges.get(index);
      }
      else
      {
         result = DateRange.EMPTY_RANGE;
      }

      return (result);
   }

   /**
    * Replace a date range at the specified index.
    *
    * @param index range index
    * @param value DateRange instance
    */
   public void setRange(int index, DateRange value)
   {
      m_ranges.set(index, value);
   }

   /**
    * Retrieve an iterator to allow the list of date ranges to be traversed.
    *
    * @return iterator.
    */
   @Override public Iterator iterator()
   {
      return (m_ranges.iterator());
   }

   /**
    * Returns the number of date ranges associated with this instance.
    *
    * @return number of date ranges
    */
   public int getRangeCount()
   {
      return (m_ranges.size());
   }

   private LinkedList m_ranges = new LinkedList();
}