com.helger.html.hc.impl.HCEntityNode Maven / Gradle / Ivy

Go to download
/**
 * 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.html.hc.impl;

import javax.annotation.Nonnull;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.string.ToStringGenerator;
import com.helger.html.entity.EHTMLEntity;
import com.helger.html.entity.IHTMLEntity;
import com.helger.html.hc.IHCConversionSettingsToNode;
import com.helger.xml.microdom.IMicroEntityReference;
import com.helger.xml.microdom.MicroEntityReference;

/**
 * Represents an entity reference as HC node.
 *
 * @author Philip Helger
 */
public class HCEntityNode extends AbstractHCNode
{
  private final IHTMLEntity m_aEntity;
  private final String m_sPlainText;

  public HCEntityNode (@Nonnull final EHTMLEntity eEntity)
  {
    this (eEntity, eEntity.getCharString ());
  }

  public HCEntityNode (@Nonnull final IHTMLEntity aEntity, @Nonnull final String sPlainText)
  {
    ValueEnforcer.notNull (aEntity, "Entity");
    ValueEnforcer.notNull (sPlainText, "PlainText");
    m_aEntity = aEntity;
    m_sPlainText = sPlainText;
  }

  @Nonnull
  public IHTMLEntity getEntity ()
  {
    return m_aEntity;
  }

  @Override
  @Nonnull
  protected IMicroEntityReference internalConvertToMicroNode (@Nonnull final IHCConversionSettingsToNode aConversionSettings)
  {
    return new MicroEntityReference (m_aEntity.getEntityName ());
  }

  @Override
  @Nonnull
  public String getPlainText ()
  {
    return m_sPlainText;
  }

  @Override
  public String toString ()
  {
    return ToStringGenerator.getDerived (super.toString ())
                            .append ("entity", m_aEntity)
                            .append ("plainText", m_sPlainText)
                            .toString ();
  }

  @Nonnull
  public static HCEntityNode newNBSP ()
  {
    return new HCEntityNode (EHTMLEntity.nbsp, " ");
  }

  @Nonnull
  public static HCEntityNode newCopy ()
  {
    return new HCEntityNode (EHTMLEntity.copy, "©");
  }

  @Nonnull
  public static HCEntityNode newEuro ()
  {
    return new HCEntityNode (EHTMLEntity.euro, "€");
  }

  @Nonnull
  public static HCEntityNode newLeftArrow ()
  {
    return new HCEntityNode (EHTMLEntity.larr, "<-");
  }

  @Nonnull
  public static HCEntityNode newRightArrow ()
  {
    return new HCEntityNode (EHTMLEntity.rarr, "->");
  }

  @Nonnull
  public static HCEntityNode newUpArrow ()
  {
    return new HCEntityNode (EHTMLEntity.uarr, "^");
  }

  @Nonnull
  public static HCEntityNode newDownArrow ()
  {
    return new HCEntityNode (EHTMLEntity.darr, "v");
  }

  /**
   * @return dash of length "n"
   */
  @Nonnull
  public static HCEntityNode newNDash ()
  {
    return new HCEntityNode (EHTMLEntity.ndash, "-");
  }

  /**
   * @return soft hyphen
   */
  @Nonnull
  public static HCEntityNode newShy ()
  {
    return new HCEntityNode (EHTMLEntity.shy, "");
  }

  /**
   * @return per mille sign
   */
  @Nonnull
  public static HCEntityNode newPerMille ()
  {
    return new HCEntityNode (EHTMLEntity.permil, "‰");
  }
}