Package fr.opensagres.xdocreport.core.utils

Class StringEscapeUtils.Entities

java.lang.Object
fr.opensagres.xdocreport.core.utils.StringEscapeUtils.Entities
Enclosing class:
StringEscapeUtils
public static class StringEscapeUtils.Entities extends Object

Provides HTML and XML entity utilities.

Since:
2.0
Version:
$Id: Entities.java 636641 2008-03-13 06:11:30Z bayard $
Author:
Alexander Day Chaffee, Gary Gregory
See Also:

  • Field Details

  • Constructor Details

    • Entities

      public Entities()

  • Method Details

    • addEntities

      public void addEntities(String[][] entityArray)

      Adds entities to this entity.

      Parameters:
      entityArray - array of entities to be added

    • addEntity

      public void addEntity(String name, int value)

      Add an entity to this entity.

      Parameters:
      name - name of the entity
      value - vale of the entity

    • entityName

      public String entityName(int value)

      Returns the name of the entity identified by the specified value.

      Parameters:
      value - the value to locate
      Returns:
      entity name associated with the specified value

    • entityValue

      public int entityValue(String name)

      Returns the value of the entity identified by the specified name.

      Parameters:
      name - the name to locate
      Returns:
      entity value associated with the specified name

    • escape

      public String escape(String str)

      Escapes the characters in a String.

      For example, if you have called addEntity("foo", 0xA1), escape("¡") will return "&foo;"

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

    • escape

      public void escape(Writer writer, String str) throws IOException

      Escapes the characters in the String passed and writes the result to the Writer passed.

      Parameters:
      writer - The Writer to write the results of the escaping to. Assumed to be a non-null value.
      str - The String to escape. Assumed to be a non-null value.
      Throws:
      IOException - when Writer passed throws the exception from calls to the Writer.write(int) methods.
      See Also:

    • unescape

      public String unescape(String str)

      Unescapes the entities in a String.

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

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

    • unescape

      public void unescape(Writer writer, String str) throws IOException

      Unescapes the escaped entities in the String passed and writes the result to the Writer passed.

      Parameters:
      writer - The Writer to write the results to; assumed to be non-null.
      str - The source String to unescape; assumed to be non-null.
      Throws:
      IOException - when Writer passed throws the exception from calls to the Writer.write(int) methods.
      See Also:

    • generateDocType

      public String generateDocType(String docTypeName)