/*
    * Copyright 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.resteasy.hypermedia.renderer;
  
  import java.io.Serializable;
  
  import org.apache.commons.lang3.builder.ToStringBuilder;
  
  /**
   * Provides link metadata that describes the link.
   *
   * @see <a href="http://dev.w3.org/html5/markup/a.html">a – hyperlink</a>
   * @see <a
   *      href="http://dev.w3.org/html5/markup/aria/common-attributes.html">Common
   *      Attributes</a>
   */
  public class LinkMetadata implements Serializable, Cloneable
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The identifier of the link.
     *
     * @see <a
     *      href="http://dev.w3.org/html5/markup/aria/common-attributes.html#common.attrs.id">id</a>
     */
    private String id;
  
    /**
     * The CSS class information to the link.
     */
    private String cssClass;
  
    /**
     * The key label or list of key labels with which to associate the element;
     * each key label represents a keyboard shortcut which UAs can use to activate
     * the element or give focus to the element.
     * <p>
     * An ordered set of unique space-separated tokens, each of which must be
     * exactly one Unicode code point in length.
     * </p>
     *
     * @see <a href="http://dev.w3.org/html5/markup/global-attributes.html">global
     *      attributes</a>
     */
    private String accessKey;
  
    /**
     * The tab index.
     * <p>
     * Specifies whether the element represents an element that is is focusable
     * (that is, an element which is part of the sequence of focusable elements in
     * the document), and the relative order of the element in the sequence of
     * focusable elements in the document.
     * </p>
     *
     * @see <a href="http://dev.w3.org/html5/markup/global-attributes.html">global
     *      attributes</a>
     */
    private Integer tabIndex;
  
    /**
     * The advisory information associated with the element.
     *
     * @see <a href="http://dev.w3.org/html5/markup/global-attributes.html">global
     *      attributes</a>
     */
    private String title;
  
    /**
     * The element’s text directionality.
     *
     * @see <a href="http://dev.w3.org/html5/markup/global-attributes.html">global
     *      attributes</a>
     */
   private String dir;
 
   /**
    * The hidden flag to specify that the element represents an element that is
    * not yet, or is no longer, relevant.
    *
    * @see <a href="http://dev.w3.org/html5/markup/global-attributes.html">global
    *      attributes</a>
    */
   private Boolean hidden;
 
   /**
    * The standard label to be rendered as the visible part of the link.
    */
   private String label;
 
   /**
    * A short version of the label to be rendered in confined space.
    */
   private String shortLabel;
 
   /**
    * The detailed help information on the link.
    */
   private String help;
 
   /**
    * The name or keyword giving a browsing context for UAs to use when following
    * the hyperlink.
    *
    * @see <a
    *      href="http://dev.w3.org/html5/markup/a.html#a.attrs.target">target</a>
    */
   private String target;
 
   /**
    * The media for which the destination of the hyperlink was designed.
    * <p>
    * Values are according to <a
    * href="http://www.w3.org/TR/2009/CR-css3-mediaqueries-20090915/">Media
    * Queries</a>.
    * </p>
    *
    * @see <a
    *      href="http://dev.w3.org/html5/markup/a.html#a.attrs.media">media</a>
    */
   private String media;
 
   /**
    * The identifier of a menu with which to associate the element as a context
    * menu.
    *
    * @see <a
    *      href="http://dev.w3.org/html5/markup/aria/common-attributes.html#common.attrs.contextmenu">contextmenu</a>
    */
   private String contextMenu;
 
   // ****************************** Initializer *******************************
 
   // ****************************** Constructors ******************************
 
   /**
    * Default constructor.
    */
   public LinkMetadata()
   {
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the identifier of the link.
    *
    * @return the identifier of the link.
    */
   public String getId()
   {
     return id;
   }
 
   /**
    * Sets the identifier of the link.
    *
    * @param id the identifier of the link.
    */
   public void setId(final String id)
   {
     this.id = id;
   }
 
   /**
    * Returns the CSS class information to the link.
    *
    * @return the CSS class information to the link.
    */
   public String getCssClass()
   {
     return cssClass;
   }
 
   /**
    * Sets the CSS class information to the link.
    *
    * @param cssClass the CSS class information to the link.
    */
   public void setCssClass(final String cssClass)
   {
     this.cssClass = cssClass;
   }
 
   /**
    * Returns the key label or list of key labels with which to associate the
    * element; each key label represents a keyboard shortcut which UAs can use to
    * activate the element or give focus to the element.
    * <p>
    * An ordered set of unique space-separated tokens, each of which must be
    * exactly one Unicode code point in length.
    * </p>
    *
    * @return the key label or list of key labels with which to associate the
    *         element; each key label represents a keyboard shortcut which UAs
    *         can use to activate the element or give focus to the element.
    */
   public String getAccessKey()
   {
     return accessKey;
   }
 
   /**
    * Sets the key label or list of key labels with which to associate the
    * element; each key label represents a keyboard shortcut which UAs can use to
    * activate the element or give focus to the element.
    * <p>
    * An ordered set of unique space-separated tokens, each of which must be
    * exactly one Unicode code point in length.
    * </p>
    *
    * @param accessKey the key label or list of key labels with which to
    *          associate the element; each key label represents a keyboard
    *          shortcut which UAs can use to activate the element or give focus
    *          to the element.
    */
   public void setAccessKey(final String accessKey)
   {
     this.accessKey = accessKey;
   }
 
   /**
    * Returns the tab index.
    * <p>
    * Specifies whether the element represents an element that is is focusable
    * (that is, an element which is part of the sequence of focusable elements in
    * the document), and the relative order of the element in the sequence of
    * focusable elements in the document.
    * </p>
    *
    * @return the tab index.
    */
   public Integer getTabIndex()
   {
     return tabIndex;
   }
 
   /**
    * Sets the tab index.
    * <p>
    * Specifies whether the element represents an element that is is focusable
    * (that is, an element which is part of the sequence of focusable elements in
    * the document), and the relative order of the element in the sequence of
    * focusable elements in the document.
    * </p>
    *
    * @param tabIndex the tab index.
    */
   public void setTabIndex(final Integer tabIndex)
   {
     this.tabIndex = tabIndex;
   }
 
   /**
    * Returns the advisory information associated with the element.
    *
    * @return the advisory information associated with the element.
    */
   public String getTitle()
   {
     return title;
   }
 
   /**
    * Sets the advisory information associated with the element.
    *
    * @param title the advisory information associated with the element.
    */
   public void setTitle(final String title)
   {
     this.title = title;
   }
 
   /**
    * Returns the element’s text directionality.
    *
    * @return the element’s text directionality.
    */
   public String getDir()
   {
     return dir;
   }
 
   /**
    * Sets the element’s text directionality.
    *
    * @param dir the element’s text directionality.
    */
   public void setDir(final String dir)
   {
     this.dir = dir;
   }
 
   /**
    * Returns the hidden flag to specify that the element represents an element
    * that is not yet, or is no longer, relevant.
    *
    * @return the hidden flag to specify that the element represents an element
    *         that is not yet, or is no longer, relevant.
    */
   public Boolean isHidden()
   {
     return hidden;
   }
 
   /**
    * Sets the hidden flag to specify that the element represents an element that
    * is not yet, or is no longer, relevant.
    *
    * @param hidden the hidden flag to specify that the element represents an
    *          element that is not yet, or is no longer, relevant.
    */
   public void setHidden(final Boolean hidden)
   {
     this.hidden = hidden;
   }
 
   /**
    * Returns the standard label to be rendered as the visible part of the link.
    *
    * @return the standard label to be rendered as the visible part of the link.
    */
   public String getLabel()
   {
     return label;
   }
 
   /**
    * Sets the standard label to be rendered as the visible part of the link.
    *
    * @param label the standard label to be rendered as the visible part of the
    *          link.
    */
   public void setLabel(final String label)
   {
     this.label = label;
   }
 
   /**
    * Returns a short version of the label to be rendered in confined space.
    *
    * @return a short version of the label to be rendered in confined space.
    */
   public String getShortLabel()
   {
     return shortLabel;
   }
 
   /**
    * Sets a short version of the label to be rendered in confined space.
    *
    * @param shortLabel a short version of the label to be rendered in confined
    *          space.
    */
   public void setShortLabel(final String shortLabel)
   {
     this.shortLabel = shortLabel;
   }
 
   /**
    * Returns the detailed help information on the link.
    *
    * @return the detailed help information on the link.
    */
   public String getHelp()
   {
     return help;
   }
 
   /**
    * Sets the detailed help information on the link.
    *
    * @param help the detailed help information on the link.
    */
   public void setHelp(final String help)
   {
     this.help = help;
   }
 
   /**
    * Returns the name or keyword giving a browsing context for UAs to use when
    * following the hyperlink.
    *
    * @return the name or keyword giving a browsing context for UAs to use when
    *         following the hyperlink.
    */
   public String getTarget()
   {
     return target;
   }
 
   /**
    * Sets the name or keyword giving a browsing context for UAs to use when
    * following the hyperlink.
    *
    * @param target the name or keyword giving a browsing context for UAs to use
    *          when following the hyperlink.
    */
   public void setTarget(final String target)
   {
     this.target = target;
   }
 
   /**
    * Returns the media for which the destination of the hyperlink was designed.
    * <p>
    * Values are according to <a
    * href="http://www.w3.org/TR/2009/CR-css3-mediaqueries-20090915/">Media
    * Queries</a>.
    * </p>
    *
    * @return the media for which the destination of the hyperlink was designed.
    */
   public String getMedia()
   {
     return media;
   }
 
   /**
    * Sets the media for which the destination of the hyperlink was designed.
    * <p>
    * Values are according to <a
    * href="http://www.w3.org/TR/2009/CR-css3-mediaqueries-20090915/">Media
    * Queries</a>.
    * </p>
    *
    * @param media the media for which the destination of the hyperlink was
    *          designed.
    */
   public void setMedia(final String media)
   {
     this.media = media;
   }
 
   /**
    * Returns the identifier of a menu with which to associate the element as a
    * context menu.
    *
    * @return the identifier of a menu with which to associate the element as a
    *         context menu.
    */
   public String getContextMenu()
   {
     return contextMenu;
   }
 
   /**
    * Sets the identifier of a menu with which to associate the element as a
    * context menu.
    *
    * @param contextMenu the identifier of a menu with which to associate the
    *          element as a context menu.
    */
   public void setContextMenu(final String contextMenu)
   {
     this.contextMenu = contextMenu;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
   /**
    * Returns a shallow copy of the object.
    *
    * @return a shallow copy.
    */
   @Override
   public Object clone()
   {
     try
     {
       return super.clone();
     }
     catch (final CloneNotSupportedException e)
     {
       throw new AssertionError(); // cannot happen!
     }
   }
 
   /**
    * {@inheritDoc}
    * <p>
    * Provides the properties via reflection for displaying debug information.
    * </p>
    *
    * @see java.lang.Object#toString()
    */
   @Override
   public String toString()
   {
     return ToStringBuilder.reflectionToString(this);
   }
 }