java.lang.Object
- java.lang.Enum<EPlaceholderEscaper>
- - de.xima.fc.mdl.enums.EPlaceholderEscaper

All Implemented Interfaces:

IPlaceholderEscaper, Serializable, Comparable<EPlaceholderEscaper>
```
public enum EPlaceholderEscaper
extends Enum<EPlaceholderEscaper>
implements IPlaceholderEscaper
```
Enumeration of several common IPlaceholderEscaper implementations.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants
Enum Constant	Description
`CDATA`	Encodes the value of all placeholders for an XML CDATA section.
`CDATA_FORM_ONLY`	Encodes the value of form placeholders for an XML CDATA section.
`COMMA_SEPARATED_VALUES`	Encodes the value of form placeholders for CSV fields (comma separated).
`COMMA_SEPARATED_VALUES_FORM_ONLY`	Encodes the value of form placeholders for CSV fields (comma separated).
`HTML`	Encodes the value of all placeholders for (X)HTML text content and text attributes.
`HTML_FORM_ONLY`	Encodes the value of form placeholders for (X)HTML text content and text attributes.
`ICAL_FORM_ONLY`	Encodes the value of form placeholders so that they are safe to be used inside property values of an ICAL file.
`JSON`	Encodes the value of form placeholders for JSON values.
`JSON_FORM_ONLY`	Encodes the value of form placeholders for JSON values (form only).
`PATH`	Encodes the value of all placeholders for use as a file system path.
`PATH_FORM_ONLY`	Encodes the value of form placeholders for use as a file system path.
`PATH_SEGMENT`	Encodes the value of all placeholders for use as a file system path segment, i.e. strips all path separators and other meta characters (periods etc.).
`PATH_SEGMENT_FORM_ONLY`	Encodes the value of form placeholders for use as a file system path segment, i.e. strips all path separators and other meta characters (periods etc.).
`PLAIN_TEXT`	Performs no encoding and inserts the placeholder value as-is.
`SEMICOLON_SEPARATED_VALUES`	Encodes the value of form placeholders for CSV fields (semicolon separated).
`SEMICOLON_SEPARATED_VALUES_FORM_ONLY`	Encodes the value of form placeholders for CSV fields (semicolon separated).
`SLASH_SEPARATED_PATH`	Encodes the value of all placeholders for use as a slash separated path.A slash separated path is a path where the individual parts are separated by `/` characters, `.` and `..` are path navigators; and no other characters have special meaning.
`SLASH_SEPARATED_PATH_SEGMENT`	Encodes the value of all placeholders for use as a slash separated segment.
`URI_COMPONENT`	Encodes the value of all placeholders via percent-encoding for a component of a URI.
`URI_COMPONENT_FORM_ONLY`	Encodes the value of form placeholders via percent-encoding for a component of a URI.
`XML`	Encodes the value of all placeholders for XML and XHTML.
`XML_FORM_ONLY`	Encodes the value of form placeholders for XML and XHTML.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static String`	`escapeForCsv(String text, String fieldSeparator, String quoteMark)`
`static EPlaceholderEscaper`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static EPlaceholderEscaper[]`	`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

Methods inherited from interface de.xima.fc.interfaces.placeholder.params.IPlaceholderEscaper
escape

- Enum Constant Detail
  - CDATA
```
public static final EPlaceholderEscaper CDATA
```
    Encodes the value of all placeholders for an XML CDATA section.
  - CDATA_FORM_ONLY
```
public static final EPlaceholderEscaper CDATA_FORM_ONLY
```
    Encodes the value of form placeholders for an XML CDATA section.
  - COMMA_SEPARATED_VALUES
```
public static final EPlaceholderEscaper COMMA_SEPARATED_VALUES
```
    Encodes the value of form placeholders for CSV fields (comma separated).
  - COMMA_SEPARATED_VALUES_FORM_ONLY
```
public static final EPlaceholderEscaper COMMA_SEPARATED_VALUES_FORM_ONLY
```
    Encodes the value of form placeholders for CSV fields (comma separated).
  - HTML
```
public static final EPlaceholderEscaper HTML
```
    Encodes the value of all placeholders for (X)HTML text content and text attributes.
  - HTML_FORM_ONLY
```
public static final EPlaceholderEscaper HTML_FORM_ONLY
```
    Encodes the value of form placeholders for (X)HTML text content and text attributes.
  - ICAL_FORM_ONLY
```
public static final EPlaceholderEscaper ICAL_FORM_ONLY
```
    Encodes the value of form placeholders so that they are safe to be used inside property values of an ICAL file. To use the special characters comma, colon, semicolon, the value MUST be surrounded by double quotes (as no escaping mechanism is defined for these characters).
  - JSON
```
public static final EPlaceholderEscaper JSON
```
    Encodes the value of form placeholders for JSON values.
  - JSON_FORM_ONLY
```
public static final EPlaceholderEscaper JSON_FORM_ONLY
```
    Encodes the value of form placeholders for JSON values (form only).
  - PATH
```
public static final EPlaceholderEscaper PATH
```
    Encodes the value of all placeholders for use as a file system path. Allows path separators inside the value, but strips relative path navigators (periods).
  - PATH_FORM_ONLY
```
public static final EPlaceholderEscaper PATH_FORM_ONLY
```
    Encodes the value of form placeholders for use as a file system path. Allows path separators inside the value, but strips relative path navigators (periods).
  - PATH_SEGMENT
```
public static final EPlaceholderEscaper PATH_SEGMENT
```
    Encodes the value of all placeholders for use as a file system path segment, i.e. strips all path separators and other meta characters (periods etc.).
  - PATH_SEGMENT_FORM_ONLY
```
public static final EPlaceholderEscaper PATH_SEGMENT_FORM_ONLY
```
    Encodes the value of form placeholders for use as a file system path segment, i.e. strips all path separators and other meta characters (periods etc.).
  - PLAIN_TEXT
```
public static final EPlaceholderEscaper PLAIN_TEXT
```
    Performs no encoding and inserts the placeholder value as-is.
  - SEMICOLON_SEPARATED_VALUES
```
public static final EPlaceholderEscaper SEMICOLON_SEPARATED_VALUES
```
    Encodes the value of form placeholders for CSV fields (semicolon separated).
  - SEMICOLON_SEPARATED_VALUES_FORM_ONLY
```
public static final EPlaceholderEscaper SEMICOLON_SEPARATED_VALUES_FORM_ONLY
```
    Encodes the value of form placeholders for CSV fields (semicolon separated).
  - SLASH_SEPARATED_PATH
```
public static final EPlaceholderEscaper SLASH_SEPARATED_PATH
```
    Encodes the value of all placeholders for use as a slash separated path.A slash separated path is a path where the individual parts are separated by / characters, . and .. are path navigators; and no other characters have special meaning. E.g. a/?/#/%/../% represents the four segments a, ?, #, %. Allows path separators (slashes) inside the value, but strips relative path navigators (periods).
  - SLASH_SEPARATED_PATH_SEGMENT
```
public static final EPlaceholderEscaper SLASH_SEPARATED_PATH_SEGMENT
```
    Encodes the value of all placeholders for use as a slash separated segment. A slash separated path is a path where the individual parts are separated by / characters, . and .. are path navigators; and no other characters have special meaning. E.g. a/?/#/%/../% represents the four segments a, ?, #, %. This strips dots and slashes from the value.
  - URI_COMPONENT
```
public static final EPlaceholderEscaper URI_COMPONENT
```
    Encodes the value of all placeholders via percent-encoding for a component of a URI.
  - URI_COMPONENT_FORM_ONLY
```
public static final EPlaceholderEscaper URI_COMPONENT_FORM_ONLY
```
    Encodes the value of form placeholders via percent-encoding for a component of a URI.
  - XML
```
public static final EPlaceholderEscaper XML
```
    Encodes the value of all placeholders for XML and XHTML.
  - XML_FORM_ONLY
```
public static final EPlaceholderEscaper XML_FORM_ONLY
```
    Encodes the value of form placeholders for XML and XHTML.
- Method Detail
  - values
```
public static EPlaceholderEscaper[] 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 (EPlaceholderEscaper c : EPlaceholderEscaper.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EPlaceholderEscaper valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - escapeForCsv
```
public static String escapeForCsv(String text,
                                  String fieldSeparator,
                                  String quoteMark)
```

Enum EPlaceholderEscaper

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface de.xima.fc.interfaces.placeholder.params.IPlaceholderEscaper

Enum Constant Detail

CDATA

CDATA_FORM_ONLY

COMMA_SEPARATED_VALUES

COMMA_SEPARATED_VALUES_FORM_ONLY

HTML

HTML_FORM_ONLY

ICAL_FORM_ONLY

JSON

JSON_FORM_ONLY

PATH

PATH_FORM_ONLY

PATH_SEGMENT

PATH_SEGMENT_FORM_ONLY

PLAIN_TEXT

SEMICOLON_SEPARATED_VALUES

SEMICOLON_SEPARATED_VALUES_FORM_ONLY

SLASH_SEPARATED_PATH

SLASH_SEPARATED_PATH_SEGMENT

URI_COMPONENT

URI_COMPONENT_FORM_ONLY

XML

XML_FORM_ONLY

Method Detail

values

valueOf

escapeForCsv