org.apache.batik.xml

Class XMLUtilities

public class XMLUtilities extends XMLCharacters

A collection of utility functions for XML.
Constructor Summary
protected XMLUtilities()
This class does not need to be instantiated.
Method Summary
protected static ReadercreateXMLDeclarationReader(PushbackInputStream pbis, String enc)
Creates a reader from the given input stream and encoding.
static ReadercreateXMLDocumentReader(InputStream is)
Creates a Reader initialized to scan the characters in the given XML document's InputStream.
static StringencodingToJavaEncoding(String e, String de)
Converts the given standard encoding representation to the corresponding Java encoding string.
protected static StringgetXMLDeclarationEncoding(Reader r, String e)
Reads an XML declaration to get the encoding declaration value.
static booleanisXML11Character(int c)
Tests whether the given 32 bit character is a valid XML 1.1 character.
static booleanisXML11NameCharacter(char c)
Tests whether the given character is a valid XML 1.1 name character.
static booleanisXML11NameFirstCharacter(char c)
Tests whether the given character is usable as the first character of an XML 1.1 name.
static booleanisXMLAlphabeticCharacter(char c)
Tests whether the given character is a valid aphabetic character.
static booleanisXMLCharacter(int c)
Tests whether the given 32 bits character is valid in XML documents.
static booleanisXMLNameCharacter(char c)
Tests whether the given character is a valid XML name character.
static booleanisXMLNameFirstCharacter(char c)
Tests whether the given character is usable as the first character of an XML name.
static booleanisXMLPublicIdCharacter(char c)
Tests whether the given character is a valid XML public ID character.
static booleanisXMLSpace(char c)
Tests whether the given character is a valid space.
static booleanisXMLVersionCharacter(char c)
Tests whether the given character is a valid XML version character.

Constructor Detail

XMLUtilities

protected XMLUtilities()
This class does not need to be instantiated.

Method Detail

createXMLDeclarationReader

protected static Reader createXMLDeclarationReader(PushbackInputStream pbis, String enc)
Creates a reader from the given input stream and encoding. This method assumes the input stream working buffer is at least 128 byte long. The input stream is restored before this method returns. The 4 first bytes are skipped before creating the reader.

createXMLDocumentReader

public static Reader createXMLDocumentReader(InputStream is)
Creates a Reader initialized to scan the characters in the given XML document's InputStream.

Parameters: is The input stream positionned at the beginning of an XML document.

Returns: a Reader positionned at the beginning of the XML document It is created from an encoding figured out from the first few bytes of the document. As a consequence the given input stream is not positionned anymore at the beginning of the document when this method returns.

encodingToJavaEncoding

public static String encodingToJavaEncoding(String e, String de)
Converts the given standard encoding representation to the corresponding Java encoding string.

Parameters: e the encoding string to convert. de the encoding string if no corresponding encoding was found.

getXMLDeclarationEncoding

protected static String getXMLDeclarationEncoding(Reader r, String e)
Reads an XML declaration to get the encoding declaration value.

Parameters: r a reader positioned just after '<?xm'. e the encoding to return by default or on error.

isXML11Character

public static boolean isXML11Character(int c)
Tests whether the given 32 bit character is a valid XML 1.1 character.

isXML11NameCharacter

public static boolean isXML11NameCharacter(char c)
Tests whether the given character is a valid XML 1.1 name character.

isXML11NameFirstCharacter

public static boolean isXML11NameFirstCharacter(char c)
Tests whether the given character is usable as the first character of an XML 1.1 name.

isXMLAlphabeticCharacter

public static boolean isXMLAlphabeticCharacter(char c)
Tests whether the given character is a valid aphabetic character.

isXMLCharacter

public static boolean isXMLCharacter(int c)
Tests whether the given 32 bits character is valid in XML documents.

isXMLNameCharacter

public static boolean isXMLNameCharacter(char c)
Tests whether the given character is a valid XML name character.

isXMLNameFirstCharacter

public static boolean isXMLNameFirstCharacter(char c)
Tests whether the given character is usable as the first character of an XML name.

isXMLPublicIdCharacter

public static boolean isXMLPublicIdCharacter(char c)
Tests whether the given character is a valid XML public ID character.

isXMLSpace

public static boolean isXMLSpace(char c)
Tests whether the given character is a valid space.

isXMLVersionCharacter

public static boolean isXMLVersionCharacter(char c)
Tests whether the given character is a valid XML version character.
Copyright B) 2007 Apache Software Foundation. All Rights Reserved.