// ***************************************************************************************************************************
// * 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.dto.html5;

import java.net.*;
import java.net.URI;

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

/**
 * DTO for an HTML {@doc ExtHTML5.text-level-semantics#the-a-element <a>}
 * element.
 *
 * <ul class='seealso'>
 *    <li class='link'>{@doc DtoHtml5}
 * </ul>
 */
@Bean(typeName="a")
public class A extends HtmlElementMixed {

   /**
    * Creates an empty {@link A} element.
    */
   public A() {}

   /**
    * Creates an {@link A} element with the specified {@link A#href(Object)} attribute and {@link A#children(Object[])}
    * nodes.
    *
    * @param href The {@link A#href(Object)} attribute.
    * @param children The {@link A#children(Object[])} nodes.
    */
   public A(Object href, Object[] children) {
      href(href).children(children);
   }

   /**
    * {@doc ExtHTML5.links#attr-hyperlink-download download} attribute.
    *
    * <p>
    * Whether to download the resource instead of navigating to it, and its file name if so.
    *
    * @param download
    *    The new value for this attribute.
    *    Typically a {@link Boolean} or {@link String}.
    * @return This object (for method chaining).
    */
   public final A download(Object download) {
      attr("download", download);
      return this;
   }

   /**
    * {@doc ExtHTML5.links#attr-hyperlink-href href} attribute.
    *
    * <p>
    * Address of the hyperlink.
    *
    * <p>
    * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
    * Strings must be valid URIs.
    *
    * <p>
    * URIs defined by {@link UriResolver} can be used for values.
    *
    * @param href
    *    The new value for this attribute.
    *    Typically a {@link URL} or {@link String}.
    * @return This object (for method chaining).
    */
   public final A href(Object href) {
      attrUri("href", href);
      return this;
   }

   /**
    * {@doc ExtHTML5.links#attr-hyperlink-hreflang hreflang} attribute.
    *
    * <p>
    * Language of the linked resource.
    *
    * @param hreflang The new value for this attribute.
    * @return This object (for method chaining).
    */
   public final A hreflang(String hreflang) {
      attr("hreflang", hreflang);
      return this;
   }

   /**
    * {@doc ExtHTML5.links#attr-hyperlink-rel rel} attribute.
    *
    * <p>
    * Relationship between the document containing the hyperlink and the destination resource.
    *
    * @param rel The new value for this attribute.
    * @return This object (for method chaining).
    */
   public final A rel(String rel) {
      attr("rel", rel);
      return this;
   }

   /**
    * {@doc ExtHTML5.links#attr-hyperlink-target target} attribute.
    *
    * <p>
    * Default browsing context for hyperlink navigation and form submission.
    *
    * @param target The new value for this attribute.
    * @return This object (for method chaining).
    */
   public final A target(String target) {
      attr("target", target);
      return this;
   }

   /**
    * {@doc ExtHTML5.links#attr-hyperlink-type type} attribute.
    *
    * <p>
    * Hint for the type of the referenced resource.
    *
    * @param type The new value for this attribute.
    * @return This object (for method chaining).
    */
   public final A type(String type) {
      attr("type", type);
      return this;
   }


   //-----------------------------------------------------------------------------------------------------------------
   // Overridden methods
   //-----------------------------------------------------------------------------------------------------------------

   @Override /* HtmlElement */
   public final A _class(String _class) {
      super._class(_class);
      return this;
   }

   @Override /* HtmlElement */
   public final A id(String id) {
      super.id(id);
      return this;
   }

   @Override /* HtmlElement */
   public final A style(String style) {
      super.style(style);
      return this;
   }

   @Override /* HtmlElementMixed */
   public A children(Object...children) {
      super.children(children);
      return this;
   }

   @Override /* HtmlElementMixed */
   public A child(Object child) {
      super.child(child);
      return this;
   }
}