Module org.tquadrat.foundation.util
Package org.tquadrat.foundation.util.internal

Class Entities

java.lang.Object
org.tquadrat.foundation.util.internal.Entities
@ClassVersion(sourceVersion="$Id: Entities.java 1060 2023-09-24 19:21:40Z tquadrat $") @API(status=INTERNAL, since="0.0.5") public final class Entities extends Object
Provides HTML and XML entity utilities.
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Thanks to:
Alexander Day Chaffee (alex@purpletech.com), Gary Gregory (ggregory@seagullsw.com)
Version:
$Id: Entities.java 1060 2023-09-24 19:21:40Z tquadrat $
Since:
0.0.5
See Also:
Inspired through:
Some code I found somewhere long time ago, originally written by Alexander Day Chaffee and Gary Gregory
UML Diagram
UML Diagram for "org.tquadrat.foundation.util.internal.Entities"⁠

UML Diagram for "org.tquadrat.foundation.util.internal.Entities"

UML Diagram for "org.tquadrat.foundation.util.internal.Entities"⁠

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    private static interface 
    Entities.EntityMap
    Local interface for the data structure that is used to store the entity mappings.
    private static class 
    Entities.PrimitiveEntityMap
    A simple implementation for the interface Entities.EntityMap.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ADDITIONAL_XML_ENTITIES
    The name for the resource file that holds the additional XML entities: "apos_entities.data".
    static final Entities
    BASIC
    The set of basic entities.
    static final String
    BASIC_ENTITIES
    The name for the resource file that holds the basic entities that are common for both XML and HTML: "basic_entities.data".
    static final Entities
    HTML32
    The set of entities supported by HTML 3.2.
    static final String
    HTML32_ENTITIES
    The name for the resource final that holds the entities that were introduced for HTML 3.2: "ISO8859_1_entities.data".
    static final Entities
    HTML40
    The set of entities supported by HTML 4.0.
    static final String
    HTML40_ENTITIES
    The name for the resource final that holds the entities that were introduced for HTML 4.0: "html40_entities.data".
    static final Entities
    HTML50
    The set of entities supported by HTML 5.0.
    static final String
    HTML50_ENTITIES
    The name for the resource final that holds the entities that were introduced for HTML 5.0: "html50_entities.data".
    private final Lazy<Entities.EntityMap>
    m_EntityMap
    The entity mapping.
    static final Entities
    XML
    The set of entities supported by standard XML.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Entities(String... resourceNames)
    Creates a new Entities instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    private void
    doUnescape(Appendable buffer, CharSequence source, int firstAmp)
    Underlying unescape method that allows the optimisation of not starting from the 0 index again.
    final Optional<String>
    entityName(int value)
    Returns the name of the entity identified by the specified value.
    final Optional<Integer>
    entityValue(String name)
    Returns the value of the entity identified by the specified name.
    final void
    escape(Appendable appendable, CharSequence input)
    Escapes the characters in the String passed and writes the result to the Appendable passed.
    final String
    escape(CharSequence source)
    Escapes the characters in a String.

    For example, if you have called addEntity( "foo", "0xA1" ), a call to escape( "¡" ) will return "&foo;".
    private static final String
    formatCodePoint(int codePoint)
    Converts a code point into the numerical HTML escape format.
    final String[]
    listEntities()
    Returns a list of all known entities.
    private static void
    loadEntities(Entities.EntityMap entityMap, URL resourceURL)
    Load the entities from the resource identified by the given URL to the given target entity map.
    private static void
    parseAndAdd(Entities.EntityMap entityMap, String inputLine)
    Parses the given input line for an entity name and the related code point, and adds both to the given entity map.
    final void
    unescape(Appendable appendable, CharSequence input)
    Unescapes the escaped entities in the String passed and writes the result to the Appendable passed.
    final String
    unescape(CharSequence input)
    Unescapes the entities in a String.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • ADDITIONAL_XML_ENTITIES

      public static final String ADDITIONAL_XML_ENTITIES
      The name for the resource file that holds the additional XML entities: "apos_entities.data". These entities are not defined for HTML before HTML 5.
      See Also:

    • BASIC_ENTITIES

      public static final String BASIC_ENTITIES
      The name for the resource file that holds the basic entities that are common for both XML and HTML: "basic_entities.data".
      See Also:

    • HTML32_ENTITIES

      public static final String HTML32_ENTITIES
      The name for the resource final that holds the entities that were introduced for HTML 3.2: "ISO8859_1_entities.data".
      See Also:

    • HTML40_ENTITIES

      public static final String HTML40_ENTITIES
      The name for the resource final that holds the entities that were introduced for HTML 4.0: "html40_entities.data".
      See Also:

    • HTML50_ENTITIES

      public static final String HTML50_ENTITIES
      The name for the resource final that holds the entities that were introduced for HTML 5.0: "html50_entities.data".
      See Also:

    • m_EntityMap

      private final Lazy<Entities.EntityMap> m_EntityMap
      The entity mapping.

    • BASIC

      public static final Entities BASIC
      The set of basic entities.

    • HTML32

      public static final Entities HTML32
      The set of entities supported by HTML 3.2.

    • HTML40

      public static final Entities HTML40
      The set of entities supported by HTML 4.0.

    • HTML50

      public static final Entities HTML50
      The set of entities supported by HTML 5.0.

    • XML

      public static final Entities XML
      The set of entities supported by standard XML.

  • Constructor Details

    • Entities

      private Entities(String... resourceNames)
      Creates a new Entities instance.
      Parameters:
      resourceNames - The names of the resource files with the entity definitions.

  • Method Details

    • doUnescape

      private void doUnescape(Appendable buffer, CharSequence source, int firstAmp) throws IOException
      Underlying unescape method that allows the optimisation of not starting from the 0 index again.
      Parameters:
      buffer - The buffer to write the results to.
      source - The source String to unescape.
      firstAmp - The index of the first ampersand in the source.
      Throws:
      IOException - Problems on writing to the buffer.

    • entityName

      public final Optional<String> entityName(int value)
      Returns the name of the entity identified by the specified value.
      Parameters:
      value - The value to locate.
      Returns:
      An instance of Optional that holds the entity name that is associated with the specified value.

    • entityValue

      public final Optional<Integer> entityValue(String name)
      Returns the value of the entity identified by the specified name.
      Parameters:
      name - The name to locate.
      Returns:
      An instance of Optional that holds the entity value associated with the specified name.

    • escape

      public final String escape(CharSequence source)
      Escapes the characters in a String.

      For example, if you have called addEntity( "foo", "0xA1" ), a call to escape( "¡" ) will return "&foo;".
      Parameters:
      source - The String to escape.
      Returns:
      A new escaped String.

    • escape

      public final void escape(Appendable appendable, CharSequence input) throws IOException
      Escapes the characters in the String passed and writes the result to the Appendable passed.
      Parameters:
      appendable - The Appendable to write the results of the escaping to.
      input - The String to escape.
      Throws:
      IOException - when Appendable passed throws the exception from calls to the Appendable.append(char) method.
      See Also:

    • formatCodePoint

      private static final String formatCodePoint(int codePoint)
      Converts a code point into the numerical HTML escape format.
      Parameters:
      codePoint - The code point.
      Returns:
      The HTML escaped code point.

    • listEntities

      public final String[] listEntities()
      Returns a list of all known entities.
      Returns:
      An array of String with the entities, there numerical values and the Unicode name of the entity.

    • loadEntities

      private static void loadEntities(Entities.EntityMap entityMap, URL resourceURL)
      Load the entities from the resource identified by the given URL to the given target entity map.
      Parameters:
      entityMap - The map that is the target for the entities.
      resourceURL - The URL for the resource.

    • parseAndAdd

      private static void parseAndAdd(Entities.EntityMap entityMap, String inputLine)
      Parses the given input line for an entity name and the related code point, and adds both to the given entity map.
      Parameters:
      entityMap - The map that is the target for the entities.
      inputLine - The input line.

    • unescape

      public final String unescape(CharSequence input)

      Unescapes the entities in a String.

      For example, if you have called addEntity( "foo", 0xA1 ), a call to unescape( "&foo;") will return "¡".

      Parameters:
      input - The String to escape.
      Returns:
      A new escaped String.

    • unescape

      public final void unescape(Appendable appendable, CharSequence input) throws IOException
      Unescapes the escaped entities in the String passed and writes the result to the Appendable passed.
      Parameters:
      appendable - The Appendable to write the results to.
      input - The source String to unescape.
      Throws:
      IOException - when Appendable passed throws the exception from calls to the Appendable.append(char) method.
      See Also: