/*
    * $Id: Calendar.java [Apr 5, 2004]
    *
    * Copyright (c) 2004, Ben Fortuna
    * All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
   *
   * 	o Redistributions of source code must retain the above copyright
   * notice, this list of conditions and the following disclaimer.
   *
   * 	o Redistributions in binary form must reproduce the above copyright
   * notice, this list of conditions and the following disclaimer in the
   * documentation and/or other materials provided with the distribution.
   *
   * 	o Neither the name of Ben Fortuna nor the names of any other contributors
   * may be used to endorse or promote products derived from this software
   * without specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
   * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
   * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
   * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  package net.fortuna.ical4j.model;
  
  import java.util.Iterator;
  
  import net.fortuna.ical4j.model.property.XProperty;
  import net.fortuna.ical4j.util.PropertyValidator;
  
  /***
   * Defines an iCalendar calendar.
   *
   * @author benf
   */
  public class Calendar {
  
      public static final String BEGIN = "BEGIN";
  
      public static final String VCALENDAR = "VCALENDAR";
  
      public static final String END = "END";
  
      private PropertyList properties;
  
      private ComponentList components;
  
      /***
       * Constructor.
       *
       * @param p
       *            a list of properties
       * @param c
       *            a list of components
       * @throws ValidationException
       *             where the specified arguments do not meet the criteria for a
       *             valid iCalendar
       */
      public Calendar(final PropertyList p, final ComponentList c)
              throws ValidationException {
  
          this.properties = p;
          this.components = c;
      }
  
      /***
       * @see java.lang.Object#toString()
       */
      public final String toString() {
          return BEGIN + ":" + VCALENDAR + "\r\n" + properties + components + END
                  + ":" + VCALENDAR + "\r\n";
      }
  
      /***
       * @return Returns the components.
       */
      public final ComponentList getComponents() {
          return components;
      }
  
      /***
       * @return Returns the properties.
       */
      public final PropertyList getProperties() {
          return properties;
      }
  
      /***
       * Perform validation on the calendar, its properties
      * and its components in its current state.
      * @throws ValidationException
      *             where the calendar is not in a valid state
      */
     public final void validate() throws ValidationException {
         validate(true);
     }
 
     /***
      * Perform validation on the calendar in its current state.
      * @param recurse indicates whether to validate the calendar's
      * properties and components
      * @throws ValidationException
      *             where the calendar is not in a valid state
      */
     public final void validate(boolean recurse) throws ValidationException {
         // 'prodid' and 'version' are both REQUIRED,
         // but MUST NOT occur more than once
         PropertyValidator.getInstance().validateOne(Property.PRODID, properties);
         PropertyValidator.getInstance().validateOne(Property.VERSION, properties);
 
         // 'calscale' and 'method' are optional,
         // but MUST NOT occur more than once
         PropertyValidator.getInstance()
                 .validateOneOrLess(Property.CALSCALE, properties);
         PropertyValidator.getInstance().validateOneOrLess(Property.METHOD, properties);
 
         // must contain at least one component
         if (getComponents().isEmpty()) { throw new ValidationException(
                 "Calendar must contain at least one component"); }
 
         // validate properties..
         for (Iterator i = getProperties().iterator(); i.hasNext();) {
             Property property = (Property) i.next();
 
             if (!(property instanceof XProperty)
                  && !property.isCalendarProperty()) {
                 throw new IllegalArgumentException(
                     "Invalid property: " + property.getName());
             }
         }
 
         // validate components..
         for (Iterator i = getComponents().iterator(); i.hasNext();) {
             Component component = (Component) i.next();
 
             if (!component.isCalendarComponent()) {
                 throw new IllegalArgumentException(
                     "Invalid component: " + component.getName());
             }
         }
         
         if (recurse) {
             validateProperties();
             validateComponents();
         }
     }
     
     /***
      * Invoke validation on the calendar properties in its current state.
      * @throws ValidationException
      *             where any of the calendar properties is not in a valid state
      */
     private void validateProperties() throws ValidationException {
         for (Iterator i = getProperties().iterator(); i.hasNext();) {
             Property property = (Property) i.next();
             property.validate();
         }
     }
     
     /***
      * Invoke validation on the calendar components in its current state.
      * @throws ValidationException
      *             where any of the calendar components is not in a valid state
      */
     private void validateComponents() throws ValidationException {
         for (Iterator i = getComponents().iterator(); i.hasNext();) {
             Component component = (Component) i.next();
             component.validate();
         }
     }
 }