Enum EncodingPatternConverter.EscapeFormat
- java.lang.Object
-
- java.lang.Enum<EncodingPatternConverter.EscapeFormat>
-
- org.apache.logging.log4j.core.pattern.EncodingPatternConverter.EscapeFormat
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<EncodingPatternConverter.EscapeFormat>
- Enclosing class:
- EncodingPatternConverter
private static enum EncodingPatternConverter.EscapeFormat extends java.lang.Enum<EncodingPatternConverter.EscapeFormat>
-
-
Constructor Summary
Constructors Modifier Constructor Description private
EscapeFormat()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description (package private) abstract void
escape(java.lang.StringBuilder toAppendTo, int start)
Escapes text using a standardized format from a given starting point to the end of the string.static EncodingPatternConverter.EscapeFormat
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static EncodingPatternConverter.EscapeFormat[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
HTML
public static final EncodingPatternConverter.EscapeFormat HTML
-
JSON
public static final EncodingPatternConverter.EscapeFormat JSON
JSON string escaping as defined in RFC 4627.- See Also:
- RFC 4627
-
CRLF
public static final EncodingPatternConverter.EscapeFormat CRLF
-
XML
public static final EncodingPatternConverter.EscapeFormat XML
XML string escaping as defined in XML specification.- See Also:
- XML specification
-
-
Method Detail
-
values
public static EncodingPatternConverter.EscapeFormat[] 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 (EncodingPatternConverter.EscapeFormat c : EncodingPatternConverter.EscapeFormat.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static EncodingPatternConverter.EscapeFormat 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 namejava.lang.NullPointerException
- if the argument is null
-
escape
abstract void escape(java.lang.StringBuilder toAppendTo, int start)
Escapes text using a standardized format from a given starting point to the end of the string.- Parameters:
toAppendTo
- string buffer to escapestart
- where to start escaping from
-
-