/*
    * Copyright 2010-2013 smartics, Kronseder & Reiner GmbH
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package de.smartics.testdoc.report.index;
  
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import net.jcip.annotations.NotThreadSafe;
  
  import org.apache.commons.lang.StringUtils;
  
  /**
   * The implementation provides a static view on sections. The sections, once
   * added, cannot be modified afterwards.
   *
   * @param <T> the type of the items added to this section.
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  @NotThreadSafe
  public class StaticSection<T extends Serializable> implements Serializable,
      Section<T>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The name of this section. Must not be <code>null</code>.
     *
     * @serial
     */
    private final String name;
  
    /**
     * The properties associated with this section.
     *
     * @serial
     */
    private final Map<String, ? extends Serializable> properties;
  
    /**
     * The list of sub sections to this section.
     *
     * @serial
     */
    private final List<Section<T>> subSections = new ArrayList<Section<T>>();
  
    /**
     * The test documentation instances associated with this section.
     *
     * @serial
     */
    private final List<T> items = new ArrayList<T>();
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Convenience constructor with an empty set of properties.
     *
     * @param name the name of this section.
     * @throws IllegalArgumentException if <code>name</code> is blank.
     */
    public StaticSection(final String name)
    {
      this(name, null);
    }
  
    /**
     * Default constructor.
     *
    * @param name the name of this section.
    * @param properties the properties associated with this section. May be
    *          <code>null</code>.
    * @throws IllegalArgumentException if <code>name</code> is blank.
    */
   public StaticSection(final String name,
       final Map<String, Serializable> properties)
     throws IllegalArgumentException
   {
     checkArguments(name);
     this.name = name;
     this.properties =
         (properties != null ? new HashMap<String, Serializable>(properties)
             : new HashMap<String, Serializable>());
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   private static void checkArguments(final String name)
     throws IllegalArgumentException
   {
     if (StringUtils.isBlank(name))
     {
       throw new IllegalArgumentException(
           "The name of the section must not be blank.");
     }
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.testdoc.report.index.Section#getName()
    */
   @Override
   public String getName()
   {
     return name;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.testdoc.report.index.Section#getProperties()
    */
   @Override
   public Map<String, ? extends Serializable> getProperties()
   {
     return properties;
   }
 
   // --- business -------------------------------------------------------------
 
   /**
    * {@inheritDoc}
    */
   @Override
   public void addSubSection(final Section<T> subSection)
   {
     subSections.add(subSection);
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.testdoc.report.index.Section#getSubSections()
    */
   @Override
   public List<Section<T>> getSubSections()
   {
     return Collections.unmodifiableList(subSections);
   }
 
   /**
    * {@inheritDoc}
    */
   @Override
   public void addItem(final T item)
   {
     items.add(item);
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.testdoc.report.index.Section#getItems()
    */
   @Override
   public List<T> getItems()
   {
     return Collections.unmodifiableList(items);
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.testdoc.report.index.Section#isEmpty()
    */
   @Override
   public boolean isEmpty()
   {
     if (items.isEmpty())
     {
       for (final Section<T> subSection : subSections)
       {
         if (!subSection.isEmpty())
         {
           return false;
         }
       }
     }
 
     return true;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.testdoc.report.index.Section#containsSubSections()
    */
   @Override
   public boolean containsSubSections()
   {
     return !subSections.isEmpty();
   }
 
   // --- object basics --------------------------------------------------------
 
 }