org.key_project.util.java

Class XMLUtil

java.lang.Object

org.key_project.util.java.XMLUtil

public final class XMLUtil
extends java.lang.Object

Provides static methods to work with XML.

Author:

Martin Hentschel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLUtil.HTMLRendererReplacer This XMLUtil.ITagReplacer can be used to render HTML into a plain text.
static interface	XMLUtil.ITagReplacer Instances of this interface are used in replaceTags(String, ITagReplacer) to replace an individual found tag.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_ENCODING Attribute name to store encodings.
static java.lang.String	LEADING_WHITE_SPACE_PER_LEVEL The used leading white space in each level.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	XMLUtil() Forbid instances.

Method Summary

Modifier and Type	Method and Description
static void	appendAttribute(java.lang.String attributeName, java.lang.String value, java.lang.StringBuffer sb) Adds an XML attribute to the given StringBuffer.
static void	appendEmptyTag(int level, java.lang.String tagName, java.util.Map<java.lang.String,java.lang.String> attributeValues, java.lang.StringBuffer sb) Appends an empty tag to the given StringBuffer.
static void	appendEndTag(int level, java.lang.String tagName, java.lang.StringBuffer sb) Appends an end tag to the given StringBuffer.
static void	appendNewLine(java.lang.StringBuffer sb) Adds a line break to the given StringBuffer.
static void	appendStartTag(int level, java.lang.String tagName, java.util.Map<java.lang.String,java.lang.String> attributeValues, java.lang.StringBuffer sb) Appends a start tag to the given StringBuffer.
static void	appendWhiteSpace(int level, java.lang.StringBuffer sb) Adds leading white space to the StringBuffer.
static void	appendXmlHeader(java.lang.String encoding, java.lang.StringBuffer sb) Adds an XML header to the given StringBuffer.
static java.lang.String	encodeText(java.lang.String text) Encodes the given text in a way that it contains no XML elements and can be used for instance as plain text or attribute value.
static boolean	isEntityNameCharacter(char character) Checks if the given character is valid to be used in entity names (between &...;).
static java.lang.String	removeTags(java.lang.String text) Removes all tags from the given text.
static java.lang.String	replaceTags(java.lang.String text, XMLUtil.ITagReplacer replacer) Replaces all tags in the given text with help of the given XMLUtil.ITagReplacer.

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_ENCODING

public static final java.lang.String ATTRIBUTE_ENCODING

Attribute name to store encodings.

See Also:

Constant Field Values

LEADING_WHITE_SPACE_PER_LEVEL

public static final java.lang.String LEADING_WHITE_SPACE_PER_LEVEL

The used leading white space in each level.

See Also:

Constant Field Values

Constructor Detail

XMLUtil

private XMLUtil()

Forbid instances.

Method Detail

replaceTags

public static java.lang.String replaceTags(java.lang.String text,
                                           XMLUtil.ITagReplacer replacer)

Replaces all tags in the given text with help of the given XMLUtil.ITagReplacer.

Parameters:

text - The text to execute replacements on.

replacer - The XMLUtil.ITagReplacer to use.

Returns:

The new created text.

removeTags

public static java.lang.String removeTags(java.lang.String text)

Removes all tags from the given text.

Parameters:

text - The text to remove tags from.

Returns:

The text without tags.

encodeText

public static java.lang.String encodeText(java.lang.String text)

Encodes the given text in a way that it contains no XML elements and can be used for instance as plain text or attribute value.

The following signs are replaced:

 " => "quot;
 & => "amp;
 ' => "apos;
 < => "lt;
 > => "gt;
 

Parameters:

text - The text to encode.

Returns:

The encoded text.

isEntityNameCharacter

public static boolean isEntityNameCharacter(char character)

Checks if the given character is valid to be used in entity names (between &...;).

Parameters:

character - The character to check.

Returns:

true is valid, false is not valid.

appendEmptyTag

public static void appendEmptyTag(int level,
                                  java.lang.String tagName,
                                  java.util.Map<java.lang.String,java.lang.String> attributeValues,
                                  java.lang.StringBuffer sb)

Appends an empty tag to the given StringBuffer.

Parameters:

level - The level.

tagName - The tag name.

attributeValues - The attributes.

sb - The StringBuffer to append to.

appendStartTag

public static void appendStartTag(int level,
                                  java.lang.String tagName,
                                  java.util.Map<java.lang.String,java.lang.String> attributeValues,
                                  java.lang.StringBuffer sb)

Appends a start tag to the given StringBuffer.

Parameters:

level - The level.

tagName - The tag name.

attributeValues - The attributes.

sb - The StringBuffer to append to.

appendEndTag

public static void appendEndTag(int level,
                                java.lang.String tagName,
                                java.lang.StringBuffer sb)

Appends an end tag to the given StringBuffer.

Parameters:

level - The level.

tagName - The tag name.

sb - The StringBuffer to append to.

appendWhiteSpace

public static void appendWhiteSpace(int level,
                                    java.lang.StringBuffer sb)

Adds leading white space to the StringBuffer.

Parameters:

level - The level in the tree used for leading white space (formating).

sb - The StringBuffer to write to.

appendAttribute

public static void appendAttribute(java.lang.String attributeName,
                                   java.lang.String value,
                                   java.lang.StringBuffer sb)

Adds an XML attribute to the given StringBuffer.

Parameters:

attributeName - The attribute name.

value - The attribute value.

sb - The StringBuffer to write to.

appendXmlHeader

public static void appendXmlHeader(java.lang.String encoding,
                                   java.lang.StringBuffer sb)

Adds an XML header to the given StringBuffer.

Parameters:

encoding - The encoding to use.

sb - The StringBuffer to write to.

appendNewLine

public static void appendNewLine(java.lang.StringBuffer sb)

Adds a line break to the given StringBuffer.

Parameters:

sb - The StringBuffer to write to.