Package org.jsoup.nodes

Class Entities

java.lang.Object
org.jsoup.nodes.Entities
public class Entities
extends Object
HTML entities, and escape routines. Source: W3C HTML named character references.

  • Method Details

    • isNamedEntity

      public static boolean isNamedEntity​(String name)
      Check if the input is a known named entity
      Parameters:
      name - the possible entity name (e.g. "lt" or "amp")
      Returns:
      true if a known named entity

    • isBaseNamedEntity

      public static boolean isBaseNamedEntity​(String name)
      Check if the input is a known named entity in the base entity set.
      Parameters:
      name - the possible entity name (e.g. "lt" or "amp")
      Returns:
      true if a known named entity in the base set
      See Also:
      isNamedEntity(String)

    • getCharacterByName

      public static Character getCharacterByName​(String name)
      Deprecated.
      does not support characters outside the BMP or multiple character names
      Get the Character value of the named entity
      Parameters:
      name - named entity (e.g. "lt" or "amp")
      Returns:
      the Character value of the named entity (e.g. '<' or '&')

    • getByName

      public static String getByName​(String name)
      Get the character(s) represented by the named entity
      Parameters:
      name - entity (e.g. "lt" or "amp")
      Returns:
      the string value of the character(s) represented by this entity, or "" if not defined

    • codepointsForName

      public static int codepointsForName​(String name, int[] codepoints)

    • escape

      public static String escape​(String string, Document.OutputSettings out)
      HTML escape an input string. That is, < is returned as &lt;
      Parameters:
      string - the un-escaped string to escape
      out - the output settings to use
      Returns:
      the escaped string

    • escape

      public static String escape​(String string)
      HTML escape an input string, using the default settings (UTF-8, base entities). That is, < is returned as &lt;
      Parameters:
      string - the un-escaped string to escape
      Returns:
      the escaped string

    • unescape

      public static String unescape​(String string)
      Un-escape an HTML escaped string. That is, &lt; is returned as <.
      Parameters:
      string - the HTML string to un-escape
      Returns:
      the unescaped string