Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
nu.xom.canonical.Canonicalizer
public class Canonicalizer
extends java.lang.Object
Field Summary | |
static String | |
static String | |
static String | |
static String |
Constructor Summary | |
| |
| |
|
Method Summary | |
void |
|
void | |
void |
public static final String CANONICAL_XML
public static final String CANONICAL_XML_WITH_COMMENTS
public static final String EXCLUSIVE_XML_CANONICALIZATION
public static final String EXCLUSIVE_XML_CANONICALIZATION_WITH_COMMENTS
public Canonicalizer(OutputStream out)
Creates aCanonicalizer
that outputs a canonical XML document with comments.
- Parameters:
out
- the output stream the document is written onto
public Canonicalizer(OutputStream out, String algorithm)
Creates aCanonicalizer
that outputs a canonical XML document using the specified algorithm. Currently, four algorithms are defined and supported:
- Canonical XML without comments:
http://www.w3.org/TR/2001/REC-xml-c14n-20010315
- Canonical XML with comments:
http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments
- Exclusive XML canonicalization without comments:
http://www.w3.org/2001/10/xml-exc-c14n#
- Exclusive XML canonicalization with comments:
http://www.w3.org/2001/10/xml-exc-c14n#WithComments
- Parameters:
out
- the output stream the document is written ontoalgorithm
- the URI for the canonicalization algorithm
public Canonicalizer(OutputStream out, boolean withComments)
Creates aCanonicalizer
that outputs a canonical XML document with or without comments.
- Parameters:
out
- the output stream the document is written ontowithComments
- true if comments should be included in the output, false otherwise
public final void setInclusiveNamespacePrefixList(String inclusiveNamespacePrefixes) throws IOException
Specifies the prefixes that will be output as specified in regular canonical XML, even when doing exclusive XML canonicalization.
- Parameters:
inclusiveNamespacePrefixes
- a whitespace separated list of namespace prefixes that will always be included in the output, even in exclusive canonicalization
public final void write(Node node) throws IOException
Serializes a node onto the output stream using the specified canonicalization algorithm. If the node is a document or an element, then the node's entire subtree is written out.
- Parameters:
node
- the node to canonicalize
public final void write(Nodes documentSubset) throws IOException
Serializes a document subset onto the output stream using the canonical XML algorithm. All nodes in the list must come from same document. Furthermore, they must come from a document. They cannot be detached. The nodes need not be sorted. This method will sort them into the appropriate order for canonicalization. In most common use cases, these nodes will be the result of evaluating an XPath expression. For example,Children are not output unless the subset also includes them. Including an element in the subset does not automatically select all the element's children, attributes, and namespaces. Furthermore, not selecting an element does not imply that its children, namespaces, attributes will not be output.Canonicalizer canonicalizer = new Canonicalizer(System.out, Canonicalizer.CANONICAL_XML); Nodes result = doc.query("//. | //@* | //namespace::*"); canonicalizer.write(result);
- Parameters:
documentSubset
- the nodes to serialize