com.hfg.xml.parser.AbstractEntities Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.xml.parser;

import com.hfg.util.StringUtil;
import com.hfg.util.collection.BiMap;


//------------------------------------------------------------------------------
/**
 Base lookup class for character entities.

 @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public abstract class AbstractEntities
{

   //---------------------------------------------------------------------------
   protected abstract BiMap getEntityMap();

   //---------------------------------------------------------------------------
   /**
    @param inCharEntity String such as 'nbsp' from the character entity '&nbsp;'
    @return String with the Numeric character representation (ex: '#160' given 'nbsp' as input).
    */
   public String getNumericEntity(String inCharEntity)
   {
      return getEntityMap().containsKey(inCharEntity) ? "#" + getEntityMap().get(inCharEntity) : null;
   }

   //---------------------------------------------------------------------------
   /**
    @param inCharEntity String such as 'nbsp' from the character entity '&nbsp;'
    @return String with the Numeric character representation (ex: '#xa0' given 'nbsp' as input).
    */
   public String getHexEntity(String inCharEntity)
   {
      String hexEntity = null;
      if (getEntityMap().containsKey(inCharEntity))
      {
         String hexString = Integer.toHexString(getEntityMap().get(inCharEntity));
         hexEntity = "#x" + (hexString.length() < 4 ? StringUtil.polyChar('0', 4 - hexString.length()) : "") + hexString;
      }

      return hexEntity;
   }

   //---------------------------------------------------------------------------
   /**
    @param inCharEntity String such as 'beta' from the character entity '&beta;'
    @return Unicode character representation (ex: 'β' given 'beta' as input).
    */
   public Character getUnicodeChar(String inCharEntity)
   {
      return getEntityMap().containsKey(inCharEntity) ? Character.toChars(getEntityMap().get(inCharEntity))[0] : null;
   }

   //---------------------------------------------------------------------------
   /**
    @param inNumericValue Numeric value for the Unicode character
    @return  String such as 'beta' from the character entity '&beta;'
    */
   public String getEntity(int inNumericValue)
   {
      return getEntityMap().containsValue(inNumericValue) ? getEntityMap().getKey(inNumericValue) : null;
   }

   //---------------------------------------------------------------------------
   /**
    @param inChar Unicode character representation
    @return  String such as 'beta' from the character entity '&beta;'
    */
   public String getEntity(char inChar)
   {
      return getEntity((int) inChar);
   }

}