/**
    * Copyright (C) 2014-2016 Philip Helger (www.helger.com)
    * philip[at]helger[dot]com
    *
    * 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 com.helger.schematron.pure.model;
  
  import javax.annotation.Nonnull;
  import javax.annotation.concurrent.NotThreadSafe;
  
  import com.helger.commons.ValueEnforcer;
  import com.helger.commons.annotation.Nonempty;
  import com.helger.commons.annotation.ReturnsMutableCopy;
  import com.helger.commons.collection.CollectionHelper;
  import com.helger.commons.collection.ext.CommonsArrayList;
  import com.helger.commons.collection.ext.ICommonsList;
  import com.helger.commons.string.ToStringGenerator;
  import com.helger.schematron.CSchematron;
  import com.helger.schematron.CSchematronXML;
  import com.helger.schematron.pure.errorhandler.IPSErrorHandler;
  import com.helger.xml.microdom.IMicroElement;
  import com.helger.xml.microdom.MicroElement;
  
  /**
   * A single Schematron title-element.<br>
   * A summary of the purpose or role of the schema or pattern, for the purpose of
   * documentation or a rich user interface.<br>
   * An implementation is not required to make use of this element.
   *
   * @author Philip Helger
   */
  @NotThreadSafe
  public class PSTitle implements IPSClonableElement <PSTitle>, IPSOptionalElement, IPSHasMixedContent
  {
    private final ICommonsList <Object> m_aContent = new CommonsArrayList <> ();
  
    public PSTitle ()
    {}
  
    public boolean isValid (@Nonnull final IPSErrorHandler aErrorHandler)
    {
      for (final Object aContent : m_aContent)
        if (aContent instanceof IPSElement)
          if (!((IPSElement) aContent).isValid (aErrorHandler))
            return false;
      return true;
    }
  
    public void validateCompletely (@Nonnull final IPSErrorHandler aErrorHandler)
    {
      for (final Object aContent : m_aContent)
        if (aContent instanceof IPSElement)
          ((IPSElement) aContent).validateCompletely (aErrorHandler);
    }
  
    public boolean isMinimal ()
    {
      return false;
    }
  
    public void addText (@Nonnull @Nonempty final String sText)
    {
      ValueEnforcer.notEmpty (sText, "Text");
      m_aContent.add (sText);
    }
  
    public boolean hasAnyText ()
    {
      return m_aContent.containsAny (e -> e instanceof String);
    }
  
    @Nonnull
    @ReturnsMutableCopy
    public ICommonsList <String> getAllTexts ()
    {
      return m_aContent.getAllInstanceOf (String.class);
    }
  
    public void addDir (@Nonnull final PSDir aDir)
    {
      ValueEnforcer.notNull (aDir, "Dir");
      m_aContent.add (aDir);
    }
  
    @Nonnull
    @ReturnsMutableCopy
    public ICommonsList <PSDir> getAllDirs ()
    {
     return m_aContent.getAllInstanceOf (PSDir.class);
   }
 
   /**
    * @return A list of {@link String} and {@link PSDir} elements.
    */
   @Nonnull
   @ReturnsMutableCopy
   public ICommonsList <Object> getAllContentElements ()
   {
     return m_aContent.getClone ();
   }
 
   @Nonnull
   public IMicroElement getAsMicroElement ()
   {
     final IMicroElement ret = new MicroElement (CSchematron.NAMESPACE_SCHEMATRON, CSchematronXML.ELEMENT_TITLE);
     for (final Object aContent : m_aContent)
       if (aContent instanceof String)
         ret.appendText ((String) aContent);
       else
         ret.appendChild (((IPSElement) aContent).getAsMicroElement ());
     return ret;
   }
 
   @Nonnull
   public PSTitle getClone ()
   {
     final PSTitle ret = new PSTitle ();
     for (final Object aContent : m_aContent)
       if (aContent instanceof String)
         ret.addText ((String) aContent);
       else
         if (aContent instanceof PSDir)
           ret.addDir (((PSDir) aContent).getClone ());
     return ret;
   }
 
   @Override
   public String toString ()
   {
     return new ToStringGenerator (this).appendIf ("content", m_aContent, CollectionHelper::isNotEmpty).toString ();
   }
 }