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.

  • Field Details

  • Constructor Details

    • Entities

      private Entities()

  • 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:

    • 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)

    • findPrefix

      public static String findPrefix(String input)
      Finds the longest base named entity that is a prefix of the input. That is, input "notit" would return "not".
      Returns:
      longest entity name that is a prefix of the input, or "" if no entity matches

    • escape

      public static String escape(String data, Document.OutputSettings out)
      HTML escape an input string. That is, < is returned as &lt;. The escaped string is suitable for use both in attributes and in text data.
      Parameters:
      data - the un-escaped string to escape
      out - the output settings to use. This configures the character set escaped against (that is, if a character is supported in the output character set, it doesn't have to be escaped), and also HTML or XML settings.
      Returns:
      the escaped string

    • escape

      public static String escape(String data)
      HTML escape an input string, using the default settings (UTF-8, base entities). That is, < is returned as &lt;. The escaped string is suitable for use both in attributes and in text data.
      Parameters:
      data - the un-escaped string to escape
      Returns:
      the escaped string
      See Also:

    • escapeString

      private static String escapeString(String data, Entities.EscapeMode escapeMode, Charset charset)

    • escape

      static void escape(QuietAppendable accum, String data, Document.OutputSettings out, int options)

    • doEscape

      private static void doEscape(String data, QuietAppendable accum, Entities.EscapeMode mode, Charset charset, int options)

    • appendEscaped

      private static void appendEscaped(int codePoint, QuietAppendable accum, int options, Entities.EscapeMode escapeMode, Entities.CoreCharset coreCharset, CharsetEncoder fallback)

    • appendNbsp

      private static void appendNbsp(QuietAppendable accum, Entities.EscapeMode escapeMode)

    • appendApos

      private static void appendApos(QuietAppendable accum, int options, Entities.EscapeMode escapeMode)

    • appendEncoded

      private static void appendEncoded(QuietAppendable accum, Entities.EscapeMode escapeMode, int codePoint)

    • 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

    • unescape

      static String unescape(String string, boolean strict)
      Unescape the input string.
      Parameters:
      string - to un-HTML-escape
      strict - if "strict" (that is, requires trailing ';' char, otherwise that's optional)
      Returns:
      unescaped string

    • canEncode

      private static boolean canEncode(Entities.CoreCharset charset, char c, CharsetEncoder fallback)

    • isValidXmlChar

      private static boolean isValidXmlChar(int codePoint)

    • encoderFor

      private static CharsetEncoder encoderFor(Charset charset)

    • load

      private static void load(Entities.EscapeMode e, String pointsData, int size)