/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.juneau.bean.html5;

import static org.apache.juneau.xml.annotation.XmlFormat.*;

import java.util.*;

import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.xml.annotation.*;

/**
 * A subclass of HTML elements that contain only other elements, not text.
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauBeanHtml5">juneau-bean-html5</a>
 * </ul>
 */
public class HtmlElementContainer extends HtmlElement {

   private List<Object> children;

   /**
    * The children of this element.
    *
    * @return The children of this element.
    */
   @Xml(format=ELEMENTS)
   @Beanp(dictionary=HtmlBeanDictionary.class, name="c")
   public List<Object> getChildren() {
      return children;
   }

   /**
    * Sets the children for this container.
    *
    * @param children The new children for this container.
    * @return This object.
    */
   @Beanp("c")
   public HtmlElementContainer setChildren(List<Object> children) {
      this.children = children;
      return this;
   }

   /**
    * Returns the child node at the specified index.
    *
    * @param index The index of the node in the list of children.
    * @return The child node, or <jk>null</jk> if it doesn't exist.
    */
   public Object getChild(int index) {
      return (children == null || children.size() <= index || index < 0 ? null : children.get(index));
   }

   /**
    * Returns the child node at the specified address.
    *
    * <p>
    * Indexes are zero-indexed.
    *
    * <p>
    * For example, calling <c>getChild(1,2,3);</c> will return the 4th child of the 3rd child of the 2nd child.
    *
    * @param index The child indexes.
    * @return The child node, or <jk>null</jk> if it doesn't point to a valid child.
    */
   public Object getChild(int...index) {
      if (index.length == 0)
         return null;
      if (index.length == 1)
         return getChild(index[0]);
      Object c = this;
      for (var element : index) {
         if (c instanceof HtmlElementMixed x)
            c = x.getChild(element);
         else if (c instanceof HtmlElementContainer x)
            c = x.getChild(element);
         else
            return null;
      }
      return c;
   }

   /**
    * Returns the child node at the specified index.
    *
    * @param <T> The class type of the node.
    * @param type The class type of the node.
    * @param index The index of the node in the list of children.
    * @return The child node, or <jk>null</jk> if it doesn't exist.
    * @throws InvalidDataConversionException If node is not the expected type.
    */
   public <T> T getChild(Class<T> type, int index) {
      return (children == null || children.size() <= index || index < 0
         ? null
         : ConverterUtils.toType(children.get(index), type)
      );
   }

   /**
    * Adds one or more child elements to this element.
    *
    * @param children The children to add as child elements.
    * @return This object.
    */
   public HtmlElement children(Object...value) {
      if (value.length > 0) {
         if (this.children == null)
            this.children = new LinkedList<>();
         for (var c : value)
            this.children.add(c);
      }
      return this;
   }

   /**
    * Adds a child element to this element.
    *
    * @param child The child to add as a child element.
    * @return This object.
    */
   public HtmlElement child(Object value) {
      if (this.children == null)
         this.children = new LinkedList<>();
      this.children.add(value);
      return this;
   }
   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer _class(String value) {  // NOSONAR - Intentional naming.
      super._class(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer accesskey(String value) {
      super.accesskey(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer contenteditable(Object value) {
      super.contenteditable(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer dir(String value) {
      super.dir(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer hidden(Object value) {
      super.hidden(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer id(String value) {
      super.id(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer lang(String value) {
      super.lang(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onabort(String value) {
      super.onabort(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onblur(String value) {
      super.onblur(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer oncancel(String value) {
      super.oncancel(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer oncanplay(String value) {
      super.oncanplay(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer oncanplaythrough(String value) {
      super.oncanplaythrough(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onchange(String value) {
      super.onchange(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onclick(String value) {
      super.onclick(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer oncuechange(String value) {
      super.oncuechange(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer ondblclick(String value) {
      super.ondblclick(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer ondurationchange(String value) {
      super.ondurationchange(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onemptied(String value) {
      super.onemptied(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onended(String value) {
      super.onended(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onerror(String value) {
      super.onerror(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onfocus(String value) {
      super.onfocus(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer oninput(String value) {
      super.oninput(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer oninvalid(String value) {
      super.oninvalid(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onkeydown(String value) {
      super.onkeydown(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onkeypress(String value) {
      super.onkeypress(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onkeyup(String value) {
      super.onkeyup(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onload(String value) {
      super.onload(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onloadeddata(String value) {
      super.onloadeddata(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onloadedmetadata(String value) {
      super.onloadedmetadata(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onloadstart(String value) {
      super.onloadstart(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onmousedown(String value) {
      super.onmousedown(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onmouseenter(String value) {
      super.onmouseenter(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onmouseleave(String value) {
      super.onmouseleave(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onmousemove(String value) {
      super.onmousemove(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onmouseout(String value) {
      super.onmouseout(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onmouseover(String value) {
      super.onmouseover(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onmouseup(String value) {
      super.onmouseup(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onmousewheel(String value) {
      super.onmousewheel(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onpause(String value) {
      super.onpause(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onplay(String value) {
      super.onplay(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onplaying(String value) {
      super.onplaying(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onprogress(String value) {
      super.onprogress(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onratechange(String value) {
      super.onratechange(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onreset(String value) {
      super.onreset(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onresize(String value) {
      super.onresize(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onscroll(String value) {
      super.onscroll(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onseeked(String value) {
      super.onseeked(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onseeking(String value) {
      super.onseeking(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onselect(String value) {
      super.onselect(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onshow(String value) {
      super.onshow(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onstalled(String value) {
      super.onstalled(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onsubmit(String value) {
      super.onsubmit(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onsuspend(String value) {
      super.onsuspend(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer ontimeupdate(String value) {
      super.ontimeupdate(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer ontoggle(String value) {
      super.ontoggle(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onvolumechange(String value) {
      super.onvolumechange(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer onwaiting(String value) {
      super.onwaiting(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer spellcheck(Object value) {
      super.spellcheck(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer style(String value) {
      super.style(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer tabindex(Object value) {
      super.tabindex(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer title(String value) {
      super.title(value);
      return this;
   }

   @Override /* Overridden from HtmlElement */
   public HtmlElementContainer translate(Object value) {
      super.translate(value);
      return this;
   }
}