Enum HtmlEncoding

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<HtmlEncoding>

    public enum HtmlEncoding
    extends java.lang.Enum<HtmlEncoding>
    This enum defines HTML encodings.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALL_CHARACTERS
      Encode HTML special characters as per STANDARD, encode all other characters as decimal entities.
      ALL_CHARACTERS_DECIMAL
      Encode all characters as decimal entities.
      ALL_CHARACTERS_HEX
      Encode all characters as hex entities.
      STANDARD
      Encode only HTML special characters.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static HtmlEncoding valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static HtmlEncoding[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • STANDARD

        public static final HtmlEncoding STANDARD
        Encode only HTML special characters.
      • ALL_CHARACTERS

        public static final HtmlEncoding ALL_CHARACTERS
        Encode HTML special characters as per STANDARD, encode all other characters as decimal entities.
      • ALL_CHARACTERS_DECIMAL

        public static final HtmlEncoding ALL_CHARACTERS_DECIMAL
        Encode all characters as decimal entities.
      • ALL_CHARACTERS_HEX

        public static final HtmlEncoding ALL_CHARACTERS_HEX
        Encode all characters as hex entities.
    • Method Detail

      • values

        public static HtmlEncoding[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (HtmlEncoding c : HtmlEncoding.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static HtmlEncoding valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null