org.mmbase.util.transformers

Class Xml

java.lang.Object

org.mmbase.util.transformers.StringTransformer

org.mmbase.util.transformers.ConfigurableStringTransformer

org.mmbase.util.transformers.Xml

All Implemented Interfaces:

Serializable, CharTransformer, ConfigurableTransformer, Transformer

public class Xml
extends ConfigurableStringTransformer
implements CharTransformer

Transformations related to escaping in XML.

Version:

$Id$

Author:

Michiel Meeuwissen, Kees Jongenburger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Xml	ATTRIBUTES
static int	ESCAPE
static int	ESCAPE_ATTRIBUTE
static int	ESCAPE_ATTRIBUTE_DOUBLE
static int	ESCAPE_ATTRIBUTE_HTML
static int	ESCAPE_ATTRIBUTE_SINGLE
static Xml	INSTANCE

Fields inherited from class org.mmbase.util.transformers.ConfigurableStringTransformer

to

Constructor Summary

Constructors

Constructor and Description
Xml()
Xml(int c)

Method Summary

Modifier and Type	Method and Description
String	getEncoding() Returns the encoding that is currently active
String	transform(String r)
String	transformBack(String r)
Map<String,Config>	transformers() Used when registering this class as a possible Transformer
static String	XMLAttributeEscape(String att) Attributes of XML tags cannot contain quotes, and also & must be escaped
static String	XMLAttributeEscape(String att, char quot) Attributes of XML tags cannot contain quotes, and also & must be escaped
static String	XMLEscape(String xml) Utility class for escaping and unescaping (XML)data
static void	XMLEscape(String xml, StringBuffer sb)
static void	XMLEscape(String xml, StringBuilder sb)
static String	XMLUnescape(String data) Utility class for escaping and unescaping (XML)data

Methods inherited from class org.mmbase.util.transformers.ConfigurableStringTransformer

configure, toString

Methods inherited from class org.mmbase.util.transformers.StringTransformer

transform, transform, transformBack, transformBack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mmbase.util.transformers.CharTransformer

transform, transform, transformBack, transformBack

Methods inherited from interface org.mmbase.util.transformers.Transformer

toString

Field Detail

ESCAPE

public static final int ESCAPE

See Also:

Constant Field Values

ESCAPE_ATTRIBUTE

public static final int ESCAPE_ATTRIBUTE

See Also:

Constant Field Values

ESCAPE_ATTRIBUTE_DOUBLE

public static final int ESCAPE_ATTRIBUTE_DOUBLE

See Also:

Constant Field Values

ESCAPE_ATTRIBUTE_SINGLE

public static final int ESCAPE_ATTRIBUTE_SINGLE

See Also:

Constant Field Values

ESCAPE_ATTRIBUTE_HTML

public static final int ESCAPE_ATTRIBUTE_HTML

See Also:

Constant Field Values

INSTANCE

public static final Xml INSTANCE

ATTRIBUTES

public static final Xml ATTRIBUTES

Constructor Detail

Xml

public Xml()

Xml

public Xml(int c)

Method Detail

transformers

public Map<String,Config> transformers()

Used when registering this class as a possible Transformer

Specified by:

transformers in interface ConfigurableTransformer

Specified by:

transformers in class ConfigurableStringTransformer

Returns:

A Map with String Integer/Class pairs.

XMLAttributeEscape

public static String XMLAttributeEscape(String att,
                                        char quot)

Attributes of XML tags cannot contain quotes, and also & must be escaped

Parameters:

att - String representing the attribute

quot - Which quote (either ' or ")

XMLAttributeEscape

public static String XMLAttributeEscape(String att)

Attributes of XML tags cannot contain quotes, and also & must be escaped

Parameters:

att - String representing the attribute

XMLEscape

public static String XMLEscape(String xml)

Utility class for escaping and unescaping (XML)data

Parameters:

xml - the xml to encode

Returns:

the encoded xml data

• & is replaced by &
• " is replaced by "
• < is replaced by &lt;
• > is replaced by &gt;

XMLEscape

public static void XMLEscape(String xml,
                             StringBuilder sb)

Since:

MMBase-1.9

XMLEscape

public static void XMLEscape(String xml,
                             StringBuffer sb)

Since:

MMBase-1.8

XMLUnescape

public static String XMLUnescape(String data)

Utility class for escaping and unescaping (XML)data

Parameters:

data - the data to decode to (html/xml) where

• & was replaced by &amp;
• " was replaced by &quot;
• < was replaced by &lt;
• > was replaced by &gt;

Returns:

the decoded xml data

transform

public String transform(String r)

Specified by:

transform in interface CharTransformer

Specified by:

transform in class StringTransformer

transformBack

public String transformBack(String r)

Specified by:

transformBack in interface CharTransformer

Overrides:

transformBack in class StringTransformer

getEncoding

public String getEncoding()

Description copied from interface: ConfigurableTransformer

Returns the encoding that is currently active

Specified by:

getEncoding in interface ConfigurableTransformer

Specified by:

getEncoding in class ConfigurableStringTransformer

Returns:

An String representing the coding that is currently used.