diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/BaseMarkupSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/BaseMarkupSerializer.html new file mode 100644 index 0000000..2af1656 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/BaseMarkupSerializer.html @@ -0,0 +1,2030 @@ + + + + + + +Xerces-J API: Class BaseMarkupSerializer + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class BaseMarkupSerializer

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.BaseMarkupSerializer
+
+
+
Direct Known Subclasses:
HTMLSerializer, TextSerializer, XMLSerializer
+
+
+
+
public abstract class BaseMarkupSerializer
extends java.lang.Object
implements ContentHandler, DocumentHandler, LexicalHandler, DTDHandler, DeclHandler, DOMSerializer, Serializer
+ +

+Base class for a serializer supporting both DOM and SAX pretty + serializing of XML/HTML/XHTML documents. Derives classes perform + the method-specific serializing, this class provides the common + serializing mechanisms. +

+ The serializer must be initialized with the proper writer and + output format before it can be used by calling #init. + The serializer can be reused any number of times, but cannot + be used concurrently by two threads. +

+ If an output stream is used, the encoding is taken from the + output format (defaults to UTF-8). If a writer is + used, make sure the writer uses the same encoding (if applies) + as specified in the output format. +

+ The serializer supports both DOM and SAX. DOM serializing is done + by calling serialize(org.w3c.dom.Element) and SAX serializing is done by firing + SAX events and using the serializer as a document handler. + This also applies to derived class. +

+ If an I/O exception occurs while serializing, the serializer + will not throw an exception directly, but only throw it + at the end of serializing (either DOM or SAX's DocumentHandler.endDocument(). +

+ For elements that are not specified as whitespace preserving, + the serializer will potentially break long text lines at space + boundaries, indent lines, and serialize elements on separate + lines. Line terminators will be regarded as spaces, and + spaces at beginning of line will be stripped. +

+ When indenting, the serializer is capable of detecting seemingly + element content, and serializing these elements indented on separate + lines. An element is serialized indented when it is the first or + last child of an element, or immediate following or preceding + another element. +

+

+
Version:
$Revision: 1.26 $ $Date: 2001/07/11 15:40:10 $
+
Author:
Assaf Arkin
+
See Also:
Serializer, +DOMSerializer
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  java.lang.String_docTypePublicId + +
+          The system identifier of the document type, if known.
+protected  java.lang.String_docTypeSystemId + +
+          The system identifier of the document type, if known.
+protected  OutputFormat_format + +
+          The output format associated with this serializer.
+protected  boolean_indenting + +
+          True if indenting printer.
+protected  java.util.Hashtable_prefixes + +
+          Association between namespace URIs (keys) and prefixes (values).
+protected  Printer_printer + +
+          The printer used for printing text parts.
+protected  boolean_started + +
+          If the document has been started (header serialized), this + flag is set to true so it's not started twice.
+  + + + + + + + + + + + +
+Constructor Summary
+protected BaseMarkupSerializer(OutputFormat format) + +
+          Protected constructor can only be used by derived class.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ ContentHandlerasContentHandler() + +
+          Return a ContentHandler interface into this serializer.
+ DocumentHandlerasDocumentHandler() + +
+          Return a DocumentHandler interface into this serializer.
+ DOMSerializerasDOMSerializer() + +
+          Return a DOMSerializer interface into this serializer.
+ voidattributeDecl(java.lang.String eName, + java.lang.String aName, + java.lang.String type, + java.lang.String valueDefault, + java.lang.String value) + +
+          Report an attribute type declaration.
+ voidcharacters(char[] chars, + int start, + int length) + +
+          Receive notification of character data.
+protected  voidcharacters(java.lang.String text) + +
+          Called to print the text contents in the prevailing element format.
+ voidcomment(char[] chars, + int start, + int length) + +
+          Report an XML comment anywhere in the document.
+ voidcomment(java.lang.String text) + +
+           
+protected  ElementStatecontent() + +
+          Must be called by a method about to print any type of content.
+ voidelementDecl(java.lang.String name, + java.lang.String model) + +
+          Report an element type declaration.
+ voidendCDATA() + +
+          Report the end of a CDATA section.
+ voidendDocument() + +
+          Called at the end of the document to wrap it up.
+ voidendDTD() + +
+          Report the end of DTD declarations.
+ voidendEntity(java.lang.String name) + +
+          Report the end of an entity.
+ voidendNonEscaping() + +
+           
+ voidendPrefixMapping(java.lang.String prefix) + +
+          End the scope of a prefix-URI mapping.
+ voidendPreserving() + +
+           
+protected  ElementStateenterElementState(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String rawName, + boolean preserveSpace) + +
+          Enter a new element state for the specified element.
+ voidexternalEntityDecl(java.lang.String name, + java.lang.String publicId, + java.lang.String systemId) + +
+          Report a parsed external entity declaration.
+protected  ElementStategetElementState() + +
+          Return the state of the current element.
+protected abstract  java.lang.StringgetEntityRef(int ch) + +
+          Returns the suitable entity reference for this character value, + or null if no such entity exists.
+protected  java.lang.StringgetPrefix(java.lang.String namespaceURI) + +
+          Returns the namespace prefix for the specified URI.
+ voidignorableWhitespace(char[] chars, + int start, + int length) + +
+          Receive notification of ignorable whitespace in element content.
+ voidinternalEntityDecl(java.lang.String name, + java.lang.String value) + +
+          Report an internal entity declaration.
+protected  booleanisDocumentState() + +
+          Returns true if in the state of the document.
+protected  ElementStateleaveElementState() + +
+          Leave the current element state and return to the + state of the parent element.
+ voidnotationDecl(java.lang.String name, + java.lang.String publicId, + java.lang.String systemId) + +
+          Receive notification of a notation declaration event.
+protected  voidprepare() + +
+           
+protected  voidprintDoctypeURL(java.lang.String url) + +
+          Print a document type public or system identifier URL.
+protected  voidprintEscaped(int ch) + +
+           
+protected  voidprintEscaped(java.lang.String source) + +
+          Escapes a string so it may be printed as text content or attribute + value.
+protected  voidprintText(char[] chars, + int start, + int length, + boolean preserveSpace, + boolean unescaped) + +
+          Called to print additional text with whitespace handling.
+protected  voidprintText(java.lang.String text, + boolean preserveSpace, + boolean unescaped) + +
+           
+ voidprocessingInstruction(java.lang.String target, + java.lang.String code) + +
+          Receive notification of a processing instruction.
+ voidprocessingInstructionIO(java.lang.String target, + java.lang.String code) + +
+           
+ booleanreset() + +
+           
+ voidserialize(Document doc) + +
+          Serializes the DOM document using the previously specified + writer and output format.
+ voidserialize(DocumentFragment frag) + +
+          Serializes the DOM document fragmnt using the previously specified + writer and output format.
+ voidserialize(Element elem) + +
+          Serializes the DOM element using the previously specified + writer and output format.
+protected abstract  voidserializeElement(Element elem) + +
+          Called to serializee the DOM element.
+protected  voidserializeNode(Node node) + +
+          Serialize the DOM node.
+protected  voidserializePreRoot() + +
+          Comments and PIs cannot be serialized before the root element, + because the root element serializes the document type, which + generally comes first.
+ voidsetDocumentLocator(Locator locator) + +
+          Receive an object for locating the origin of SAX document events.
+ voidsetOutputByteStream(java.io.OutputStream output) + +
+          Specifies an output stream to which the document should be + serialized.
+ voidsetOutputCharStream(java.io.Writer writer) + +
+          Specifies a writer to which the document should be serialized.
+ voidsetOutputFormat(OutputFormat format) + +
+          Specifies an output format for this serializer.
+ voidskippedEntity(java.lang.String name) + +
+          Receive notification of a skipped entity.
+ voidstartCDATA() + +
+          Report the start of a CDATA section.
+ voidstartDocument() + +
+          Receive notification of the beginning of a document.
+ voidstartDTD(java.lang.String name, + java.lang.String publicId, + java.lang.String systemId) + +
+          Report the start of DTD declarations, if any.
+ voidstartEntity(java.lang.String name) + +
+          Report the beginning of some internal and external XML entities.
+ voidstartNonEscaping() + +
+           
+ voidstartPrefixMapping(java.lang.String prefix, + java.lang.String uri) + +
+          Begin the scope of a prefix-URI Namespace mapping.
+ voidstartPreserving() + +
+           
+ voidunparsedEntityDecl(java.lang.String name, + java.lang.String publicId, + java.lang.String systemId, + java.lang.String notationName) + +
+          Receive notification of an unparsed entity declaration event.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+_started

+
+protected boolean _started
+
+
If the document has been started (header serialized), this + flag is set to true so it's not started twice.
+
+ +

+_prefixes

+
+protected java.util.Hashtable _prefixes
+
+
Association between namespace URIs (keys) and prefixes (values). + Accumulated here prior to starting an element and placing this + list in the element state.
+
+ +

+_docTypePublicId

+
+protected java.lang.String _docTypePublicId
+
+
The system identifier of the document type, if known.
+
+ +

+_docTypeSystemId

+
+protected java.lang.String _docTypeSystemId
+
+
The system identifier of the document type, if known.
+
+ +

+_format

+
+protected OutputFormat _format
+
+
The output format associated with this serializer. This will never + be a null reference. If no format was passed to the constructor, + the default one for this document type will be used. The format + object is never changed by the serializer.
+
+ +

+_printer

+
+protected Printer _printer
+
+
The printer used for printing text parts.
+
+ +

+_indenting

+
+protected boolean _indenting
+
+
True if indenting printer.
+ + + + + + + + +
+Constructor Detail
+ +

+BaseMarkupSerializer

+
+protected BaseMarkupSerializer(OutputFormat format)
+
+
Protected constructor can only be used by derived class. + Must initialize the serializer before serializing any document, + see #init.
+ + + + + + + + +
+Method Detail
+ +

+asDocumentHandler

+
+public DocumentHandler asDocumentHandler()
+                                  throws java.io.IOException
+
+
Description copied from interface: Serializer
+
Return a DocumentHandler interface into this serializer. + If the serializer does not support the DocumentHandler + interface, it should return null.
+
Specified by:
asDocumentHandler in interface Serializer
+
+
+
+ +

+asContentHandler

+
+public ContentHandler asContentHandler()
+                                throws java.io.IOException
+
+
Description copied from interface: Serializer
+
Return a ContentHandler interface into this serializer. + If the serializer does not support the ContentHandler + interface, it should return null.
+
Specified by:
asContentHandler in interface Serializer
+
+
+
+ +

+asDOMSerializer

+
+public DOMSerializer asDOMSerializer()
+                              throws java.io.IOException
+
+
Description copied from interface: Serializer
+
Return a DOMSerializer interface into this serializer. + If the serializer does not support the DOMSerializer + interface, it should return null.
+
Specified by:
asDOMSerializer in interface Serializer
+
+
+
+ +

+setOutputByteStream

+
+public void setOutputByteStream(java.io.OutputStream output)
+
+
Description copied from interface: Serializer
+
Specifies an output stream to which the document should be + serialized. This method should not be called while the + serializer is in the process of serializing a document.
+
Specified by:
setOutputByteStream in interface Serializer
+
+
+
+ +

+setOutputCharStream

+
+public void setOutputCharStream(java.io.Writer writer)
+
+
Description copied from interface: Serializer
+
Specifies a writer to which the document should be serialized. + This method should not be called while the serializer is in + the process of serializing a document.
+
Specified by:
setOutputCharStream in interface Serializer
+
+
+
+ +

+setOutputFormat

+
+public void setOutputFormat(OutputFormat format)
+
+
Description copied from interface: Serializer
+
Specifies an output format for this serializer. It the + serializer has already been associated with an output format, + it will switch to the new format. This method should not be + called while the serializer is in the process of serializing + a document.
+
Specified by:
setOutputFormat in interface Serializer
+
+
Tags copied from interface: Serializer
+
+
Parameters:
format - The output format to use
+
+
+
+ +

+reset

+
+public boolean reset()
+
+
+
+
+
+
+ +

+prepare

+
+protected void prepare()
+                throws java.io.IOException
+
+
+
+
+
+
+ +

+serialize

+
+public void serialize(Element elem)
+               throws java.io.IOException
+
+
Serializes the DOM element using the previously specified + writer and output format. Throws an exception only if + an I/O exception occured while serializing.
+
Specified by:
serialize in interface DOMSerializer
+
+
+
Parameters:
elem - The element to serialize
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+serialize

+
+public void serialize(DocumentFragment frag)
+               throws java.io.IOException
+
+
Serializes the DOM document fragmnt using the previously specified + writer and output format. Throws an exception only if + an I/O exception occured while serializing.
+
Specified by:
serialize in interface DOMSerializer
+
+
+
Parameters:
elem - The element to serialize
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+serialize

+
+public void serialize(Document doc)
+               throws java.io.IOException
+
+
Serializes the DOM document using the previously specified + writer and output format. Throws an exception only if + an I/O exception occured while serializing.
+
Specified by:
serialize in interface DOMSerializer
+
+
+
Parameters:
doc - The document to serialize
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+startDocument

+
+public void startDocument()
+                   throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of the beginning of a document. + +

The SAX parser will invoke this method only once, before any + other methods in this interface or in DTDHandler (except for setDocumentLocator).

+
Specified by:
startDocument in interface ContentHandler
+
+
Tags copied from interface: ContentHandler
+
+
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
ContentHandler.endDocument()
+
+
+
+ +

+characters

+
+public void characters(char[] chars,
+                       int start,
+                       int length)
+                throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of character data. + +

The Parser will call this method to report each chunk of + character data. SAX parsers may return all contiguous character + data in a single chunk, or they may split it into several + chunks; however, all of the characters in any single event + must come from the same external entity so that the Locator + provides useful information.

+ +

The application must not attempt to read from the array + outside of the specified range.

+ +

Note that some parsers will report whitespace in element + content using the ignorableWhitespace + method rather than this one (validating parsers must + do so).

+
Specified by:
characters in interface ContentHandler
+
+
Tags copied from interface: ContentHandler
+
+
Parameters:
ch - The characters from the XML document.
start - The start position in the array.
length - The number of characters to read from the array.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
ContentHandler.ignorableWhitespace(char[], int, int), +Locator
+
+
+
+ +

+ignorableWhitespace

+
+public void ignorableWhitespace(char[] chars,
+                                int start,
+                                int length)
+                         throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of ignorable whitespace in element content. + +

Validating Parsers must use this method to report each chunk + of whitespace in element content (see the W3C XML 1.0 recommendation, + section 2.10): non-validating parsers may also use this method + if they are capable of parsing and using content models.

+ +

SAX parsers may return all contiguous whitespace in a single + chunk, or they may split it into several chunks; however, all of + the characters in any single event must come from the same + external entity, so that the Locator provides useful + information.

+ +

The application must not attempt to read from the array + outside of the specified range.

+
Specified by:
ignorableWhitespace in interface ContentHandler
+
+
Tags copied from interface: ContentHandler
+
+
Parameters:
ch - The characters from the XML document.
start - The start position in the array.
length - The number of characters to read from the array.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
ContentHandler.characters(char[], int, int)
+
+
+
+ +

+processingInstruction

+
+public final void processingInstruction(java.lang.String target,
+                                        java.lang.String code)
+                                 throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of a processing instruction. + +

The Parser will invoke this method once for each processing + instruction found: note that processing instructions may occur + before or after the main document element.

+ +

A SAX parser must never report an XML declaration (XML 1.0, + section 2.8) or a text declaration (XML 1.0, section 4.3.1) + using this method.

+
Specified by:
processingInstruction in interface ContentHandler
+
+
Tags copied from interface: ContentHandler
+
+
Parameters:
target - The processing instruction target.
data - The processing instruction data, or null if + none was supplied. The data does not include any + whitespace separating it from the target.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
+
+
+
+ +

+processingInstructionIO

+
+public void processingInstructionIO(java.lang.String target,
+                                    java.lang.String code)
+                             throws java.io.IOException
+
+
+
+
+
+
+ +

+comment

+
+public void comment(char[] chars,
+                    int start,
+                    int length)
+             throws SAXException
+
+
Description copied from interface: LexicalHandler
+
Report an XML comment anywhere in the document. + +

This callback will be used for comments inside or outside the + document element, including comments in the external DTD + subset (if read). Comments in the DTD must be properly + nested inside start/endDTD and start/endEntity events (if + used).

+
Specified by:
comment in interface LexicalHandler
+
+
Tags copied from interface: LexicalHandler
+
+
Parameters:
ch - An array holding the characters in the comment.
start - The starting position in the array.
length - The number of characters to use from the array.
Throws:
SAXException - The application may raise an exception.
+
+
+
+ +

+comment

+
+public void comment(java.lang.String text)
+             throws java.io.IOException
+
+
+
+
+
+
+ +

+startCDATA

+
+public void startCDATA()
+
+
Description copied from interface: LexicalHandler
+
Report the start of a CDATA section. + +

The contents of the CDATA section will be reported through + the regular characters event; this event is intended only to report + the boundary.

+
Specified by:
startCDATA in interface LexicalHandler
+
+
Tags copied from interface: LexicalHandler
+
+
Throws:
SAXException - The application may raise an exception.
See Also:
LexicalHandler.endCDATA()
+
+
+
+ +

+endCDATA

+
+public void endCDATA()
+
+
Description copied from interface: LexicalHandler
+
Report the end of a CDATA section.
+
Specified by:
endCDATA in interface LexicalHandler
+
+
Tags copied from interface: LexicalHandler
+
+
Throws:
SAXException - The application may raise an exception.
See Also:
LexicalHandler.startCDATA()
+
+
+
+ +

+startNonEscaping

+
+public void startNonEscaping()
+
+
+
+
+
+
+ +

+endNonEscaping

+
+public void endNonEscaping()
+
+
+
+
+
+
+ +

+startPreserving

+
+public void startPreserving()
+
+
+
+
+
+
+ +

+endPreserving

+
+public void endPreserving()
+
+
+
+
+
+
+ +

+endDocument

+
+public void endDocument()
+                 throws SAXException
+
+
Called at the end of the document to wrap it up. + Will flush the output stream and throw an exception + if any I/O error occured while serializing.
+
Specified by:
endDocument in interface ContentHandler
+
+
+
Throws:
SAXException - An I/O exception occured during + serializing
+
+
+
+ +

+startEntity

+
+public void startEntity(java.lang.String name)
+
+
Description copied from interface: LexicalHandler
+
Report the beginning of some internal and external XML entities. + +

The reporting of parameter entities (including + the external DTD subset) is optional, and SAX2 drivers that + support LexicalHandler may not support it; you can use the + http://xml.org/sax/features/lexical-handler/parameter-entities + feature to query or control the reporting of parameter entities.

+ +

General entities are reported with their regular names, + parameter entities have '%' prepended to their names, and + the external DTD subset has the pseudo-entity name "[dtd]".

+ +

When a SAX2 driver is providing these events, all other + events must be properly nested within start/end entity + events. There is no additional requirement that events from + DeclHandler or + DTDHandler be properly ordered.

+ +

Note that skipped entities will be reported through the + skippedEntity + event, which is part of the ContentHandler interface.

+ +

Because of the streaming event model that SAX uses, some + entity boundaries cannot be reported under any + circumstances:

+ + + +

These will be silently expanded, with no indication of where + the original entity boundaries were.

+ +

Note also that the boundaries of character references (which + are not really entities anyway) are not reported.

+ +

All start/endEntity events must be properly nested.

+
Specified by:
startEntity in interface LexicalHandler
+
+
Tags copied from interface: LexicalHandler
+
+
Parameters:
name - The name of the entity. If it is a parameter + entity, the name will begin with '%', and if it is the + external DTD subset, it will be "[dtd]".
Throws:
SAXException - The application may raise an exception.
See Also:
LexicalHandler.endEntity(java.lang.String), +DeclHandler.internalEntityDecl(java.lang.String, java.lang.String), +DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)
+
+
+
+ +

+endEntity

+
+public void endEntity(java.lang.String name)
+
+
Description copied from interface: LexicalHandler
+
Report the end of an entity.
+
Specified by:
endEntity in interface LexicalHandler
+
+
Tags copied from interface: LexicalHandler
+
+
Parameters:
name - The name of the entity that is ending.
Throws:
SAXException - The application may raise an exception.
See Also:
LexicalHandler.startEntity(java.lang.String)
+
+
+
+ +

+setDocumentLocator

+
+public void setDocumentLocator(Locator locator)
+
+
Description copied from interface: ContentHandler
+
Receive an object for locating the origin of SAX document events. + +

SAX parsers are strongly encouraged (though not absolutely + required) to supply a locator: if it does so, it must supply + the locator to the application by invoking this method before + invoking any of the other methods in the ContentHandler + interface.

+ +

The locator allows the application to determine the end + position of any document-related event, even if the parser is + not reporting an error. Typically, the application will + use this information for reporting its own errors (such as + character content that does not match an application's + business rules). The information returned by the locator + is probably not sufficient for use with a search engine.

+ +

Note that the locator will return correct information only + during the invocation of the events in this interface. The + application should not attempt to use it at any other time.

+
Specified by:
setDocumentLocator in interface ContentHandler
+
+
Tags copied from interface: ContentHandler
+
+
Parameters:
locator - An object that can return the location of + any SAX document event.
See Also:
Locator
+
+
+
+ +

+skippedEntity

+
+public void skippedEntity(java.lang.String name)
+                   throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of a skipped entity. + +

The Parser will invoke this method once for each entity + skipped. Non-validating processors may skip entities if they + have not seen the declarations (because, for example, the + entity was declared in an external DTD subset). All processors + may skip external entities, depending on the values of the + http://xml.org/sax/features/external-general-entities + and the + http://xml.org/sax/features/external-parameter-entities + properties.

+
Specified by:
skippedEntity in interface ContentHandler
+
+
Tags copied from interface: ContentHandler
+
+
Parameters:
name - The name of the skipped entity. If it is a + parameter entity, the name will begin with '%', and if + it is the external DTD subset, it will be the string + "[dtd]".
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
+
+
+
+ +

+startPrefixMapping

+
+public void startPrefixMapping(java.lang.String prefix,
+                               java.lang.String uri)
+                        throws SAXException
+
+
Description copied from interface: ContentHandler
+
Begin the scope of a prefix-URI Namespace mapping. + +

The information from this event is not necessary for + normal Namespace processing: the SAX XML reader will + automatically replace prefixes for element and attribute + names when the http://xml.org/sax/features/namespaces + feature is true (the default).

+ +

There are cases, however, when applications need to + use prefixes in character data or in attribute values, + where they cannot safely be expanded automatically; the + start/endPrefixMapping event supplies the information + to the application to expand prefixes in those contexts + itself, if necessary.

+ +

Note that start/endPrefixMapping events are not + guaranteed to be properly nested relative to each-other: + all startPrefixMapping events will occur before the + corresponding startElement event, + and all endPrefixMapping + events will occur after the corresponding endElement event, but their order is not otherwise + guaranteed.

+ +

There should never be start/endPrefixMapping events for the + "xml" prefix, since it is predeclared and immutable.

+
Specified by:
startPrefixMapping in interface ContentHandler
+
+
Tags copied from interface: ContentHandler
+
+
Parameters:
prefix - The Namespace prefix being declared.
uri - The Namespace URI the prefix is mapped to.
Throws:
SAXException - The client may throw + an exception during processing.
See Also:
ContentHandler.endPrefixMapping(java.lang.String), +ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
+
+
+
+ +

+endPrefixMapping

+
+public void endPrefixMapping(java.lang.String prefix)
+                      throws SAXException
+
+
Description copied from interface: ContentHandler
+
End the scope of a prefix-URI mapping. + +

See startPrefixMapping for + details. This event will always occur after the corresponding + endElement event, but the order of + endPrefixMapping events is not otherwise + guaranteed.

+
Specified by:
endPrefixMapping in interface ContentHandler
+
+
Tags copied from interface: ContentHandler
+
+
Parameters:
prefix - The prefix that was being mapping.
Throws:
SAXException - The client may throw + an exception during processing.
See Also:
ContentHandler.startPrefixMapping(java.lang.String, java.lang.String), +ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
+
+
+
+ +

+startDTD

+
+public final void startDTD(java.lang.String name,
+                           java.lang.String publicId,
+                           java.lang.String systemId)
+                    throws SAXException
+
+
Description copied from interface: LexicalHandler
+
Report the start of DTD declarations, if any. + +

This method is intended to report the beginning of the + DOCTYPE declaration; if the document has no DOCTYPE declaration, + this method will not be invoked.

+ +

All declarations reported through + DTDHandler or + DeclHandler events must appear + between the startDTD and endDTD events. + Declarations are assumed to belong to the internal DTD subset + unless they appear between startEntity + and endEntity events. Comments and + processing instructions from the DTD should also be reported + between the startDTD and endDTD events, in their original + order of (logical) occurrence; they are not required to + appear in their correct locations relative to DTDHandler + or DeclHandler events, however.

+ +

Note that the start/endDTD events will appear within + the start/endDocument events from ContentHandler and + before the first + startElement + event.

+
Specified by:
startDTD in interface LexicalHandler
+
+
Tags copied from interface: LexicalHandler
+
+
Parameters:
name - The document type name.
publicId - The declared public identifier for the + external DTD subset, or null if none was declared.
systemId - The declared system identifier for the + external DTD subset, or null if none was declared.
Throws:
SAXException - The application may raise an + exception.
See Also:
LexicalHandler.endDTD(), +LexicalHandler.startEntity(java.lang.String)
+
+
+
+ +

+endDTD

+
+public void endDTD()
+
+
Description copied from interface: LexicalHandler
+
Report the end of DTD declarations. + +

This method is intended to report the end of the + DOCTYPE declaration; if the document has no DOCTYPE declaration, + this method will not be invoked.

+
Specified by:
endDTD in interface LexicalHandler
+
+
Tags copied from interface: LexicalHandler
+
+
Throws:
SAXException - The application may raise an exception.
See Also:
LexicalHandler.startDTD(java.lang.String, java.lang.String, java.lang.String)
+
+
+
+ +

+elementDecl

+
+public void elementDecl(java.lang.String name,
+                        java.lang.String model)
+                 throws SAXException
+
+
Description copied from interface: DeclHandler
+
Report an element type declaration. + +

The content model will consist of the string "EMPTY", the + string "ANY", or a parenthesised group, optionally followed + by an occurrence indicator. The model will be normalized so + that all parameter entities are fully resolved and all whitespace + is removed,and will include the enclosing parentheses. Other + normalization (such as removing redundant parentheses or + simplifying occurrence indicators) is at the discretion of the + parser.

+
Specified by:
elementDecl in interface DeclHandler
+
+
Tags copied from interface: DeclHandler
+
+
Parameters:
name - The element type name.
model - The content model as a normalized string.
Throws:
SAXException - The application may raise an exception.
+
+
+
+ +

+attributeDecl

+
+public void attributeDecl(java.lang.String eName,
+                          java.lang.String aName,
+                          java.lang.String type,
+                          java.lang.String valueDefault,
+                          java.lang.String value)
+                   throws SAXException
+
+
Description copied from interface: DeclHandler
+
Report an attribute type declaration. + +

Only the effective (first) declaration for an attribute will + be reported. The type will be one of the strings "CDATA", + "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", + "ENTITIES", a parenthesized token group with + the separator "|" and all whitespace removed, or the word + "NOTATION" followed by a space followed by a parenthesized + token group with all whitespace removed.

+ +

Any parameter entities in the attribute value will be + expanded, but general entities will not.

+
Specified by:
attributeDecl in interface DeclHandler
+
+
Tags copied from interface: DeclHandler
+
+
Parameters:
eName - The name of the associated element.
aName - The name of the attribute.
type - A string representing the attribute type.
valueDefault - A string representing the attribute default + ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if + none of these applies.
value - A string representing the attribute's default value, + or null if there is none.
Throws:
SAXException - The application may raise an exception.
+
+
+
+ +

+internalEntityDecl

+
+public void internalEntityDecl(java.lang.String name,
+                               java.lang.String value)
+                        throws SAXException
+
+
Description copied from interface: DeclHandler
+
Report an internal entity declaration. + +

Only the effective (first) declaration for each entity + will be reported. All parameter entities in the value + will be expanded, but general entities will not.

+
Specified by:
internalEntityDecl in interface DeclHandler
+
+
Tags copied from interface: DeclHandler
+
+
Parameters:
name - The name of the entity. If it is a parameter + entity, the name will begin with '%'.
value - The replacement text of the entity.
Throws:
SAXException - The application may raise an exception.
See Also:
DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String), +DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
+
+
+
+ +

+externalEntityDecl

+
+public void externalEntityDecl(java.lang.String name,
+                               java.lang.String publicId,
+                               java.lang.String systemId)
+                        throws SAXException
+
+
Description copied from interface: DeclHandler
+
Report a parsed external entity declaration. + +

Only the effective (first) declaration for each entity + will be reported.

+
Specified by:
externalEntityDecl in interface DeclHandler
+
+
Tags copied from interface: DeclHandler
+
+
Parameters:
name - The name of the entity. If it is a parameter + entity, the name will begin with '%'.
publicId - The declared public identifier of the entity, or + null if none was declared.
systemId - The declared system identifier of the entity.
Throws:
SAXException - The application may raise an exception.
See Also:
DeclHandler.internalEntityDecl(java.lang.String, java.lang.String), +DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
+
+
+
+ +

+unparsedEntityDecl

+
+public void unparsedEntityDecl(java.lang.String name,
+                               java.lang.String publicId,
+                               java.lang.String systemId,
+                               java.lang.String notationName)
+                        throws SAXException
+
+
Description copied from interface: DTDHandler
+
Receive notification of an unparsed entity declaration event. + +

Note that the notation name corresponds to a notation + reported by the notationDecl event. + It is up to the application to record the entity for later + reference, if necessary.

+ +

If the system identifier is a URL, the parser must resolve it + fully before passing it to the application.

+
Specified by:
unparsedEntityDecl in interface DTDHandler
+
+
Tags copied from interface: DTDHandler
+
+
Parameters:
name - The unparsed entity's name.
publicId - The entity's public identifier, or null if none + was given.
systemId - The entity's system identifier.
notation - name The name of the associated notation.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String), +AttributeList
+
+
+
+ +

+notationDecl

+
+public void notationDecl(java.lang.String name,
+                         java.lang.String publicId,
+                         java.lang.String systemId)
+                  throws SAXException
+
+
Description copied from interface: DTDHandler
+
Receive notification of a notation declaration event. + +

It is up to the application to record the notation for later + reference, if necessary.

+ +

At least one of publicId and systemId must be non-null. + If a system identifier is present, and it is a URL, the SAX + parser must resolve it fully before passing it to the + application through this event.

+ +

There is no guarantee that the notation declaration will be + reported before any unparsed entities that use it.

+
Specified by:
notationDecl in interface DTDHandler
+
+
Tags copied from interface: DTDHandler
+
+
Parameters:
name - The notation name.
publicId - The notation's public identifier, or null if + none was given.
systemId - The notation's system identifier, or null if + none was given.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String), +AttributeList
+
+
+
+ +

+serializeNode

+
+protected void serializeNode(Node node)
+                      throws java.io.IOException
+
+
Serialize the DOM node. This method is shared across XML, HTML and XHTML + serializers and the differences are masked out in a separate serializeElement(org.w3c.dom.Element).
+
+
+
+
Parameters:
node - The node to serialize
Throws:
java.io.IOException - An I/O exception occured while + serializing
See Also:
serializeElement(org.w3c.dom.Element)
+
+
+
+ +

+content

+
+protected ElementState content()
+                        throws java.io.IOException
+
+
Must be called by a method about to print any type of content. + If the element was just opened, the opening tag is closed and + will be matched to a closing tag. Returns the current element + state with empty and afterElement set to false.
+
+
+
+
Returns:
The current element state
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+characters

+
+protected void characters(java.lang.String text)
+                   throws java.io.IOException
+
+
Called to print the text contents in the prevailing element format. + Since this method is capable of printing text as CDATA, it is used + for that purpose as well. White space handling is determined by the + current element state. In addition, the output format can dictate + whether the text is printed as CDATA or unescaped.
+
+
+
+
Parameters:
text - The text to print
unescaped - True is should print unescaped
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+getEntityRef

+
+protected abstract java.lang.String getEntityRef(int ch)
+
+
Returns the suitable entity reference for this character value, + or null if no such entity exists. Calling this method with '&' + will return "&".
+
+
+
+
Parameters:
ch - Character value
Returns:
Character entity name, or null
+
+
+
+ +

+serializeElement

+
+protected abstract void serializeElement(Element elem)
+                                  throws java.io.IOException
+
+
Called to serializee the DOM element. The element is serialized based on + the serializer's method (XML, HTML, XHTML).
+
+
+
+
Parameters:
elem - The element to serialize
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+serializePreRoot

+
+protected void serializePreRoot()
+                         throws java.io.IOException
+
+
Comments and PIs cannot be serialized before the root element, + because the root element serializes the document type, which + generally comes first. Instead such PIs and comments are + accumulated inside a vector and serialized by calling this + method. Will be called when the root element is serialized + and when the document finished serializing.
+
+
+
+
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+printText

+
+protected final void printText(char[] chars,
+                               int start,
+                               int length,
+                               boolean preserveSpace,
+                               boolean unescaped)
+                        throws java.io.IOException
+
+
Called to print additional text with whitespace handling. + If spaces are preserved, the text is printed as if by calling + #printText(String) with a call to #breakLine + for each new line. If spaces are not preserved, the text is + broken at space boundaries if longer than the line width; + Multiple spaces are printed as such, but spaces at beginning + of line are removed.
+
+
+
+
Parameters:
text - The text to print
preserveSpace - Space preserving flag
unescaped - Print unescaped
+
+
+
+ +

+printText

+
+protected final void printText(java.lang.String text,
+                               boolean preserveSpace,
+                               boolean unescaped)
+                        throws java.io.IOException
+
+
+
+
+
+
+ +

+printDoctypeURL

+
+protected void printDoctypeURL(java.lang.String url)
+                        throws java.io.IOException
+
+
Print a document type public or system identifier URL. + Encapsulates the URL in double quotes, escapes non-printing + characters and print it equivalent to printText(char[], int, int, boolean, boolean).
+
+
+
+
Parameters:
url - The document type url to print
+
+
+
+ +

+printEscaped

+
+protected void printEscaped(int ch)
+                     throws java.io.IOException
+
+
+
+
+
+
+ +

+printEscaped

+
+protected void printEscaped(java.lang.String source)
+                     throws java.io.IOException
+
+
Escapes a string so it may be printed as text content or attribute + value. Non printable characters are escaped using character references. + Where the format specifies a deault entity reference, that reference + is used (e.g. <).
+
+
+
+
Parameters:
source - The string to escape
+
+
+
+ +

+getElementState

+
+protected ElementState getElementState()
+
+
Return the state of the current element.
+
+
+
+
Returns:
Current element state
+
+
+
+ +

+enterElementState

+
+protected ElementState enterElementState(java.lang.String namespaceURI,
+                                         java.lang.String localName,
+                                         java.lang.String rawName,
+                                         boolean preserveSpace)
+
+
Enter a new element state for the specified element. + Tag name and space preserving is specified, element + state is initially empty.
+
+
+
+
Returns:
Current element state, or null
+
+
+
+ +

+leaveElementState

+
+protected ElementState leaveElementState()
+
+
Leave the current element state and return to the + state of the parent element. If this was the root + element, return to the state of the document.
+
+
+
+
Returns:
Previous element state
+
+
+
+ +

+isDocumentState

+
+protected boolean isDocumentState()
+
+
Returns true if in the state of the document. + Returns true before entering any element and after + leaving the root element.
+
+
+
+
Returns:
True if in the state of the document
+
+
+
+ +

+getPrefix

+
+protected java.lang.String getPrefix(java.lang.String namespaceURI)
+
+
Returns the namespace prefix for the specified URI. + If the URI has been mapped to a prefix, returns the + prefix, otherwise returns null.
+
+
+
+
Parameters:
namespaceURI - The namespace URI
Returns:
The namespace prefix if known, or null
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/DOMSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/DOMSerializer.html new file mode 100644 index 0000000..6e2e616 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/DOMSerializer.html @@ -0,0 +1,226 @@ + + + + + + +Xerces-J API: Interface DOMSerializer + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Interface DOMSerializer

+
+
All Known Implementing Classes:
BaseMarkupSerializer
+
+
+
+
public interface DOMSerializer
+ +

+Interface for a DOM serializer implementation. +

+

+
Version:
$Revision: 1.3 $ $Date: 2000/08/30 18:59:19 $
+
Author:
Scott Boag, Assaf Arkin
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidserialize(Document doc) + +
+          Serializes the DOM document.
+ voidserialize(DocumentFragment frag) + +
+          Serializes the DOM document fragment.
+ voidserialize(Element elem) + +
+          Serialized the DOM element.
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+serialize

+
+public void serialize(Element elem)
+               throws java.io.IOException
+
+
Serialized the DOM element. Throws an exception only if + an I/O exception occured while serializing.
+
Parameters:
elem - The element to serialize
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+serialize

+
+public void serialize(Document doc)
+               throws java.io.IOException
+
+
Serializes the DOM document. Throws an exception only if + an I/O exception occured while serializing.
+
Parameters:
doc - The document to serialize
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+serialize

+
+public void serialize(DocumentFragment frag)
+               throws java.io.IOException
+
+
Serializes the DOM document fragment. Throws an exception + only if an I/O exception occured while serializing.
+
Parameters:
frag - The document fragment to serialize
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/ElementState.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/ElementState.html new file mode 100644 index 0000000..9aa03fb --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/ElementState.html @@ -0,0 +1,195 @@ + + + + + + +Xerces-J API: Class ElementState + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class ElementState

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.ElementState
+
+
+
+
public class ElementState
extends java.lang.Object
+ +

+Holds the state of the currently serialized element. +

+

+
Version:
$Revision: 1.8 $ $Date: 2001/07/20 20:37:06 $
+
Author:
Assaf Arkin
+
See Also:
BaseMarkupSerializer
+
+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
ElementState() + +
+           
+  + + + + + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+ElementState

+
+public ElementState()
+
+
+ + + + +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/EncodingInfo.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/EncodingInfo.html new file mode 100644 index 0000000..f73ac9f --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/EncodingInfo.html @@ -0,0 +1,288 @@ + + + + + + +Xerces-J API: Class EncodingInfo + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class EncodingInfo

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.EncodingInfo
+
+
+
Direct Known Subclasses:
SieveEncodingInfo
+
+
+
+
public class EncodingInfo
extends java.lang.Object
+ +

+This class represents an encoding. +

+

+
Version:
$Id: EncodingInfo.java,v 1.1 2000/12/14 19:21:50 lehors Exp $
+
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Constructor Summary
EncodingInfo(java.lang.String mimeName, + int lastPrintable) + +
+          Creates new EncodingInfo instance.
EncodingInfo(java.lang.String mimeName, + java.lang.String javaName, + int lastPrintable) + +
+          Creates new EncodingInfo instance.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.StringgetName() + +
+          Returns a MIME charset name of this encoding.
+ java.io.WritergetWriter(java.io.OutputStream output) + +
+          Returns a writer for this encoding based on + an output stream.
+ booleanisPrintable(int ch) + +
+          Checks whether the specified character is printable or not.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+EncodingInfo

+
+public EncodingInfo(java.lang.String mimeName,
+                    java.lang.String javaName,
+                    int lastPrintable)
+
+
Creates new EncodingInfo instance.
+
+ +

+EncodingInfo

+
+public EncodingInfo(java.lang.String mimeName,
+                    int lastPrintable)
+
+
Creates new EncodingInfo instance.
+ + + + + + + + +
+Method Detail
+ +

+getName

+
+public java.lang.String getName()
+
+
Returns a MIME charset name of this encoding.
+
+ +

+getWriter

+
+public java.io.Writer getWriter(java.io.OutputStream output)
+                         throws java.io.UnsupportedEncodingException
+
+
Returns a writer for this encoding based on + an output stream.
+
Returns:
A suitable writer
Throws:
java.io.UnsupportedEncodingException - There is no convertor + to support this encoding
+
+
+
+ +

+isPrintable

+
+public boolean isPrintable(int ch)
+
+
Checks whether the specified character is printable or not.
+
Parameters:
ch - a code point (0-0x10ffff)
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Encodings.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Encodings.html new file mode 100644 index 0000000..5b45edf --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Encodings.html @@ -0,0 +1,198 @@ + + + + + + +Xerces-J API: Class Encodings + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class Encodings

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.Encodings
+
+
+
+
public class Encodings
extends java.lang.Object
+ +

+Provides information about encodings. Depends on the Java runtime + to provides writers for the different encodings, but can be used + to override encoding names and provide the last printable character + for each encoding. +

+

+
Version:
$Id: Encodings.java,v 1.4 2001/07/20 20:37:06 elena Exp $
+
Author:
Assaf Arkin
+
+
+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
Encodings() + +
+           
+  + + + + + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+Encodings

+
+public Encodings()
+
+
+ + + + +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/HTMLSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/HTMLSerializer.html new file mode 100644 index 0000000..7d5fbcb --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/HTMLSerializer.html @@ -0,0 +1,843 @@ + + + + + + +Xerces-J API: Class HTMLSerializer + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class HTMLSerializer

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.BaseMarkupSerializer
+        |
+        +--org.apache.xml.serialize.HTMLSerializer
+
+
+
Direct Known Subclasses:
XHTMLSerializer
+
+
+
+
public class HTMLSerializer
extends BaseMarkupSerializer
+ +

+Implements an HTML/XHTML serializer supporting both DOM and SAX + pretty serializing. HTML/XHTML mode is determined in the + constructor. For usage instructions see Serializer. +

+ If an output stream is used, the encoding is taken from the + output format (defaults to UTF-8). If a writer is + used, make sure the writer uses the same encoding (if applies) + as specified in the output format. +

+ The serializer supports both DOM and SAX. DOM serializing is done + by calling BaseMarkupSerializer.serialize(org.w3c.dom.Element) and SAX serializing is done by firing + SAX events and using the serializer as a document handler. +

+ If an I/O exception occurs while serializing, the serializer + will not throw an exception directly, but only throw it + at the end of serializing (either DOM or SAX's DocumentHandler.endDocument(). +

+ For elements that are not specified as whitespace preserving, + the serializer will potentially break long text lines at space + boundaries, indent lines, and serialize elements on separate + lines. Line terminators will be regarded as spaces, and + spaces at beginning of line will be stripped. +

+ XHTML is slightly different than HTML: +

+

+

+
Version:
$Revision: 1.15.2.1 $ $Date: 2001/11/07 19:00:34 $
+
Author:
Assaf Arkin
+
See Also:
Serializer
+
+ +

+ + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringXHTMLNamespace + +
+           
+ + + + + + + +
Fields inherited from class org.apache.xml.serialize.BaseMarkupSerializer
_docTypePublicId, +_docTypeSystemId, +_format, +_indenting, +_prefixes, +_printer, +_started
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
+ HTMLSerializer() + +
+          Constructs a new serializer.
+protected HTMLSerializer(boolean xhtml, + OutputFormat format) + +
+          Constructs a new HTML/XHTML serializer depending on the value of + xhtml.
+ HTMLSerializer(OutputFormat format) + +
+          Constructs a new serializer.
+ HTMLSerializer(java.io.OutputStream output, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified output + stream using the specified output format.
+ HTMLSerializer(java.io.Writer writer, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified writer + using the specified output format.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcharacters(char[] chars, + int start, + int length) + +
+          Receive notification of character data.
+protected  voidcharacters(java.lang.String text) + +
+          Called to print the text contents in the prevailing element format.
+ voidendElement(java.lang.String tagName) + +
+          Receive notification of the end of an element.
+ voidendElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String rawName) + +
+          Receive notification of the end of an element.
+ voidendElementIO(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String rawName) + +
+           
+protected  java.lang.StringescapeURI(java.lang.String uri) + +
+           
+protected  java.lang.StringgetEntityRef(int ch) + +
+          Returns the suitable entity reference for this character value, + or null if no such entity exists.
+protected  voidserializeElement(Element elem) + +
+          Called to serialize a DOM element.
+ voidsetOutputFormat(OutputFormat format) + +
+          Specifies an output format for this serializer.
+protected  voidstartDocument(java.lang.String rootTagName) + +
+          Called to serialize the document's DOCTYPE by the root element.
+ voidstartElement(java.lang.String tagName, + AttributeList attrs) + +
+          Receive notification of the beginning of an element.
+ voidstartElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String rawName, + Attributes attrs) + +
+          Receive notification of the beginning of an element.
+ + + + + + + +
Methods inherited from class org.apache.xml.serialize.BaseMarkupSerializer
asContentHandler, +asDocumentHandler, +asDOMSerializer, +attributeDecl, +comment, +comment, +content, +elementDecl, +endCDATA, +endDocument, +endDTD, +endEntity, +endNonEscaping, +endPrefixMapping, +endPreserving, +enterElementState, +externalEntityDecl, +getElementState, +getPrefix, +ignorableWhitespace, +internalEntityDecl, +isDocumentState, +leaveElementState, +notationDecl, +prepare, +printDoctypeURL, +printEscaped, +printEscaped, +printText, +printText, +processingInstruction, +processingInstructionIO, +reset, +serialize, +serialize, +serialize, +serializeNode, +serializePreRoot, +setDocumentLocator, +setOutputByteStream, +setOutputCharStream, +skippedEntity, +startCDATA, +startDocument, +startDTD, +startEntity, +startNonEscaping, +startPrefixMapping, +startPreserving, +unparsedEntityDecl
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+XHTMLNamespace

+
+public static java.lang.String XHTMLNamespace
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+HTMLSerializer

+
+protected HTMLSerializer(boolean xhtml,
+                         OutputFormat format)
+
+
Constructs a new HTML/XHTML serializer depending on the value of + xhtml. The serializer cannot be used without calling + #init first.
+
Parameters:
xhtml - True if XHTML serializing
+
+
+
+ +

+HTMLSerializer

+
+public HTMLSerializer()
+
+
Constructs a new serializer. The serializer cannot be used without + calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) + first.
+
+ +

+HTMLSerializer

+
+public HTMLSerializer(OutputFormat format)
+
+
Constructs a new serializer. The serializer cannot be used without + calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) + first.
+
+ +

+HTMLSerializer

+
+public HTMLSerializer(java.io.Writer writer,
+                      OutputFormat format)
+
+
Constructs a new serializer that writes to the specified writer + using the specified output format. If format is null, + will use a default output format.
+
Parameters:
writer - The writer to use
format - The output format to use, null for the default
+
+
+
+ +

+HTMLSerializer

+
+public HTMLSerializer(java.io.OutputStream output,
+                      OutputFormat format)
+
+
Constructs a new serializer that writes to the specified output + stream using the specified output format. If format + is null, will use a default output format.
+
Parameters:
output - The output stream to use
format - The output format to use, null for the default
+
+
+ + + + + + + + +
+Method Detail
+ +

+setOutputFormat

+
+public void setOutputFormat(OutputFormat format)
+
+
Description copied from interface: Serializer
+
Specifies an output format for this serializer. It the + serializer has already been associated with an output format, + it will switch to the new format. This method should not be + called while the serializer is in the process of serializing + a document.
+
Overrides:
setOutputFormat in class BaseMarkupSerializer
+
+
Tags copied from interface: Serializer
+
+
Parameters:
format - The output format to use
+
+
+
+ +

+startElement

+
+public void startElement(java.lang.String namespaceURI,
+                         java.lang.String localName,
+                         java.lang.String rawName,
+                         Attributes attrs)
+                  throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of the beginning of an element. + +

The Parser will invoke this method at the beginning of every + element in the XML document; there will be a corresponding + endElement event for every startElement event + (even when the element is empty). All of the element's content will be + reported, in order, before the corresponding endElement + event.

+ +

This event allows up to three name components for each + element:

+ +
    +
  1. the Namespace URI;
  2. +
  3. the local name; and
  4. +
  5. the qualified (prefixed) name.
  6. +
+ +

Any or all of these may be provided, depending on the + values of the http://xml.org/sax/features/namespaces + and the http://xml.org/sax/features/namespace-prefixes + properties:

+ + + +

Note that the attribute list provided will contain only + attributes with explicit values (specified or defaulted): + #IMPLIED attributes will be omitted. The attribute list + will contain attributes used for Namespace declarations + (xmlns* attributes) only if the + http://xml.org/sax/features/namespace-prefixes + property is true (it is false by default, and support for a + true value is optional).

Tags copied from interface: ContentHandler
+
+
Parameters:
uri - The Namespace URI, or the empty string if the + element has no Namespace URI or if Namespace + processing is not being performed.
localName - The local name (without prefix), or the + empty string if Namespace processing is not being + performed.
qName - The qualified name (with prefix), or the + empty string if qualified names are not available.
atts - The attributes attached to the element. If + there are no attributes, it shall be an empty + Attributes object.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String), +Attributes
+
+
+
+ +

+endElement

+
+public void endElement(java.lang.String namespaceURI,
+                       java.lang.String localName,
+                       java.lang.String rawName)
+                throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of the end of an element. + +

The SAX parser will invoke this method at the end of every + element in the XML document; there will be a corresponding + startElement event for every endElement + event (even when the element is empty).

+ +

For information on the names, see startElement.

Tags copied from interface: ContentHandler
+
+
Parameters:
uri - The Namespace URI, or the empty string if the + element has no Namespace URI or if Namespace + processing is not being performed.
localName - The local name (without prefix), or the + empty string if Namespace processing is not being + performed.
qName - The qualified XML 1.0 name (with prefix), or the + empty string if qualified names are not available.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
+
+
+
+ +

+endElementIO

+
+public void endElementIO(java.lang.String namespaceURI,
+                         java.lang.String localName,
+                         java.lang.String rawName)
+                  throws java.io.IOException
+
+
+
+ +

+characters

+
+public void characters(char[] chars,
+                       int start,
+                       int length)
+                throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of character data. + +

The Parser will call this method to report each chunk of + character data. SAX parsers may return all contiguous character + data in a single chunk, or they may split it into several + chunks; however, all of the characters in any single event + must come from the same external entity so that the Locator + provides useful information.

+ +

The application must not attempt to read from the array + outside of the specified range.

+ +

Note that some parsers will report whitespace in element + content using the ignorableWhitespace + method rather than this one (validating parsers must + do so).

+
Overrides:
characters in class BaseMarkupSerializer
+
+
Tags copied from interface: ContentHandler
+
+
Parameters:
ch - The characters from the XML document.
start - The start position in the array.
length - The number of characters to read from the array.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
ContentHandler.ignorableWhitespace(char[], int, int), +Locator
+
+
+
+ +

+startElement

+
+public void startElement(java.lang.String tagName,
+                         AttributeList attrs)
+                  throws SAXException
+
+
Description copied from interface: DocumentHandler
+
Receive notification of the beginning of an element. + +

The Parser will invoke this method at the beginning of every + element in the XML document; there will be a corresponding + endElement() event for every startElement() event (even when the + element is empty). All of the element's content will be + reported, in order, before the corresponding endElement() + event.

+ +

If the element name has a namespace prefix, the prefix will + still be attached. Note that the attribute list provided will + contain only attributes with explicit values (specified or + defaulted): #IMPLIED attributes will be omitted.

Tags copied from interface: DocumentHandler
+
+
Parameters:
name - The element type name.
atts - The attributes attached to the element, if any.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
DocumentHandler.endElement(java.lang.String), +AttributeList
+
+
+
+ +

+endElement

+
+public void endElement(java.lang.String tagName)
+                throws SAXException
+
+
Description copied from interface: DocumentHandler
+
Receive notification of the end of an element. + +

The SAX parser will invoke this method at the end of every + element in the XML document; there will be a corresponding + startElement() event for every endElement() event (even when the + element is empty).

+ +

If the element name has a namespace prefix, the prefix will + still be attached to the name.

Tags copied from interface: DocumentHandler
+
+
Parameters:
name - The element type name
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
+
+
+
+ +

+startDocument

+
+protected void startDocument(java.lang.String rootTagName)
+                      throws java.io.IOException
+
+
Called to serialize the document's DOCTYPE by the root element. + The document type declaration must name the root element, + but the root element is only known when that element is serialized, + and not at the start of the document. +

+ This method will check if it has not been called before (BaseMarkupSerializer._started), + will serialize the document type declaration, and will serialize all + pre-root comments and PIs that were accumulated in the document + (see BaseMarkupSerializer.serializePreRoot()). Pre-root will be serialized even if + this is not the first root element of the document.

+
+ +

+serializeElement

+
+protected void serializeElement(Element elem)
+                         throws java.io.IOException
+
+
Called to serialize a DOM element. Equivalent to calling startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes), endElement(java.lang.String, java.lang.String, java.lang.String) and serializing everything + inbetween, but better optimized.
+
Overrides:
serializeElement in class BaseMarkupSerializer
+
+
Tags copied from class: BaseMarkupSerializer
+
+
Parameters:
elem - The element to serialize
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+characters

+
+protected void characters(java.lang.String text)
+                   throws java.io.IOException
+
+
Description copied from class: BaseMarkupSerializer
+
Called to print the text contents in the prevailing element format. + Since this method is capable of printing text as CDATA, it is used + for that purpose as well. White space handling is determined by the + current element state. In addition, the output format can dictate + whether the text is printed as CDATA or unescaped.
+
Overrides:
characters in class BaseMarkupSerializer
+
+
Tags copied from class: BaseMarkupSerializer
+
+
Parameters:
text - The text to print
unescaped - True is should print unescaped
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+getEntityRef

+
+protected java.lang.String getEntityRef(int ch)
+
+
Description copied from class: BaseMarkupSerializer
+
Returns the suitable entity reference for this character value, + or null if no such entity exists. Calling this method with '&' + will return "&".
+
Overrides:
getEntityRef in class BaseMarkupSerializer
+
+
Tags copied from class: BaseMarkupSerializer
+
+
Parameters:
ch - Character value
Returns:
Character entity name, or null
+
+
+
+ +

+escapeURI

+
+protected java.lang.String escapeURI(java.lang.String uri)
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/HTMLdtd.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/HTMLdtd.html new file mode 100644 index 0000000..509c67e --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/HTMLdtd.html @@ -0,0 +1,512 @@ + + + + + + +Xerces-J API: Class HTMLdtd + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class HTMLdtd

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.HTMLdtd
+
+
+
+
public final class HTMLdtd
extends java.lang.Object
+ +

+Utility class for accessing information specific to HTML documents. + The HTML DTD is expressed as three utility function groups. Two methods + allow for checking whether an element requires an open tag on printing + (isEmptyTag(java.lang.String)) or on parsing (isOptionalClosing(java.lang.String)). +

+ Two other methods translate character references from name to value and + from value to name. A small entities resource is loaded into memory the + first time any of these methods is called for fast and efficient access. +

+

+
Version:
$Revision: 1.12 $ $Date: 2001/04/18 06:02:49 $
+
Author:
Assaf Arkin
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringHTMLPublicId + +
+          Public identifier for HTML document type.
+static java.lang.StringHTMLSystemId + +
+          System identifier for HTML document type.
+static java.lang.StringXHTMLPublicId + +
+          Public identifier for XHTML document type.
+static java.lang.StringXHTMLSystemId + +
+          System identifier for XHTML document type.
+  + + + + + + + + + + +
+Constructor Summary
HTMLdtd() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static intcharFromName(java.lang.String name) + +
+          Returns the value of an HTML character reference by its name.
+static java.lang.StringfromChar(int value) + +
+          Returns the name of an HTML character reference based on its character + value.
+static booleanisBoolean(java.lang.String tagName, + java.lang.String attrName) + +
+          Returns true if the specified attribute is a boolean and should be + printed without the value.
+static booleanisClosing(java.lang.String tagName, + java.lang.String openTag) + +
+          Returns true if the opening of one element (tagName) implies + the closing of another open element (openTag).
+static booleanisElementContent(java.lang.String tagName) + +
+          Returns true if element is declared to have element content.
+static booleanisEmptyTag(java.lang.String tagName) + +
+          Returns true if element is declared to be empty.
+static booleanisOnlyOpening(java.lang.String tagName) + +
+          Returns true if element's closing tag is generally not printed.
+static booleanisOptionalClosing(java.lang.String tagName) + +
+          Returns true if element's closing tag is optional and need not + exist.
+static booleanisPreserveSpace(java.lang.String tagName) + +
+          Returns true if element's textual contents preserves spaces.
+static booleanisURI(java.lang.String tagName, + java.lang.String attrName) + +
+          Returns true if the specified attribute it a URI and should be + escaped appropriately.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+HTMLPublicId

+
+public static final java.lang.String HTMLPublicId
+
+
Public identifier for HTML document type.
+
+ +

+HTMLSystemId

+
+public static final java.lang.String HTMLSystemId
+
+
System identifier for HTML document type.
+
+ +

+XHTMLPublicId

+
+public static final java.lang.String XHTMLPublicId
+
+
Public identifier for XHTML document type.
+
+ +

+XHTMLSystemId

+
+public static final java.lang.String XHTMLSystemId
+
+
System identifier for XHTML document type.
+ + + + + + + + +
+Constructor Detail
+ +

+HTMLdtd

+
+public HTMLdtd()
+
+
+ + + + + + + + +
+Method Detail
+ +

+isEmptyTag

+
+public static boolean isEmptyTag(java.lang.String tagName)
+
+
Returns true if element is declared to be empty. HTML elements are + defines as empty in the DTD, not by the document syntax.
+
Parameters:
tagName - The element tag name (upper case)
Returns:
True if element is empty
+
+
+
+ +

+isElementContent

+
+public static boolean isElementContent(java.lang.String tagName)
+
+
Returns true if element is declared to have element content. + Whitespaces appearing inside element content will be ignored, + other text will simply report an error.
+
Parameters:
tagName - The element tag name (upper case)
Returns:
True if element content
+
+
+
+ +

+isPreserveSpace

+
+public static boolean isPreserveSpace(java.lang.String tagName)
+
+
Returns true if element's textual contents preserves spaces. + This only applies to PRE and TEXTAREA, all other HTML elements + do not preserve space.
+
Parameters:
tagName - The element tag name (upper case)
Returns:
True if element's text content preserves spaces
+
+
+
+ +

+isOptionalClosing

+
+public static boolean isOptionalClosing(java.lang.String tagName)
+
+
Returns true if element's closing tag is optional and need not + exist. An error will not be reported for such elements if they + are not closed. For example, LI is most often not closed.
+
Parameters:
tagName - The element tag name (upper case)
Returns:
True if closing tag implied
+
+
+
+ +

+isOnlyOpening

+
+public static boolean isOnlyOpening(java.lang.String tagName)
+
+
Returns true if element's closing tag is generally not printed. + For example, LI should not print the closing tag.
+
Parameters:
tagName - The element tag name (upper case)
Returns:
True if only opening tag should be printed
+
+
+
+ +

+isClosing

+
+public static boolean isClosing(java.lang.String tagName,
+                                java.lang.String openTag)
+
+
Returns true if the opening of one element (tagName) implies + the closing of another open element (openTag). For example, + every opening LI will close the previously open LI, + and every opening BODY will close the previously open HEAD.
+
Parameters:
tagName - The newly opened element
openTag - The already opened element
Returns:
True if closing tag closes opening tag
+
+
+
+ +

+isURI

+
+public static boolean isURI(java.lang.String tagName,
+                            java.lang.String attrName)
+
+
Returns true if the specified attribute it a URI and should be + escaped appropriately. In HTML URIs are escaped differently + than normal attributes.
+
Parameters:
tagName - The element's tag name
attrName - The attribute's name
+
+
+
+ +

+isBoolean

+
+public static boolean isBoolean(java.lang.String tagName,
+                                java.lang.String attrName)
+
+
Returns true if the specified attribute is a boolean and should be + printed without the value. This applies to attributes that are true + if they exist, such as selected (OPTION/INPUT).
+
Parameters:
tagName - The element's tag name
attrName - The attribute's name
+
+
+
+ +

+charFromName

+
+public static int charFromName(java.lang.String name)
+
+
Returns the value of an HTML character reference by its name. If the + reference is not found or was not defined as a character reference, + returns EOF (-1).
+
Parameters:
name - Name of character reference
Returns:
Character code or EOF (-1)
+
+
+
+ +

+fromChar

+
+public static java.lang.String fromChar(int value)
+
+
Returns the name of an HTML character reference based on its character + value. Only valid for entities defined from character references. If no + such character value was defined, return null.
+
Parameters:
value - Character value of entity
Returns:
Entity's name or null
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/IndentPrinter.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/IndentPrinter.html new file mode 100644 index 0000000..a7973ba --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/IndentPrinter.html @@ -0,0 +1,543 @@ + + + + + + +Xerces-J API: Class IndentPrinter + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class IndentPrinter

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.Printer
+        |
+        +--org.apache.xml.serialize.IndentPrinter
+
+
+
+
public class IndentPrinter
extends Printer
+ +

+Extends Printer and adds support for indentation and line + wrapping. +

+

+
Version:
$Revision: 1.4 $ $Date: 2001/07/20 20:37:06 $
+
Author:
Assaf Arkin
+
+
+ +

+ + + + + + + + + + + + + +
Fields inherited from class org.apache.xml.serialize.Printer
_docWriter, +_dtdWriter, +_exception, +_format, +_writer
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidbreakLine() + +
+          Called to print a line consisting of the text accumulated so + far.
+ voidbreakLine(boolean preserveSpace) + +
+           
+ voidenterDTD() + +
+          Called by any of the DTD handlers to enter DTD mode.
+ voidflush() + +
+          Flush the output stream.
+ voidflushLine(boolean preserveSpace) + +
+          Flushes the line accumulated so far to the writer and get ready + to accumulate the next line.
+ intgetNextIndent() + +
+           
+ voidindent() + +
+          Increment the indentation for the next line.
+ java.lang.StringleaveDTD() + +
+          Called by the root element to leave DTD mode and if any + DTD parts were printer, will return a string with their + textual content.
+ voidprintSpace() + +
+          Called to print a single space between text parts that may be + broken into separate lines.
+ voidprintText(char ch) + +
+           
+ voidprintText(char[] chars, + int start, + int length) + +
+           
+ voidprintText(java.lang.String text) + +
+          Called to print additional text.
+ voidprintText(java.lang.StringBuffer text) + +
+           
+ voidsetNextIndent(int indent) + +
+           
+ voidsetThisIndent(int indent) + +
+           
+ voidunindent() + +
+          Decrement the indentation for the next line.
+ + + + + + + +
Methods inherited from class org.apache.xml.serialize.Printer
getException
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+enterDTD

+
+public void enterDTD()
+
+
Called by any of the DTD handlers to enter DTD mode. + Once entered, all output will be accumulated in a string + that can be printed as part of the document's DTD. + This method may be called any number of time but will only + have affect the first time it's called. To exist DTD state + and get the accumulated DTD, call leaveDTD().
+
Overrides:
enterDTD in class Printer
+
+
+
+ +

+leaveDTD

+
+public java.lang.String leaveDTD()
+
+
Called by the root element to leave DTD mode and if any + DTD parts were printer, will return a string with their + textual content.
+
Overrides:
leaveDTD in class Printer
+
+
+
+ +

+printText

+
+public void printText(java.lang.String text)
+
+
Called to print additional text. Each time this method is called + it accumulates more text. When a space is printed (printSpace()) all the accumulated text becomes one part and is + added to the accumulate line. When a line is long enough, it can + be broken at its text boundary.
+
Overrides:
printText in class Printer
+
+
+
Parameters:
text - The text to print
+
+
+
+ +

+printText

+
+public void printText(java.lang.StringBuffer text)
+
+
+
Overrides:
printText in class Printer
+
+
+
+ +

+printText

+
+public void printText(char ch)
+
+
+
Overrides:
printText in class Printer
+
+
+
+ +

+printText

+
+public void printText(char[] chars,
+                      int start,
+                      int length)
+
+
+
Overrides:
printText in class Printer
+
+
+
+ +

+printSpace

+
+public void printSpace()
+
+
Called to print a single space between text parts that may be + broken into separate lines. Must not be called to print a space + when preserving spaces. The text accumulated so far with printText(java.lang.String) will be added to the accumulated line, and a space + separator will be counted. If the line accumulated so far is + long enough, it will be printed.
+
Overrides:
printSpace in class Printer
+
+
+
+ +

+breakLine

+
+public void breakLine()
+
+
Called to print a line consisting of the text accumulated so + far. This is equivalent to calling printSpace() but + forcing the line to print and starting a new line (printSpace() will only start a new line if the current line + is long enough).
+
Overrides:
breakLine in class Printer
+
+
+
+ +

+breakLine

+
+public void breakLine(boolean preserveSpace)
+
+
+
Overrides:
breakLine in class Printer
+
+
+
+ +

+flushLine

+
+public void flushLine(boolean preserveSpace)
+
+
Flushes the line accumulated so far to the writer and get ready + to accumulate the next line. This method is called by printText(java.lang.String) and printSpace() when the accumulated line plus + accumulated text are two long to fit on a given line. At the end of + this method #_line is empty and #_spaces is zero.
+
Overrides:
flushLine in class Printer
+
+
+
+ +

+flush

+
+public void flush()
+
+
Flush the output stream. Must be called when done printing + the document, otherwise some text might be buffered.
+
Overrides:
flush in class Printer
+
+
+
+ +

+indent

+
+public void indent()
+
+
Increment the indentation for the next line.
+
Overrides:
indent in class Printer
+
+
+
+ +

+unindent

+
+public void unindent()
+
+
Decrement the indentation for the next line.
+
Overrides:
unindent in class Printer
+
+
+
+ +

+getNextIndent

+
+public int getNextIndent()
+
+
+
Overrides:
getNextIndent in class Printer
+
+
+
+ +

+setNextIndent

+
+public void setNextIndent(int indent)
+
+
+
Overrides:
setNextIndent in class Printer
+
+
+
+ +

+setThisIndent

+
+public void setThisIndent(int indent)
+
+
+
Overrides:
setThisIndent in class Printer
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/LineSeparator.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/LineSeparator.html new file mode 100644 index 0000000..75a4552 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/LineSeparator.html @@ -0,0 +1,270 @@ + + + + + + +Xerces-J API: Class LineSeparator + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class LineSeparator

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.LineSeparator
+
+
+
+
public final class LineSeparator
extends java.lang.Object
+ +

+

+
Version:
$Revision: 1.3 $ $Date: 2000/08/30 18:59:21 $
+
Author:
Assaf Arkin
+
See Also:
OutputFormat
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringMacintosh + +
+          Line separator for Macintosh systems (\r).
+static java.lang.StringUnix + +
+          Line separator for Unix systems (\n).
+static java.lang.StringWeb + +
+          Line separator for the Web (\n).
+static java.lang.StringWindows + +
+          Line separator for Windows systems (\r\n).
+  + + + + + + + + + + +
+Constructor Summary
LineSeparator() + +
+           
+  + + + + + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+Unix

+
+public static final java.lang.String Unix
+
+
Line separator for Unix systems (\n).
+
+ +

+Windows

+
+public static final java.lang.String Windows
+
+
Line separator for Windows systems (\r\n).
+
+ +

+Macintosh

+
+public static final java.lang.String Macintosh
+
+
Line separator for Macintosh systems (\r).
+
+ +

+Web

+
+public static final java.lang.String Web
+
+
Line separator for the Web (\n).
+ + + + + + + + +
+Constructor Detail
+ +

+LineSeparator

+
+public LineSeparator()
+
+
+ + + + +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Method.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Method.html new file mode 100644 index 0000000..6e50cc5 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Method.html @@ -0,0 +1,286 @@ + + + + + + +Xerces-J API: Class Method + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class Method

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.Method
+
+
+
+
public final class Method
extends java.lang.Object
+ +

+

+
Version:
$Revision: 1.3 $ $Date: 2000/08/30 18:59:21 $
+
Author:
Assaf Arkin
+
See Also:
OutputFormat
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringFOP + +
+          The output method for FO documents as PDF.
+static java.lang.StringHTML + +
+          The output method for HTML documents.
+static java.lang.StringTEXT + +
+          The output method for text documents.
+static java.lang.StringXHTML + +
+          The output method for HTML documents as XHTML.
+static java.lang.StringXML + +
+          The output method for XML documents.
+  + + + + + + + + + + +
+Constructor Summary
Method() + +
+           
+  + + + + + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+XML

+
+public static final java.lang.String XML
+
+
The output method for XML documents.
+
+ +

+HTML

+
+public static final java.lang.String HTML
+
+
The output method for HTML documents.
+
+ +

+XHTML

+
+public static final java.lang.String XHTML
+
+
The output method for HTML documents as XHTML.
+
+ +

+TEXT

+
+public static final java.lang.String TEXT
+
+
The output method for text documents.
+
+ +

+FOP

+
+public static final java.lang.String FOP
+
+
The output method for FO documents as PDF.
+ + + + + + + + +
+Constructor Detail
+ +

+Method

+
+public Method()
+
+
+ + + + +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/OutputFormat.DTD.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/OutputFormat.DTD.html new file mode 100644 index 0000000..1431e8e --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/OutputFormat.DTD.html @@ -0,0 +1,269 @@ + + + + + + +Xerces-J API: Class OutputFormat.DTD + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class OutputFormat.DTD

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.OutputFormat.DTD
+
+
+
Enclosing class:
OutputFormat
+
+
+
+
public static class OutputFormat.DTD
extends java.lang.Object
+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringHTMLPublicId + +
+          Public identifier for HTML document type.
+static java.lang.StringHTMLSystemId + +
+          System identifier for HTML document type.
+static java.lang.StringXHTMLPublicId + +
+          Public identifier for XHTML document type.
+static java.lang.StringXHTMLSystemId + +
+          System identifier for XHTML document type.
+  + + + + + + + + + + +
+Constructor Summary
OutputFormat.DTD() + +
+           
+  + + + + + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+HTMLPublicId

+
+public static final java.lang.String HTMLPublicId
+
+
Public identifier for HTML document type.
+
+ +

+HTMLSystemId

+
+public static final java.lang.String HTMLSystemId
+
+
System identifier for HTML document type.
+
+ +

+XHTMLPublicId

+
+public static final java.lang.String XHTMLPublicId
+
+
Public identifier for XHTML document type.
+
+ +

+XHTMLSystemId

+
+public static final java.lang.String XHTMLSystemId
+
+
System identifier for XHTML document type.
+ + + + + + + + +
+Constructor Detail
+ +

+OutputFormat.DTD

+
+public OutputFormat.DTD()
+
+
+ + + + +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/OutputFormat.Defaults.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/OutputFormat.Defaults.html new file mode 100644 index 0000000..132b48f --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/OutputFormat.Defaults.html @@ -0,0 +1,263 @@ + + + + + + +Xerces-J API: Class OutputFormat.Defaults + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class OutputFormat.Defaults

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.OutputFormat.Defaults
+
+
+
Enclosing class:
OutputFormat
+
+
+
+
public static class OutputFormat.Defaults
extends java.lang.Object
+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringEncoding + +
+          The default encoding for Web documents it UTF-8.
+static intIndent + +
+          If indentation is turned on, the default identation + level is 4.
+static intLineWidth + +
+          The default line width at which to break long lines + when identing.
+  + + + + + + + + + + +
+Constructor Summary
OutputFormat.Defaults() + +
+           
+  + + + + + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+Indent

+
+public static final int Indent
+
+
If indentation is turned on, the default identation + level is 4.
+
See Also:
OutputFormat.setIndenting(boolean)
+
+
+
+ +

+Encoding

+
+public static final java.lang.String Encoding
+
+
The default encoding for Web documents it UTF-8.
+
See Also:
OutputFormat.getEncoding()
+
+
+
+ +

+LineWidth

+
+public static final int LineWidth
+
+
The default line width at which to break long lines + when identing. This is set to 72.
+ + + + + + + + +
+Constructor Detail
+ +

+OutputFormat.Defaults

+
+public OutputFormat.Defaults()
+
+
+ + + + +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/OutputFormat.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/OutputFormat.html new file mode 100644 index 0000000..b28868b --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/OutputFormat.html @@ -0,0 +1,1211 @@ + + + + + + +Xerces-J API: Class OutputFormat + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class OutputFormat

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.OutputFormat
+
+
+
+
public class OutputFormat
extends java.lang.Object
+ +

+Specifies an output format to control the serializer. Based on the + XSLT specification for output format, plus additional parameters. + Used to select the suitable serializer and determine how the + document should be formatted on output. +

+ The two interesting constructors are: +

+

+

+
Version:
$Revision: 1.11.2.1 $ $Date: 2001/11/07 19:00:34 $
+
Author:
Assaf Arkin + Keith Visco
+
See Also:
Serializer, +Method, +LineSeparator
+
+ +

+ + + + + + + + + + + + + + + +
+Inner Class Summary
+static classOutputFormat.Defaults + +
+           
+static classOutputFormat.DTD + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
OutputFormat() + +
+          Constructs a new output format with the default values.
OutputFormat(Document doc) + +
+          Constructs a new output format with the proper method, + document type identifiers and media type for the specified + document.
OutputFormat(Document doc, + java.lang.String encoding, + boolean indenting) + +
+          Constructs a new output format with the proper method, + document type identifiers and media type for the specified + document, and with the specified encoding.
OutputFormat(java.lang.String method, + java.lang.String encoding, + boolean indenting) + +
+          Constructs a new output format with the default values for + the specified method and encoding.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.String[]getCDataElements() + +
+          Returns a list of all the elements whose text node children + should be output as CDATA, or null if no such elements were + specified.
+ java.lang.StringgetDoctypePublic() + +
+          Returns the specified document type public identifier, + or null.
+ java.lang.StringgetDoctypeSystem() + +
+          Returns the specified document type system identifier, + or null.
+ java.lang.StringgetEncoding() + +
+          Returns the specified encoding.
+ EncodingInfogetEncodingInfo() + +
+          Returns an EncodingInfo instance for the encoding.
+ intgetIndent() + +
+          Returns the indentation specified.
+ booleangetIndenting() + +
+          Returns true if indentation was specified.
+ chargetLastPrintable() + +
+          Returns the last printable character based on the selected + encoding.
+ java.lang.StringgetLineSeparator() + +
+          Returns a specific line separator to use.
+ intgetLineWidth() + +
+          Return the selected line width for breaking up long lines.
+ java.lang.StringgetMediaType() + +
+          Returns the specified media type, or null.
+ java.lang.StringgetMethod() + +
+          Returns the method specified for this output format.
+ java.lang.String[]getNonEscapingElements() + +
+          Returns a list of all the elements whose text node children + should be output unescaped (no character references), or null + if no such elements were specified.
+ booleangetOmitComments() + +
+          Returns true if comments should be ommited.
+ booleangetOmitDocumentType() + +
+          Returns true if the DOCTYPE declaration should + be ommited.
+ booleangetOmitXMLDeclaration() + +
+          Returns true if the XML document declaration should + be ommited.
+ booleangetPreserveEmptyAttributes() + +
+          Returns the preserveEmptyAttribute flag.
+ booleangetPreserveSpace() + +
+          Returns true if the default behavior for this format is to + preserve spaces.
+ booleangetStandalone() + +
+          Returns true if the document type is standalone.
+ java.lang.StringgetVersion() + +
+          Returns the version for this output method.
+ booleanisCDataElement(java.lang.String tagName) + +
+          Returns true if the text node children of the given elements + should be output as CDATA.
+ booleanisNonEscapingElement(java.lang.String tagName) + +
+          Returns true if the text node children of the given elements + should be output unescaped.
+ voidsetCDataElements(java.lang.String[] cdataElements) + +
+          Sets the list of elements for which text node children + should be output as CDATA.
+ voidsetDoctype(java.lang.String publicId, + java.lang.String systemId) + +
+          Sets the document type public and system identifiers.
+ voidsetEncoding(EncodingInfo encInfo) + +
+          Sets the encoding for this output method with an EncodingInfo + instance.
+ voidsetEncoding(java.lang.String encoding) + +
+          Sets the encoding for this output method.
+ voidsetIndent(int indent) + +
+          Sets the indentation.
+ voidsetIndenting(boolean on) + +
+          Sets the indentation on and off.
+ voidsetLineSeparator(java.lang.String lineSeparator) + +
+          Sets the line separator.
+ voidsetLineWidth(int lineWidth) + +
+          Sets the line width.
+ voidsetMediaType(java.lang.String mediaType) + +
+          Sets the media type.
+ voidsetMethod(java.lang.String method) + +
+          Sets the method for this output format.
+ voidsetNonEscapingElements(java.lang.String[] nonEscapingElements) + +
+          Sets the list of elements for which text node children + should be output unescaped (no character references).
+ voidsetOmitComments(boolean omit) + +
+          Sets comment omitting on and off.
+ voidsetOmitDocumentType(boolean omit) + +
+          Sets DOCTYPE declaration omitting on and off.
+ voidsetOmitXMLDeclaration(boolean omit) + +
+          Sets XML declaration omitting on and off.
+ voidsetPreserveEmptyAttributes(boolean preserve) + +
+          Sets the preserveEmptyAttribute flag.
+ voidsetPreserveSpace(boolean preserve) + +
+          Sets space preserving as the default behavior.
+ voidsetStandalone(boolean standalone) + +
+          Sets document DTD standalone.
+ voidsetVersion(java.lang.String version) + +
+          Sets the version for this output method.
+static java.lang.StringwhichDoctypePublic(Document doc) + +
+          Returns the document type public identifier + specified for this document, or null.
+static java.lang.StringwhichDoctypeSystem(Document doc) + +
+          Returns the document type system identifier + specified for this document, or null.
+static java.lang.StringwhichMediaType(java.lang.String method) + +
+          Returns the suitable media format for a document + output with the specified method.
+static java.lang.StringwhichMethod(Document doc) + +
+          Determine the output method for the specified document.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+OutputFormat

+
+public OutputFormat()
+
+
Constructs a new output format with the default values.
+
+ +

+OutputFormat

+
+public OutputFormat(java.lang.String method,
+                    java.lang.String encoding,
+                    boolean indenting)
+
+
Constructs a new output format with the default values for + the specified method and encoding. If indent + is true, the document will be pretty printed with the default + indentation level and default line wrapping.
+
Parameters:
method - The specified output method
encoding - The specified encoding
indenting - True for pretty printing
See Also:
setEncoding(java.lang.String), +setIndenting(boolean), +setMethod(java.lang.String)
+
+
+
+ +

+OutputFormat

+
+public OutputFormat(Document doc)
+
+
Constructs a new output format with the proper method, + document type identifiers and media type for the specified + document.
+
Parameters:
doc - The document to output
See Also:
whichMethod(org.w3c.dom.Document)
+
+
+
+ +

+OutputFormat

+
+public OutputFormat(Document doc,
+                    java.lang.String encoding,
+                    boolean indenting)
+
+
Constructs a new output format with the proper method, + document type identifiers and media type for the specified + document, and with the specified encoding. If indent + is true, the document will be pretty printed with the default + indentation level and default line wrapping.
+
Parameters:
doc - The document to output
encoding - The specified encoding
indenting - True for pretty printing
See Also:
setEncoding(java.lang.String), +setIndenting(boolean), +whichMethod(org.w3c.dom.Document)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getMethod

+
+public java.lang.String getMethod()
+
+
Returns the method specified for this output format. + Typically the method will be xml, html + or text, but it might be other values. + If no method was specified, null will be returned + and the most suitable method will be determined for + the document by calling whichMethod(org.w3c.dom.Document).
+
Returns:
The specified output method, or null
+
+
+
+ +

+setMethod

+
+public void setMethod(java.lang.String method)
+
+
Sets the method for this output format.
+
Parameters:
method - The output method, or null
See Also:
getMethod()
+
+
+
+ +

+getVersion

+
+public java.lang.String getVersion()
+
+
Returns the version for this output method. + If no version was specified, will return null + and the default version number will be used. + If the serializerr does not support that particular + version, it should default to a supported version.
+
Returns:
The specified method version, or null
+
+
+
+ +

+setVersion

+
+public void setVersion(java.lang.String version)
+
+
Sets the version for this output method. + For XML the value would be "1.0", for HTML + it would be "4.0".
+
Parameters:
version - The output method version, or null
See Also:
getVersion()
+
+
+
+ +

+getIndent

+
+public int getIndent()
+
+
Returns the indentation specified. If no indentation + was specified, zero is returned and the document + should not be indented.
+
Returns:
The indentation or zero
See Also:
setIndenting(boolean)
+
+
+
+ +

+getIndenting

+
+public boolean getIndenting()
+
+
Returns true if indentation was specified.
+
+ +

+setIndent

+
+public void setIndent(int indent)
+
+
Sets the indentation. The document will not be + indented if the indentation is set to zero. + Calling setIndenting(boolean) will reset this + value to zero (off) or the default (on).
+
Parameters:
indent - The indentation, or zero
+
+
+
+ +

+setIndenting

+
+public void setIndenting(boolean on)
+
+
Sets the indentation on and off. When set on, the default + indentation level and default line wrapping is used + (see #DEFAULT_INDENT and #DEFAULT_LINE_WIDTH). + To specify a different indentation level or line wrapping, + use setIndent(int) and setLineWidth(int).
+
Parameters:
on - True if indentation should be on
+
+
+
+ +

+getEncoding

+
+public java.lang.String getEncoding()
+
+
Returns the specified encoding. If no encoding was + specified, the default is always "UTF-8".
+
Returns:
The encoding
+
+
+
+ +

+setEncoding

+
+public void setEncoding(java.lang.String encoding)
+
+
Sets the encoding for this output method. If no + encoding was specified, the default is always "UTF-8". + Make sure the encoding is compatible with the one + used by the Writer.
+
Parameters:
encoding - The encoding, or null
See Also:
getEncoding()
+
+
+
+ +

+setEncoding

+
+public void setEncoding(EncodingInfo encInfo)
+
+
Sets the encoding for this output method with an EncodingInfo + instance.
+
+ +

+getEncodingInfo

+
+public EncodingInfo getEncodingInfo()
+
+
Returns an EncodingInfo instance for the encoding.
+
See Also:
setEncoding
+
+
+
+ +

+getMediaType

+
+public java.lang.String getMediaType()
+
+
Returns the specified media type, or null. + To determine the media type based on the + document type, use whichMediaType(java.lang.String).
+
Returns:
The specified media type, or null
+
+
+
+ +

+setMediaType

+
+public void setMediaType(java.lang.String mediaType)
+
+
Sets the media type.
+
Parameters:
mediaType - The specified media type
See Also:
getMediaType()
+
+
+
+ +

+setDoctype

+
+public void setDoctype(java.lang.String publicId,
+                       java.lang.String systemId)
+
+
Sets the document type public and system identifiers. + Required only if the DOM Document or SAX events do not + specify the document type, and one must be present in + the serialized document. Any document type specified + by the DOM Document or SAX events will override these + values.
+
Parameters:
publicId - The public identifier, or null
systemId - The system identifier, or null
+
+
+
+ +

+getDoctypePublic

+
+public java.lang.String getDoctypePublic()
+
+
Returns the specified document type public identifier, + or null.
+
+ +

+getDoctypeSystem

+
+public java.lang.String getDoctypeSystem()
+
+
Returns the specified document type system identifier, + or null.
+
+ +

+getOmitComments

+
+public boolean getOmitComments()
+
+
Returns true if comments should be ommited. + The default is false.
+
+ +

+setOmitComments

+
+public void setOmitComments(boolean omit)
+
+
Sets comment omitting on and off.
+
Parameters:
omit - True if comments should be ommited
+
+
+
+ +

+getOmitDocumentType

+
+public boolean getOmitDocumentType()
+
+
Returns true if the DOCTYPE declaration should + be ommited. The default is false.
+
+ +

+setOmitDocumentType

+
+public void setOmitDocumentType(boolean omit)
+
+
Sets DOCTYPE declaration omitting on and off.
+
Parameters:
omit - True if DOCTYPE declaration should be ommited
+
+
+
+ +

+getOmitXMLDeclaration

+
+public boolean getOmitXMLDeclaration()
+
+
Returns true if the XML document declaration should + be ommited. The default is false.
+
+ +

+setOmitXMLDeclaration

+
+public void setOmitXMLDeclaration(boolean omit)
+
+
Sets XML declaration omitting on and off.
+
Parameters:
omit - True if XML declaration should be ommited
+
+
+
+ +

+getStandalone

+
+public boolean getStandalone()
+
+
Returns true if the document type is standalone. + The default is false.
+
+ +

+setStandalone

+
+public void setStandalone(boolean standalone)
+
+
Sets document DTD standalone. The public and system + identifiers must be null for the document to be + serialized as standalone.
+
Parameters:
standalone - True if document DTD is standalone
+
+
+
+ +

+getCDataElements

+
+public java.lang.String[] getCDataElements()
+
+
Returns a list of all the elements whose text node children + should be output as CDATA, or null if no such elements were + specified.
+
+ +

+isCDataElement

+
+public boolean isCDataElement(java.lang.String tagName)
+
+
Returns true if the text node children of the given elements + should be output as CDATA.
+
Parameters:
tagName - The element's tag name
Returns:
True if should serialize as CDATA
+
+
+
+ +

+setCDataElements

+
+public void setCDataElements(java.lang.String[] cdataElements)
+
+
Sets the list of elements for which text node children + should be output as CDATA.
+
Parameters:
cdataElements - List of CDATA element tag names
+
+
+
+ +

+getNonEscapingElements

+
+public java.lang.String[] getNonEscapingElements()
+
+
Returns a list of all the elements whose text node children + should be output unescaped (no character references), or null + if no such elements were specified.
+
+ +

+isNonEscapingElement

+
+public boolean isNonEscapingElement(java.lang.String tagName)
+
+
Returns true if the text node children of the given elements + should be output unescaped.
+
Parameters:
tagName - The element's tag name
Returns:
True if should serialize unescaped
+
+
+
+ +

+setNonEscapingElements

+
+public void setNonEscapingElements(java.lang.String[] nonEscapingElements)
+
+
Sets the list of elements for which text node children + should be output unescaped (no character references).
+
Parameters:
nonEscapingElements - List of unescaped element tag names
+
+
+
+ +

+getLineSeparator

+
+public java.lang.String getLineSeparator()
+
+
Returns a specific line separator to use. The default is the + Web line separator (\n). A string is returned to + support double codes (CR + LF).
+
Returns:
The specified line separator
+
+
+
+ +

+setLineSeparator

+
+public void setLineSeparator(java.lang.String lineSeparator)
+
+
Sets the line separator. The default is the Web line separator + (\n). The machine's line separator can be obtained + from the system property line.separator, but is only + useful if the document is edited on machines of the same type. + For general documents, use the Web line separator.
+
Parameters:
lineSeparator - The specified line separator
+
+
+
+ +

+getPreserveSpace

+
+public boolean getPreserveSpace()
+
+
Returns true if the default behavior for this format is to + preserve spaces. All elements that do not specify otherwise + or specify the default behavior will be formatted based on + this rule. All elements that specify space preserving will + always preserve space.
+
+ +

+setPreserveSpace

+
+public void setPreserveSpace(boolean preserve)
+
+
Sets space preserving as the default behavior. The default is + space stripping and all elements that do not specify otherwise + or use the default value will not preserve spaces.
+
Parameters:
preserve - True if spaces should be preserved
+
+
+
+ +

+getLineWidth

+
+public int getLineWidth()
+
+
Return the selected line width for breaking up long lines. + When indenting, and only when indenting, long lines will be + broken at space boundaries based on this line width. + No line wrapping occurs if this value is zero.
+
+ +

+setLineWidth

+
+public void setLineWidth(int lineWidth)
+
+
Sets the line width. If zero then no line wrapping will + occur. Calling setIndenting(boolean) will reset this + value to zero (off) or the default (on).
+
Parameters:
lineWidth - The line width to use, zero for default
See Also:
getLineWidth(), +setIndenting(boolean)
+
+
+
+ +

+getPreserveEmptyAttributes

+
+public boolean getPreserveEmptyAttributes()
+
+
Returns the preserveEmptyAttribute flag. If flag is false, then' + attributes with empty string values are output as the attribute + name only (in HTML mode).
+
Returns:
preserve the preserve flag
+
+
+
+ +

+setPreserveEmptyAttributes

+
+public void setPreserveEmptyAttributes(boolean preserve)
+
+
Sets the preserveEmptyAttribute flag. If flag is false, then' + attributes with empty string values are output as the attribute + name only (in HTML mode).
+
Parameters:
preserve - the preserve flag
+
+
+
+ +

+getLastPrintable

+
+public char getLastPrintable()
+
+
Returns the last printable character based on the selected + encoding. Control characters and non-printable characters + are always printed as character references.
+
+ +

+whichMethod

+
+public static java.lang.String whichMethod(Document doc)
+
+
Determine the output method for the specified document. + If the document is an instance of HTMLDocument + then the method is said to be html. If the root + element is 'html' and all text nodes preceding the root + element are all whitespace, then the method is said to be + html. Otherwise the method is xml.
+
Parameters:
doc - The document to check
Returns:
The suitable method
+
+
+
+ +

+whichDoctypePublic

+
+public static java.lang.String whichDoctypePublic(Document doc)
+
+
Returns the document type public identifier + specified for this document, or null.
+
+ +

+whichDoctypeSystem

+
+public static java.lang.String whichDoctypeSystem(Document doc)
+
+
Returns the document type system identifier + specified for this document, or null.
+
+ +

+whichMediaType

+
+public static java.lang.String whichMediaType(java.lang.String method)
+
+
Returns the suitable media format for a document + output with the specified method.
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Printer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Printer.html new file mode 100644 index 0000000..063bf25 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Printer.html @@ -0,0 +1,615 @@ + + + + + + +Xerces-J API: Class Printer + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class Printer

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.Printer
+
+
+
Direct Known Subclasses:
IndentPrinter
+
+
+
+
public class Printer
extends java.lang.Object
+ +

+The printer is responsible for sending text to the output stream + or writer. This class performs direct writing for efficiency. + IndentPrinter supports indentation and line wrapping by + extending this class. +

+

+
Version:
$Revision: 1.6 $ $Date: 2001/04/19 23:40:32 $
+
Author:
Assaf Arkin
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  java.io.Writer_docWriter + +
+          Holds a reference to the document writer while we are + in DTD mode.
+protected  java.io.StringWriter_dtdWriter + +
+          The DTD writer.
+protected  java.io.IOException_exception + +
+          Holds the exception thrown by the serializer.
+protected  OutputFormat_format + +
+          The output format associated with this serializer.
+protected  java.io.Writer_writer + +
+          The writer to which the document is written.
+  + + + + + + + + + + +
+Constructor Summary
Printer(java.io.Writer writer, + OutputFormat format) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidbreakLine() + +
+           
+ voidbreakLine(boolean preserveSpace) + +
+           
+ voidenterDTD() + +
+          Called by any of the DTD handlers to enter DTD mode.
+ voidflush() + +
+          Flush the output stream.
+ voidflushLine(boolean preserveSpace) + +
+           
+ java.io.IOExceptiongetException() + +
+           
+ intgetNextIndent() + +
+           
+ voidindent() + +
+           
+ java.lang.StringleaveDTD() + +
+          Called by the root element to leave DTD mode and if any + DTD parts were printer, will return a string with their + textual content.
+ voidprintSpace() + +
+           
+ voidprintText(char ch) + +
+           
+ voidprintText(char[] chars, + int start, + int length) + +
+           
+ voidprintText(java.lang.String text) + +
+           
+ voidprintText(java.lang.StringBuffer text) + +
+           
+ voidsetNextIndent(int indent) + +
+           
+ voidsetThisIndent(int indent) + +
+           
+ voidunindent() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+_format

+
+protected final OutputFormat _format
+
+
The output format associated with this serializer. This will never + be a null reference. If no format was passed to the constructor, + the default one for this document type will be used. The format + object is never changed by the serializer.
+
+ +

+_writer

+
+protected java.io.Writer _writer
+
+
The writer to which the document is written.
+
+ +

+_dtdWriter

+
+protected java.io.StringWriter _dtdWriter
+
+
The DTD writer. When we switch to DTD mode, all output is + accumulated in this DTD writer. When we switch out of it, + the output is obtained as a string. Must not be reset to + null until we're done with the document.
+
+ +

+_docWriter

+
+protected java.io.Writer _docWriter
+
+
Holds a reference to the document writer while we are + in DTD mode.
+
+ +

+_exception

+
+protected java.io.IOException _exception
+
+
Holds the exception thrown by the serializer. Exceptions do not cause + the serializer to quit, but are held and one is thrown at the end.
+ + + + + + + + +
+Constructor Detail
+ +

+Printer

+
+public Printer(java.io.Writer writer,
+               OutputFormat format)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getException

+
+public java.io.IOException getException()
+
+
+
+ +

+enterDTD

+
+public void enterDTD()
+              throws java.io.IOException
+
+
Called by any of the DTD handlers to enter DTD mode. + Once entered, all output will be accumulated in a string + that can be printed as part of the document's DTD. + This method may be called any number of time but will only + have affect the first time it's called. To exist DTD state + and get the accumulated DTD, call leaveDTD().
+
+ +

+leaveDTD

+
+public java.lang.String leaveDTD()
+                          throws java.io.IOException
+
+
Called by the root element to leave DTD mode and if any + DTD parts were printer, will return a string with their + textual content.
+
+ +

+printText

+
+public void printText(java.lang.String text)
+               throws java.io.IOException
+
+
+
+ +

+printText

+
+public void printText(java.lang.StringBuffer text)
+               throws java.io.IOException
+
+
+
+ +

+printText

+
+public void printText(char[] chars,
+                      int start,
+                      int length)
+               throws java.io.IOException
+
+
+
+ +

+printText

+
+public void printText(char ch)
+               throws java.io.IOException
+
+
+
+ +

+printSpace

+
+public void printSpace()
+                throws java.io.IOException
+
+
+
+ +

+breakLine

+
+public void breakLine()
+               throws java.io.IOException
+
+
+
+ +

+breakLine

+
+public void breakLine(boolean preserveSpace)
+               throws java.io.IOException
+
+
+
+ +

+flushLine

+
+public void flushLine(boolean preserveSpace)
+               throws java.io.IOException
+
+
+
+ +

+flush

+
+public void flush()
+           throws java.io.IOException
+
+
Flush the output stream. Must be called when done printing + the document, otherwise some text might be buffered.
+
+ +

+indent

+
+public void indent()
+
+
+
+ +

+unindent

+
+public void unindent()
+
+
+
+ +

+getNextIndent

+
+public int getNextIndent()
+
+
+
+ +

+setNextIndent

+
+public void setNextIndent(int indent)
+
+
+
+ +

+setThisIndent

+
+public void setThisIndent(int indent)
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Serializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Serializer.html new file mode 100644 index 0000000..6f85a37 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/Serializer.html @@ -0,0 +1,302 @@ + + + + + + +Xerces-J API: Interface Serializer + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Interface Serializer

+
+
All Known Implementing Classes:
BaseMarkupSerializer
+
+
+
+
public interface Serializer
+ +

+Interface for a DOM serializer implementation, factory for DOM and SAX + serializers, and static methods for serializing DOM documents. +

+ To serialize a document using SAX events, create a compatible serializer + using #makeSAXSerializer and pass it around as a DocumentHandler. If an I/O error occurs while serializing, it will + be thrown by DocumentHandler.endDocument(). The SAX serializer + may also be used as DTDHandler, DeclHandler and + LexicalHandler. +

+ To serialize a DOM document or DOM element, create a compatible + serializer using #makeSerializer and call it's #serialize(Document) or #serialize(Element) methods. + Both methods would produce a full XML document, to serizlie only + the portion of the document use OutputFormat.setOmitXMLDeclaration(boolean) + and specify no document type. +

+ The convenience method #serialize(Document,Writer,OutputFormat) + creates a serializer and calls #serizlie(Document) on that + serialized. +

+ The OutputFormat dictates what underlying serialized is used + to serialize the document based on the specified method. If the output + format or method are missing, the default is an XML serializer with + UTF-8 encoding and now indentation. +

+

+
Version:
$Revision: 1.9 $ $Date: 2000/08/30 18:59:21 $
+
Author:
Assaf Arkin, Scott Boag
+
See Also:
DocumentHandler, +ContentHandler, +OutputFormat, +DOMSerializer
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ ContentHandlerasContentHandler() + +
+          Return a ContentHandler interface into this serializer.
+ DocumentHandlerasDocumentHandler() + +
+          Return a DocumentHandler interface into this serializer.
+ DOMSerializerasDOMSerializer() + +
+          Return a DOMSerializer interface into this serializer.
+ voidsetOutputByteStream(java.io.OutputStream output) + +
+          Specifies an output stream to which the document should be + serialized.
+ voidsetOutputCharStream(java.io.Writer output) + +
+          Specifies a writer to which the document should be serialized.
+ voidsetOutputFormat(OutputFormat format) + +
+          Specifies an output format for this serializer.
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+setOutputByteStream

+
+public void setOutputByteStream(java.io.OutputStream output)
+
+
Specifies an output stream to which the document should be + serialized. This method should not be called while the + serializer is in the process of serializing a document.
+
+ +

+setOutputCharStream

+
+public void setOutputCharStream(java.io.Writer output)
+
+
Specifies a writer to which the document should be serialized. + This method should not be called while the serializer is in + the process of serializing a document.
+
+ +

+setOutputFormat

+
+public void setOutputFormat(OutputFormat format)
+
+
Specifies an output format for this serializer. It the + serializer has already been associated with an output format, + it will switch to the new format. This method should not be + called while the serializer is in the process of serializing + a document.
+
Parameters:
format - The output format to use
+
+
+
+ +

+asDocumentHandler

+
+public DocumentHandler asDocumentHandler()
+                                  throws java.io.IOException
+
+
Return a DocumentHandler interface into this serializer. + If the serializer does not support the DocumentHandler + interface, it should return null.
+
+ +

+asContentHandler

+
+public ContentHandler asContentHandler()
+                                throws java.io.IOException
+
+
Return a ContentHandler interface into this serializer. + If the serializer does not support the ContentHandler + interface, it should return null.
+
+ +

+asDOMSerializer

+
+public DOMSerializer asDOMSerializer()
+                              throws java.io.IOException
+
+
Return a DOMSerializer interface into this serializer. + If the serializer does not support the DOMSerializer + interface, it should return null.
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/SerializerFactory.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/SerializerFactory.html new file mode 100644 index 0000000..1410413 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/SerializerFactory.html @@ -0,0 +1,358 @@ + + + + + + +Xerces-J API: Class SerializerFactory + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class SerializerFactory

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.SerializerFactory
+
+
+
+
public abstract class SerializerFactory
extends java.lang.Object
+ +

+

+
Version:
$Revision: 1.5 $ $Date: 2000/12/05 22:48:29 $
+
Author:
Scott Boag, Assaf Arkin
+
+
+ +

+ + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringFactoriesProperty + +
+           
+  + + + + + + + + + + +
+Constructor Summary
SerializerFactory() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static SerializerFactorygetSerializerFactory(java.lang.String method) + +
+          Register a serializer factory, keyed by the given + method string.
+protected abstract  java.lang.StringgetSupportedMethod() + +
+          Returns the method supported by this factory and used to register + the factory.
+abstract  SerializermakeSerializer(OutputFormat format) + +
+          Create a new serializer based on the OutputFormat.
+abstract  SerializermakeSerializer(java.io.OutputStream output, + OutputFormat format) + +
+          Create a new serializer, based on the OutputFormat and + using the output byte stream and the encoding specified in the + output format.
+abstract  SerializermakeSerializer(java.io.Writer writer, + OutputFormat format) + +
+          Create a new serializer, based on the OutputFormat and + using the writer as the output character stream.
+static voidregisterSerializerFactory(SerializerFactory factory) + +
+          Register a serializer factory, keyed by the given + method string.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+FactoriesProperty

+
+public static final java.lang.String FactoriesProperty
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+SerializerFactory

+
+public SerializerFactory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+registerSerializerFactory

+
+public static void registerSerializerFactory(SerializerFactory factory)
+
+
Register a serializer factory, keyed by the given + method string.
+
+ +

+getSerializerFactory

+
+public static SerializerFactory getSerializerFactory(java.lang.String method)
+
+
Register a serializer factory, keyed by the given + method string.
+
+ +

+getSupportedMethod

+
+protected abstract java.lang.String getSupportedMethod()
+
+
Returns the method supported by this factory and used to register + the factory. This call is required so factories can be added from + a properties file by knowing only the class name. This method is + protected, it is only required by this class but must be implemented + in derived classes.
+
+ +

+makeSerializer

+
+public abstract Serializer makeSerializer(OutputFormat format)
+
+
Create a new serializer based on the OutputFormat. + If this method is used to create the serializer, the Serializer.setOutputByteStream(java.io.OutputStream) or Serializer.setOutputCharStream(java.io.Writer) + methods must be called before serializing a document.
+
+ +

+makeSerializer

+
+public abstract Serializer makeSerializer(java.io.Writer writer,
+                                          OutputFormat format)
+
+
Create a new serializer, based on the OutputFormat and + using the writer as the output character stream. If this + method is used, the encoding property will be ignored.
+
+ +

+makeSerializer

+
+public abstract Serializer makeSerializer(java.io.OutputStream output,
+                                          OutputFormat format)
+                                   throws java.io.UnsupportedEncodingException
+
+
Create a new serializer, based on the OutputFormat and + using the output byte stream and the encoding specified in the + output format.
+
Throws:
java.io.UnsupportedEncodingException - The specified encoding is + not supported
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/SieveEncodingInfo.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/SieveEncodingInfo.html new file mode 100644 index 0000000..7bb59c1 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/SieveEncodingInfo.html @@ -0,0 +1,266 @@ + + + + + + +Xerces-J API: Class SieveEncodingInfo + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class SieveEncodingInfo

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.EncodingInfo
+        |
+        +--org.apache.xml.serialize.SieveEncodingInfo
+
+
+
+
public class SieveEncodingInfo
extends EncodingInfo
+ +

+This class represents an encoding. +

+

+
Version:
$Id: SieveEncodingInfo.java,v 1.1 2000/12/14 19:21:55 lehors Exp $
+
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Constructor Summary
SieveEncodingInfo(java.lang.String mimeName, + int lastPrintable) + +
+          Creates new SeiveEncodingInfo instance.
SieveEncodingInfo(java.lang.String mimeName, + java.lang.String javaName, + int lastPrintable, + java.lang.String dangers) + +
+          Creates new SeiveEncodingInfo instance.
+  + + + + + + + + + + + +
+Method Summary
+ booleanisPrintable(int ch) + +
+          Checks whether the specified character is printable or not.
+ + + + + + + +
Methods inherited from class org.apache.xml.serialize.EncodingInfo
getName, +getWriter
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+SieveEncodingInfo

+
+public SieveEncodingInfo(java.lang.String mimeName,
+                         java.lang.String javaName,
+                         int lastPrintable,
+                         java.lang.String dangers)
+
+
Creates new SeiveEncodingInfo instance.
+
Parameters:
dangers - A sorted characters that are always printed as character references.
+
+
+
+ +

+SieveEncodingInfo

+
+public SieveEncodingInfo(java.lang.String mimeName,
+                         int lastPrintable)
+
+
Creates new SeiveEncodingInfo instance.
+ + + + + + + + +
+Method Detail
+ +

+isPrintable

+
+public boolean isPrintable(int ch)
+
+
Checks whether the specified character is printable or not.
+
Overrides:
isPrintable in class EncodingInfo
+
+
+
Parameters:
ch - a code point (0-0x10ffff)
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/TextSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/TextSerializer.html new file mode 100644 index 0000000..344100a --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/TextSerializer.html @@ -0,0 +1,792 @@ + + + + + + +Xerces-J API: Class TextSerializer + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class TextSerializer

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.BaseMarkupSerializer
+        |
+        +--org.apache.xml.serialize.TextSerializer
+
+
+
+
public class TextSerializer
extends BaseMarkupSerializer
+ +

+Implements a text serializer supporting both DOM and SAX + serializing. For usage instructions see Serializer. +

+ If an output stream is used, the encoding is taken from the + output format (defaults to UTF-8). If a writer is + used, make sure the writer uses the same encoding (if applies) + as specified in the output format. +

+ The serializer supports both DOM and SAX. DOM serializing is done + by calling BaseMarkupSerializer.serialize(org.w3c.dom.Element) and SAX serializing is done by firing + SAX events and using the serializer as a document handler. +

+ If an I/O exception occurs while serializing, the serializer + will not throw an exception directly, but only throw it + at the end of serializing (either DOM or SAX's DocumentHandler.endDocument(). +

+

+
Version:
$Revision: 1.11 $ $Date: 2001/07/20 20:37:06 $
+
Author:
Assaf Arkin
+
See Also:
Serializer
+
+ +

+ + + + + + + + + + + + + +
Fields inherited from class org.apache.xml.serialize.BaseMarkupSerializer
_docTypePublicId, +_docTypeSystemId, +_format, +_indenting, +_prefixes, +_printer, +_started
+  + + + + + + + + + + +
+Constructor Summary
TextSerializer() + +
+          Constructs a new serializer.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcharacters(char[] chars, + int start, + int length) + +
+          Receive notification of character data.
+protected  voidcharacters(java.lang.String text, + boolean unescaped) + +
+           
+ voidcomment(char[] chars, + int start, + int length) + +
+          Report an XML comment anywhere in the document.
+ voidcomment(java.lang.String text) + +
+           
+protected  ElementStatecontent() + +
+          Must be called by a method about to print any type of content.
+ voidendElement(java.lang.String tagName) + +
+          Receive notification of the end of an element.
+ voidendElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String rawName) + +
+          Receive notification of the end of an element.
+ voidendElementIO(java.lang.String tagName) + +
+           
+protected  java.lang.StringgetEntityRef(int ch) + +
+          Returns the suitable entity reference for this character value, + or null if no such entity exists.
+ voidprocessingInstructionIO(java.lang.String target, + java.lang.String code) + +
+           
+protected  voidserializeElement(Element elem) + +
+          Called to serialize a DOM element.
+protected  voidserializeNode(Node node) + +
+          Serialize the DOM node.
+ voidsetOutputFormat(OutputFormat format) + +
+          Specifies an output format for this serializer.
+protected  voidstartDocument(java.lang.String rootTagName) + +
+          Called to serialize the document's DOCTYPE by the root element.
+ voidstartElement(java.lang.String tagName, + AttributeList attrs) + +
+          Receive notification of the beginning of an element.
+ voidstartElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String rawName, + Attributes attrs) + +
+          Receive notification of the beginning of an element.
+ + + + + + + +
Methods inherited from class org.apache.xml.serialize.BaseMarkupSerializer
asContentHandler, +asDocumentHandler, +asDOMSerializer, +attributeDecl, +characters, +elementDecl, +endCDATA, +endDocument, +endDTD, +endEntity, +endNonEscaping, +endPrefixMapping, +endPreserving, +enterElementState, +externalEntityDecl, +getElementState, +getPrefix, +ignorableWhitespace, +internalEntityDecl, +isDocumentState, +leaveElementState, +notationDecl, +prepare, +printDoctypeURL, +printEscaped, +printEscaped, +printText, +printText, +processingInstruction, +reset, +serialize, +serialize, +serialize, +serializePreRoot, +setDocumentLocator, +setOutputByteStream, +setOutputCharStream, +skippedEntity, +startCDATA, +startDocument, +startDTD, +startEntity, +startNonEscaping, +startPrefixMapping, +startPreserving, +unparsedEntityDecl
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+TextSerializer

+
+public TextSerializer()
+
+
Constructs a new serializer. The serializer cannot be used without + calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) + first.
+ + + + + + + + +
+Method Detail
+ +

+setOutputFormat

+
+public void setOutputFormat(OutputFormat format)
+
+
Description copied from interface: Serializer
+
Specifies an output format for this serializer. It the + serializer has already been associated with an output format, + it will switch to the new format. This method should not be + called while the serializer is in the process of serializing + a document.
+
Overrides:
setOutputFormat in class BaseMarkupSerializer
+
+
Tags copied from interface: Serializer
+
+
Parameters:
format - The output format to use
+
+
+
+ +

+startElement

+
+public void startElement(java.lang.String namespaceURI,
+                         java.lang.String localName,
+                         java.lang.String rawName,
+                         Attributes attrs)
+                  throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of the beginning of an element. + +

The Parser will invoke this method at the beginning of every + element in the XML document; there will be a corresponding + endElement event for every startElement event + (even when the element is empty). All of the element's content will be + reported, in order, before the corresponding endElement + event.

+ +

This event allows up to three name components for each + element:

+ +
    +
  1. the Namespace URI;
  2. +
  3. the local name; and
  4. +
  5. the qualified (prefixed) name.
  6. +
+ +

Any or all of these may be provided, depending on the + values of the http://xml.org/sax/features/namespaces + and the http://xml.org/sax/features/namespace-prefixes + properties:

+ +
    +
  • the Namespace URI and local name are required when + the namespaces property is true (the default), and are + optional when the namespaces property is false (if one is + specified, both must be);
  • +
  • the qualified name is required when the namespace-prefixes property + is true, and is optional when the namespace-prefixes property + is false (the default).
  • +
+ +

Note that the attribute list provided will contain only + attributes with explicit values (specified or defaulted): + #IMPLIED attributes will be omitted. The attribute list + will contain attributes used for Namespace declarations + (xmlns* attributes) only if the + http://xml.org/sax/features/namespace-prefixes + property is true (it is false by default, and support for a + true value is optional).

Tags copied from interface: ContentHandler
+
+
Parameters:
uri - The Namespace URI, or the empty string if the + element has no Namespace URI or if Namespace + processing is not being performed.
localName - The local name (without prefix), or the + empty string if Namespace processing is not being + performed.
qName - The qualified name (with prefix), or the + empty string if qualified names are not available.
atts - The attributes attached to the element. If + there are no attributes, it shall be an empty + Attributes object.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String), +Attributes
+
+
+
+ +

+endElement

+
+public void endElement(java.lang.String namespaceURI,
+                       java.lang.String localName,
+                       java.lang.String rawName)
+                throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of the end of an element. + +

The SAX parser will invoke this method at the end of every + element in the XML document; there will be a corresponding + startElement event for every endElement + event (even when the element is empty).

+ +

For information on the names, see startElement.

Tags copied from interface: ContentHandler
+
+
Parameters:
uri - The Namespace URI, or the empty string if the + element has no Namespace URI or if Namespace + processing is not being performed.
localName - The local name (without prefix), or the + empty string if Namespace processing is not being + performed.
qName - The qualified XML 1.0 name (with prefix), or the + empty string if qualified names are not available.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
+
+
+
+ +

+startElement

+
+public void startElement(java.lang.String tagName,
+                         AttributeList attrs)
+                  throws SAXException
+
+
Description copied from interface: DocumentHandler
+
Receive notification of the beginning of an element. + +

The Parser will invoke this method at the beginning of every + element in the XML document; there will be a corresponding + endElement() event for every startElement() event (even when the + element is empty). All of the element's content will be + reported, in order, before the corresponding endElement() + event.

+ +

If the element name has a namespace prefix, the prefix will + still be attached. Note that the attribute list provided will + contain only attributes with explicit values (specified or + defaulted): #IMPLIED attributes will be omitted.

Tags copied from interface: DocumentHandler
+
+
Parameters:
name - The element type name.
atts - The attributes attached to the element, if any.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
DocumentHandler.endElement(java.lang.String), +AttributeList
+
+
+
+ +

+endElement

+
+public void endElement(java.lang.String tagName)
+                throws SAXException
+
+
Description copied from interface: DocumentHandler
+
Receive notification of the end of an element. + +

The SAX parser will invoke this method at the end of every + element in the XML document; there will be a corresponding + startElement() event for every endElement() event (even when the + element is empty).

+ +

If the element name has a namespace prefix, the prefix will + still be attached to the name.

Tags copied from interface: DocumentHandler
+
+
Parameters:
name - The element type name
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
+
+
+
+ +

+endElementIO

+
+public void endElementIO(java.lang.String tagName)
+                  throws java.io.IOException
+
+
+
+ +

+processingInstructionIO

+
+public void processingInstructionIO(java.lang.String target,
+                                    java.lang.String code)
+                             throws java.io.IOException
+
+
+
Overrides:
processingInstructionIO in class BaseMarkupSerializer
+
+
+
+ +

+comment

+
+public void comment(java.lang.String text)
+
+
+
Overrides:
comment in class BaseMarkupSerializer
+
+
+
+ +

+comment

+
+public void comment(char[] chars,
+                    int start,
+                    int length)
+
+
Description copied from interface: LexicalHandler
+
Report an XML comment anywhere in the document. + +

This callback will be used for comments inside or outside the + document element, including comments in the external DTD + subset (if read). Comments in the DTD must be properly + nested inside start/endDTD and start/endEntity events (if + used).

+
Overrides:
comment in class BaseMarkupSerializer
+
+
Tags copied from interface: LexicalHandler
+
+
Parameters:
ch - An array holding the characters in the comment.
start - The starting position in the array.
length - The number of characters to use from the array.
Throws:
SAXException - The application may raise an exception.
+
+
+
+ +

+characters

+
+public void characters(char[] chars,
+                       int start,
+                       int length)
+                throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of character data. + +

The Parser will call this method to report each chunk of + character data. SAX parsers may return all contiguous character + data in a single chunk, or they may split it into several + chunks; however, all of the characters in any single event + must come from the same external entity so that the Locator + provides useful information.

+ +

The application must not attempt to read from the array + outside of the specified range.

+ +

Note that some parsers will report whitespace in element + content using the ignorableWhitespace + method rather than this one (validating parsers must + do so).

+
Overrides:
characters in class BaseMarkupSerializer
+
+
Tags copied from interface: ContentHandler
+
+
Parameters:
ch - The characters from the XML document.
start - The start position in the array.
length - The number of characters to read from the array.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
ContentHandler.ignorableWhitespace(char[], int, int), +Locator
+
+
+
+ +

+characters

+
+protected void characters(java.lang.String text,
+                          boolean unescaped)
+                   throws java.io.IOException
+
+
+
+ +

+startDocument

+
+protected void startDocument(java.lang.String rootTagName)
+                      throws java.io.IOException
+
+
Called to serialize the document's DOCTYPE by the root element. +

+ This method will check if it has not been called before (BaseMarkupSerializer._started), + will serialize the document type declaration, and will serialize all + pre-root comments and PIs that were accumulated in the document + (see BaseMarkupSerializer.serializePreRoot()). Pre-root will be serialized even if + this is not the first root element of the document.

+
+ +

+serializeElement

+
+protected void serializeElement(Element elem)
+                         throws java.io.IOException
+
+
Called to serialize a DOM element. Equivalent to calling startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes), endElement(java.lang.String, java.lang.String, java.lang.String) and serializing everything + inbetween, but better optimized.
+
Overrides:
serializeElement in class BaseMarkupSerializer
+
+
Tags copied from class: BaseMarkupSerializer
+
+
Parameters:
elem - The element to serialize
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+serializeNode

+
+protected void serializeNode(Node node)
+                      throws java.io.IOException
+
+
Serialize the DOM node. This method is unique to the Text serializer.
+
Overrides:
serializeNode in class BaseMarkupSerializer
+
+
+
Parameters:
node - The node to serialize
+
+
+
+ +

+content

+
+protected ElementState content()
+
+
Description copied from class: BaseMarkupSerializer
+
Must be called by a method about to print any type of content. + If the element was just opened, the opening tag is closed and + will be matched to a closing tag. Returns the current element + state with empty and afterElement set to false.
+
Overrides:
content in class BaseMarkupSerializer
+
+
Tags copied from class: BaseMarkupSerializer
+
+
Returns:
The current element state
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+getEntityRef

+
+protected java.lang.String getEntityRef(int ch)
+
+
Description copied from class: BaseMarkupSerializer
+
Returns the suitable entity reference for this character value, + or null if no such entity exists. Calling this method with '&' + will return "&".
+
Overrides:
getEntityRef in class BaseMarkupSerializer
+
+
Tags copied from class: BaseMarkupSerializer
+
+
Parameters:
ch - Character value
Returns:
Character entity name, or null
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/XHTMLSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/XHTMLSerializer.html new file mode 100644 index 0000000..b15b688 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/XHTMLSerializer.html @@ -0,0 +1,404 @@ + + + + + + +Xerces-J API: Class XHTMLSerializer + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class XHTMLSerializer

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.BaseMarkupSerializer
+        |
+        +--org.apache.xml.serialize.HTMLSerializer
+              |
+              +--org.apache.xml.serialize.XHTMLSerializer
+
+
+
+
public class XHTMLSerializer
extends HTMLSerializer
+ +

+Implements an XHTML serializer supporting both DOM and SAX + pretty serializing. For usage instructions see either Serializer or BaseMarkupSerializer. +

+

+
Version:
$Revision: 1.7 $ $Date: 2001/07/19 19:26:11 $
+
Author:
Assaf Arkin
+
See Also:
Serializer
+
+ +

+ + + + + + + + + + + + + +
Fields inherited from class org.apache.xml.serialize.HTMLSerializer
XHTMLNamespace
+ + + + + + + +
Fields inherited from class org.apache.xml.serialize.BaseMarkupSerializer
_docTypePublicId, +_docTypeSystemId, +_format, +_indenting, +_prefixes, +_printer, +_started
+  + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
XHTMLSerializer() + +
+          Constructs a new serializer.
XHTMLSerializer(OutputFormat format) + +
+          Constructs a new serializer.
XHTMLSerializer(java.io.OutputStream output, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified output + stream using the specified output format.
XHTMLSerializer(java.io.Writer writer, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified writer + using the specified output format.
+  + + + + + + + + + + + +
+Method Summary
+ voidsetOutputFormat(OutputFormat format) + +
+          Specifies an output format for this serializer.
+ + + + + + + +
Methods inherited from class org.apache.xml.serialize.HTMLSerializer
characters, +characters, +endElement, +endElement, +endElementIO, +escapeURI, +getEntityRef, +serializeElement, +startDocument, +startElement, +startElement
+ + + + + + + +
Methods inherited from class org.apache.xml.serialize.BaseMarkupSerializer
asContentHandler, +asDocumentHandler, +asDOMSerializer, +attributeDecl, +comment, +comment, +content, +elementDecl, +endCDATA, +endDocument, +endDTD, +endEntity, +endNonEscaping, +endPrefixMapping, +endPreserving, +enterElementState, +externalEntityDecl, +getElementState, +getPrefix, +ignorableWhitespace, +internalEntityDecl, +isDocumentState, +leaveElementState, +notationDecl, +prepare, +printDoctypeURL, +printEscaped, +printEscaped, +printText, +printText, +processingInstruction, +processingInstructionIO, +reset, +serialize, +serialize, +serialize, +serializeNode, +serializePreRoot, +setDocumentLocator, +setOutputByteStream, +setOutputCharStream, +skippedEntity, +startCDATA, +startDocument, +startDTD, +startEntity, +startNonEscaping, +startPrefixMapping, +startPreserving, +unparsedEntityDecl
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+XHTMLSerializer

+
+public XHTMLSerializer()
+
+
Constructs a new serializer. The serializer cannot be used without + calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) + first.
+
+ +

+XHTMLSerializer

+
+public XHTMLSerializer(OutputFormat format)
+
+
Constructs a new serializer. The serializer cannot be used without + calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) + first.
+
+ +

+XHTMLSerializer

+
+public XHTMLSerializer(java.io.Writer writer,
+                       OutputFormat format)
+
+
Constructs a new serializer that writes to the specified writer + using the specified output format. If format is null, + will use a default output format.
+
Parameters:
writer - The writer to use
format - The output format to use, null for the default
+
+
+
+ +

+XHTMLSerializer

+
+public XHTMLSerializer(java.io.OutputStream output,
+                       OutputFormat format)
+
+
Constructs a new serializer that writes to the specified output + stream using the specified output format. If format + is null, will use a default output format.
+
Parameters:
output - The output stream to use
format - The output format to use, null for the default
+
+
+ + + + + + + + +
+Method Detail
+ +

+setOutputFormat

+
+public void setOutputFormat(OutputFormat format)
+
+
Description copied from interface: Serializer
+
Specifies an output format for this serializer. It the + serializer has already been associated with an output format, + it will switch to the new format. This method should not be + called while the serializer is in the process of serializing + a document.
+
Overrides:
setOutputFormat in class HTMLSerializer
+
+
Tags copied from interface: Serializer
+
+
Parameters:
format - The output format to use
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/XMLSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/XMLSerializer.html new file mode 100644 index 0000000..40dd0f6 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/XMLSerializer.html @@ -0,0 +1,680 @@ + + + + + + +Xerces-J API: Class XMLSerializer + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.xml.serialize +
+Class XMLSerializer

+
+java.lang.Object
+  |
+  +--org.apache.xml.serialize.BaseMarkupSerializer
+        |
+        +--org.apache.xml.serialize.XMLSerializer
+
+
+
+
public class XMLSerializer
extends BaseMarkupSerializer
+ +

+Implements an XML serializer supporting both DOM and SAX pretty + serializing. For usage instructions see Serializer. +

+ If an output stream is used, the encoding is taken from the + output format (defaults to UTF-8). If a writer is + used, make sure the writer uses the same encoding (if applies) + as specified in the output format. +

+ The serializer supports both DOM and SAX. DOM serializing is done + by calling BaseMarkupSerializer.serialize(org.w3c.dom.Element) and SAX serializing is done by firing + SAX events and using the serializer as a document handler. +

+ If an I/O exception occurs while serializing, the serializer + will not throw an exception directly, but only throw it + at the end of serializing (either DOM or SAX's DocumentHandler.endDocument(). +

+ For elements that are not specified as whitespace preserving, + the serializer will potentially break long text lines at space + boundaries, indent lines, and serialize elements on separate + lines. Line terminators will be regarded as spaces, and + spaces at beginning of line will be stripped. +

+

+
Version:
$Revision: 1.22.2.1 $ $Date: 2001/11/05 15:30:10 $
+
Author:
Assaf Arkin
+
See Also:
Serializer
+
+ +

+ + + + + + + + + + + + + +
Fields inherited from class org.apache.xml.serialize.BaseMarkupSerializer
_docTypePublicId, +_docTypeSystemId, +_format, +_indenting, +_prefixes, +_printer, +_started
+  + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
XMLSerializer() + +
+          Constructs a new serializer.
XMLSerializer(OutputFormat format) + +
+          Constructs a new serializer.
XMLSerializer(java.io.OutputStream output, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified output + stream using the specified output format.
XMLSerializer(java.io.Writer writer, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified writer + using the specified output format.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidendElement(java.lang.String tagName) + +
+          Receive notification of the end of an element.
+ voidendElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String rawName) + +
+          Receive notification of the end of an element.
+ voidendElementIO(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String rawName) + +
+           
+protected  java.lang.StringgetEntityRef(int ch) + +
+          Returns the suitable entity reference for this character value, + or null if no such entity exists.
+protected  voidserializeElement(Element elem) + +
+          Called to serialize a DOM element.
+ voidsetOutputFormat(OutputFormat format) + +
+          Specifies an output format for this serializer.
+protected  voidstartDocument(java.lang.String rootTagName) + +
+          Called to serialize the document's DOCTYPE by the root element.
+ voidstartElement(java.lang.String tagName, + AttributeList attrs) + +
+          Receive notification of the beginning of an element.
+ voidstartElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String rawName, + Attributes attrs) + +
+          Receive notification of the beginning of an element.
+ + + + + + + +
Methods inherited from class org.apache.xml.serialize.BaseMarkupSerializer
asContentHandler, +asDocumentHandler, +asDOMSerializer, +attributeDecl, +characters, +characters, +comment, +comment, +content, +elementDecl, +endCDATA, +endDocument, +endDTD, +endEntity, +endNonEscaping, +endPrefixMapping, +endPreserving, +enterElementState, +externalEntityDecl, +getElementState, +getPrefix, +ignorableWhitespace, +internalEntityDecl, +isDocumentState, +leaveElementState, +notationDecl, +prepare, +printDoctypeURL, +printEscaped, +printEscaped, +printText, +printText, +processingInstruction, +processingInstructionIO, +reset, +serialize, +serialize, +serialize, +serializeNode, +serializePreRoot, +setDocumentLocator, +setOutputByteStream, +setOutputCharStream, +skippedEntity, +startCDATA, +startDocument, +startDTD, +startEntity, +startNonEscaping, +startPrefixMapping, +startPreserving, +unparsedEntityDecl
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+XMLSerializer

+
+public XMLSerializer()
+
+
Constructs a new serializer. The serializer cannot be used without + calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) + first.
+
+ +

+XMLSerializer

+
+public XMLSerializer(OutputFormat format)
+
+
Constructs a new serializer. The serializer cannot be used without + calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) + first.
+
+ +

+XMLSerializer

+
+public XMLSerializer(java.io.Writer writer,
+                     OutputFormat format)
+
+
Constructs a new serializer that writes to the specified writer + using the specified output format. If format is null, + will use a default output format.
+
Parameters:
writer - The writer to use
format - The output format to use, null for the default
+
+
+
+ +

+XMLSerializer

+
+public XMLSerializer(java.io.OutputStream output,
+                     OutputFormat format)
+
+
Constructs a new serializer that writes to the specified output + stream using the specified output format. If format + is null, will use a default output format.
+
Parameters:
output - The output stream to use
format - The output format to use, null for the default
+
+
+ + + + + + + + +
+Method Detail
+ +

+setOutputFormat

+
+public void setOutputFormat(OutputFormat format)
+
+
Description copied from interface: Serializer
+
Specifies an output format for this serializer. It the + serializer has already been associated with an output format, + it will switch to the new format. This method should not be + called while the serializer is in the process of serializing + a document.
+
Overrides:
setOutputFormat in class BaseMarkupSerializer
+
+
Tags copied from interface: Serializer
+
+
Parameters:
format - The output format to use
+
+
+
+ +

+startElement

+
+public void startElement(java.lang.String namespaceURI,
+                         java.lang.String localName,
+                         java.lang.String rawName,
+                         Attributes attrs)
+                  throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of the beginning of an element. + +

The Parser will invoke this method at the beginning of every + element in the XML document; there will be a corresponding + endElement event for every startElement event + (even when the element is empty). All of the element's content will be + reported, in order, before the corresponding endElement + event.

+ +

This event allows up to three name components for each + element:

+ +
    +
  1. the Namespace URI;
  2. +
  3. the local name; and
  4. +
  5. the qualified (prefixed) name.
  6. +
+ +

Any or all of these may be provided, depending on the + values of the http://xml.org/sax/features/namespaces + and the http://xml.org/sax/features/namespace-prefixes + properties:

+ +
    +
  • the Namespace URI and local name are required when + the namespaces property is true (the default), and are + optional when the namespaces property is false (if one is + specified, both must be);
  • +
  • the qualified name is required when the namespace-prefixes property + is true, and is optional when the namespace-prefixes property + is false (the default).
  • +
+ +

Note that the attribute list provided will contain only + attributes with explicit values (specified or defaulted): + #IMPLIED attributes will be omitted. The attribute list + will contain attributes used for Namespace declarations + (xmlns* attributes) only if the + http://xml.org/sax/features/namespace-prefixes + property is true (it is false by default, and support for a + true value is optional).

Tags copied from interface: ContentHandler
+
+
Parameters:
uri - The Namespace URI, or the empty string if the + element has no Namespace URI or if Namespace + processing is not being performed.
localName - The local name (without prefix), or the + empty string if Namespace processing is not being + performed.
qName - The qualified name (with prefix), or the + empty string if qualified names are not available.
atts - The attributes attached to the element. If + there are no attributes, it shall be an empty + Attributes object.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String), +Attributes
+
+
+
+ +

+endElement

+
+public void endElement(java.lang.String namespaceURI,
+                       java.lang.String localName,
+                       java.lang.String rawName)
+                throws SAXException
+
+
Description copied from interface: ContentHandler
+
Receive notification of the end of an element. + +

The SAX parser will invoke this method at the end of every + element in the XML document; there will be a corresponding + startElement event for every endElement + event (even when the element is empty).

+ +

For information on the names, see startElement.

Tags copied from interface: ContentHandler
+
+
Parameters:
uri - The Namespace URI, or the empty string if the + element has no Namespace URI or if Namespace + processing is not being performed.
localName - The local name (without prefix), or the + empty string if Namespace processing is not being + performed.
qName - The qualified XML 1.0 name (with prefix), or the + empty string if qualified names are not available.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
+
+
+
+ +

+endElementIO

+
+public void endElementIO(java.lang.String namespaceURI,
+                         java.lang.String localName,
+                         java.lang.String rawName)
+                  throws java.io.IOException
+
+
+
+ +

+startElement

+
+public void startElement(java.lang.String tagName,
+                         AttributeList attrs)
+                  throws SAXException
+
+
Description copied from interface: DocumentHandler
+
Receive notification of the beginning of an element. + +

The Parser will invoke this method at the beginning of every + element in the XML document; there will be a corresponding + endElement() event for every startElement() event (even when the + element is empty). All of the element's content will be + reported, in order, before the corresponding endElement() + event.

+ +

If the element name has a namespace prefix, the prefix will + still be attached. Note that the attribute list provided will + contain only attributes with explicit values (specified or + defaulted): #IMPLIED attributes will be omitted.

Tags copied from interface: DocumentHandler
+
+
Parameters:
name - The element type name.
atts - The attributes attached to the element, if any.
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
See Also:
DocumentHandler.endElement(java.lang.String), +AttributeList
+
+
+
+ +

+endElement

+
+public void endElement(java.lang.String tagName)
+                throws SAXException
+
+
Description copied from interface: DocumentHandler
+
Receive notification of the end of an element. + +

The SAX parser will invoke this method at the end of every + element in the XML document; there will be a corresponding + startElement() event for every endElement() event (even when the + element is empty).

+ +

If the element name has a namespace prefix, the prefix will + still be attached to the name.

Tags copied from interface: DocumentHandler
+
+
Parameters:
name - The element type name
Throws:
SAXException - Any SAX exception, possibly + wrapping another exception.
+
+
+
+ +

+startDocument

+
+protected void startDocument(java.lang.String rootTagName)
+                      throws java.io.IOException
+
+
Called to serialize the document's DOCTYPE by the root element. + The document type declaration must name the root element, + but the root element is only known when that element is serialized, + and not at the start of the document. +

+ This method will check if it has not been called before (BaseMarkupSerializer._started), + will serialize the document type declaration, and will serialize all + pre-root comments and PIs that were accumulated in the document + (see BaseMarkupSerializer.serializePreRoot()). Pre-root will be serialized even if + this is not the first root element of the document.

+
+ +

+serializeElement

+
+protected void serializeElement(Element elem)
+                         throws java.io.IOException
+
+
Called to serialize a DOM element. Equivalent to calling startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes), endElement(java.lang.String, java.lang.String, java.lang.String) and serializing everything + inbetween, but better optimized.
+
Overrides:
serializeElement in class BaseMarkupSerializer
+
+
Tags copied from class: BaseMarkupSerializer
+
+
Parameters:
elem - The element to serialize
Throws:
java.io.IOException - An I/O exception occured while + serializing
+
+
+
+ +

+getEntityRef

+
+protected java.lang.String getEntityRef(int ch)
+
+
Description copied from class: BaseMarkupSerializer
+
Returns the suitable entity reference for this character value, + or null if no such entity exists. Calling this method with '&' + will return "&".
+
Overrides:
getEntityRef in class BaseMarkupSerializer
+
+
Tags copied from class: BaseMarkupSerializer
+
+
Parameters:
ch - Character value
Returns:
Character entity name, or null
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/BaseMarkupSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/BaseMarkupSerializer.html new file mode 100644 index 0000000..fc77893 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/BaseMarkupSerializer.html @@ -0,0 +1,159 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.BaseMarkupSerializer + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.BaseMarkupSerializer

+
+ + + + + + + + + +
+Packages that use BaseMarkupSerializer
org.apache.xml.serialize  
+  +

+ + + + + +
+Uses of BaseMarkupSerializer in org.apache.xml.serialize
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Subclasses of BaseMarkupSerializer in org.apache.xml.serialize
+ classHTMLSerializer + +
+          Implements an HTML/XHTML serializer supporting both DOM and SAX + pretty serializing.
+ classTextSerializer + +
+          Implements a text serializer supporting both DOM and SAX + serializing.
+ classXHTMLSerializer + +
+          Implements an XHTML serializer supporting both DOM and SAX + pretty serializing.
+ classXMLSerializer + +
+          Implements an XML serializer supporting both DOM and SAX pretty + serializing.
+  +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/DOMSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/DOMSerializer.html new file mode 100644 index 0000000..724729f --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/DOMSerializer.html @@ -0,0 +1,192 @@ + + + + + + +Xerces-J API: Uses of Interface org.apache.xml.serialize.DOMSerializer + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Interface
org.apache.xml.serialize.DOMSerializer

+
+ + + + + + + + + +
+Packages that use DOMSerializer
org.apache.xml.serialize  
+  +

+ + + + + +
+Uses of DOMSerializer in org.apache.xml.serialize
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Classes in org.apache.xml.serialize that implement DOMSerializer
+ classBaseMarkupSerializer + +
+          Base class for a serializer supporting both DOM and SAX pretty + serializing of XML/HTML/XHTML documents.
+ classHTMLSerializer + +
+          Implements an HTML/XHTML serializer supporting both DOM and SAX + pretty serializing.
+ classTextSerializer + +
+          Implements a text serializer supporting both DOM and SAX + serializing.
+ classXHTMLSerializer + +
+          Implements an XHTML serializer supporting both DOM and SAX + pretty serializing.
+ classXMLSerializer + +
+          Implements an XML serializer supporting both DOM and SAX pretty + serializing.
+  +

+ + + + + + + + + + + + + +
Methods in org.apache.xml.serialize that return DOMSerializer
+ DOMSerializerBaseMarkupSerializer.asDOMSerializer() + +
+           
+ DOMSerializerSerializer.asDOMSerializer() + +
+          Return a DOMSerializer interface into this serializer.
+  +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/ElementState.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/ElementState.html new file mode 100644 index 0000000..706ab48 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/ElementState.html @@ -0,0 +1,167 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.ElementState + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.ElementState

+
+ + + + + + + + + +
+Packages that use ElementState
org.apache.xml.serialize  
+  +

+ + + + + +
+Uses of ElementState in org.apache.xml.serialize
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.apache.xml.serialize that return ElementState
+protected  ElementStateBaseMarkupSerializer.content() + +
+          Must be called by a method about to print any type of content.
+protected  ElementStateBaseMarkupSerializer.getElementState() + +
+          Return the state of the current element.
+protected  ElementStateBaseMarkupSerializer.enterElementState(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String rawName, + boolean preserveSpace) + +
+          Enter a new element state for the specified element.
+protected  ElementStateBaseMarkupSerializer.leaveElementState() + +
+          Leave the current element state and return to the + state of the parent element.
+protected  ElementStateTextSerializer.content() + +
+           
+  +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/EncodingInfo.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/EncodingInfo.html new file mode 100644 index 0000000..49ee79d --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/EncodingInfo.html @@ -0,0 +1,164 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.EncodingInfo + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.EncodingInfo

+
+ + + + + + + + + +
+Packages that use EncodingInfo
org.apache.xml.serialize  
+  +

+ + + + + +
+Uses of EncodingInfo in org.apache.xml.serialize
+  +

+ + + + + + + + + +
Subclasses of EncodingInfo in org.apache.xml.serialize
+ classSieveEncodingInfo + +
+          This class represents an encoding.
+  +

+ + + + + + + + + +
Methods in org.apache.xml.serialize that return EncodingInfo
+ EncodingInfoOutputFormat.getEncodingInfo() + +
+          Returns an EncodingInfo instance for the encoding.
+  +

+ + + + + + + + + +
Methods in org.apache.xml.serialize with parameters of type EncodingInfo
+ voidOutputFormat.setEncoding(EncodingInfo encInfo) + +
+          Sets the encoding for this output method with an EncodingInfo + instance.
+  +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Encodings.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Encodings.html new file mode 100644 index 0000000..43f1da1 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Encodings.html @@ -0,0 +1,95 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.Encodings + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.Encodings

+
+No usage of org.apache.xml.serialize.Encodings +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/HTMLSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/HTMLSerializer.html new file mode 100644 index 0000000..382f99c --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/HTMLSerializer.html @@ -0,0 +1,132 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.HTMLSerializer + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.HTMLSerializer

+
+ + + + + + + + + +
+Packages that use HTMLSerializer
org.apache.xml.serialize  
+  +

+ + + + + +
+Uses of HTMLSerializer in org.apache.xml.serialize
+  +

+ + + + + + + + + +
Subclasses of HTMLSerializer in org.apache.xml.serialize
+ classXHTMLSerializer + +
+          Implements an XHTML serializer supporting both DOM and SAX + pretty serializing.
+  +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/HTMLdtd.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/HTMLdtd.html new file mode 100644 index 0000000..8314ece --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/HTMLdtd.html @@ -0,0 +1,95 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.HTMLdtd + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.HTMLdtd

+
+No usage of org.apache.xml.serialize.HTMLdtd +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/IndentPrinter.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/IndentPrinter.html new file mode 100644 index 0000000..a1227ff --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/IndentPrinter.html @@ -0,0 +1,95 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.IndentPrinter + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.IndentPrinter

+
+No usage of org.apache.xml.serialize.IndentPrinter +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/LineSeparator.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/LineSeparator.html new file mode 100644 index 0000000..6621e29 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/LineSeparator.html @@ -0,0 +1,95 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.LineSeparator + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.LineSeparator

+
+No usage of org.apache.xml.serialize.LineSeparator +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Method.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Method.html new file mode 100644 index 0000000..12a4b74 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Method.html @@ -0,0 +1,95 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.Method + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.Method

+
+No usage of org.apache.xml.serialize.Method +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/OutputFormat.DTD.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/OutputFormat.DTD.html new file mode 100644 index 0000000..4b551fe --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/OutputFormat.DTD.html @@ -0,0 +1,95 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.OutputFormat.DTD + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.OutputFormat.DTD

+
+No usage of org.apache.xml.serialize.OutputFormat.DTD +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/OutputFormat.Defaults.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/OutputFormat.Defaults.html new file mode 100644 index 0000000..389fd86 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/OutputFormat.Defaults.html @@ -0,0 +1,95 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.OutputFormat.Defaults + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.OutputFormat.Defaults

+
+No usage of org.apache.xml.serialize.OutputFormat.Defaults +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/OutputFormat.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/OutputFormat.html new file mode 100644 index 0000000..08ba540 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/OutputFormat.html @@ -0,0 +1,319 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.OutputFormat + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.OutputFormat

+
+ + + + + + + + + +
+Packages that use OutputFormat
org.apache.xml.serialize  
+  +

+ + + + + +
+Uses of OutputFormat in org.apache.xml.serialize
+  +

+ + + + + + + + + + + + + +
Fields in org.apache.xml.serialize declared as OutputFormat
+protected  OutputFormatPrinter._format + +
+          The output format associated with this serializer.
+protected  OutputFormatBaseMarkupSerializer._format + +
+          The output format associated with this serializer.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.apache.xml.serialize with parameters of type OutputFormat
+ voidBaseMarkupSerializer.setOutputFormat(OutputFormat format) + +
+           
+ voidHTMLSerializer.setOutputFormat(OutputFormat format) + +
+           
+ voidXHTMLSerializer.setOutputFormat(OutputFormat format) + +
+           
+ voidTextSerializer.setOutputFormat(OutputFormat format) + +
+           
+ voidSerializer.setOutputFormat(OutputFormat format) + +
+          Specifies an output format for this serializer.
+ voidXMLSerializer.setOutputFormat(OutputFormat format) + +
+           
+abstract  SerializerSerializerFactory.makeSerializer(OutputFormat format) + +
+          Create a new serializer based on the OutputFormat.
+abstract  SerializerSerializerFactory.makeSerializer(java.io.Writer writer, + OutputFormat format) + +
+          Create a new serializer, based on the OutputFormat and + using the writer as the output character stream.
+abstract  SerializerSerializerFactory.makeSerializer(java.io.OutputStream output, + OutputFormat format) + +
+          Create a new serializer, based on the OutputFormat and + using the output byte stream and the encoding specified in the + output format.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constructors in org.apache.xml.serialize with parameters of type OutputFormat
Printer.Printer(java.io.Writer writer, + OutputFormat format) + +
+           
BaseMarkupSerializer.BaseMarkupSerializer(OutputFormat format) + +
+          Protected constructor can only be used by derived class.
HTMLSerializer.HTMLSerializer(boolean xhtml, + OutputFormat format) + +
+          Constructs a new HTML/XHTML serializer depending on the value of + xhtml.
HTMLSerializer.HTMLSerializer(OutputFormat format) + +
+          Constructs a new serializer.
HTMLSerializer.HTMLSerializer(java.io.Writer writer, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified writer + using the specified output format.
HTMLSerializer.HTMLSerializer(java.io.OutputStream output, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified output + stream using the specified output format.
XHTMLSerializer.XHTMLSerializer(OutputFormat format) + +
+          Constructs a new serializer.
XHTMLSerializer.XHTMLSerializer(java.io.Writer writer, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified writer + using the specified output format.
XHTMLSerializer.XHTMLSerializer(java.io.OutputStream output, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified output + stream using the specified output format.
XMLSerializer.XMLSerializer(OutputFormat format) + +
+          Constructs a new serializer.
XMLSerializer.XMLSerializer(java.io.Writer writer, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified writer + using the specified output format.
XMLSerializer.XMLSerializer(java.io.OutputStream output, + OutputFormat format) + +
+          Constructs a new serializer that writes to the specified output + stream using the specified output format.
+  +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Printer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Printer.html new file mode 100644 index 0000000..2ee67b7 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Printer.html @@ -0,0 +1,148 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.Printer + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.Printer

+
+ + + + + + + + + +
+Packages that use Printer
org.apache.xml.serialize  
+  +

+ + + + + +
+Uses of Printer in org.apache.xml.serialize
+  +

+ + + + + + + + + +
Subclasses of Printer in org.apache.xml.serialize
+ classIndentPrinter + +
+          Extends Printer and adds support for indentation and line + wrapping.
+  +

+ + + + + + + + + +
Fields in org.apache.xml.serialize declared as Printer
+protected  PrinterBaseMarkupSerializer._printer + +
+          The printer used for printing text parts.
+  +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Serializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Serializer.html new file mode 100644 index 0000000..5232bcb --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/Serializer.html @@ -0,0 +1,205 @@ + + + + + + +Xerces-J API: Uses of Interface org.apache.xml.serialize.Serializer + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Interface
org.apache.xml.serialize.Serializer

+
+ + + + + + + + + +
+Packages that use Serializer
org.apache.xml.serialize  
+  +

+ + + + + +
+Uses of Serializer in org.apache.xml.serialize
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Classes in org.apache.xml.serialize that implement Serializer
+ classBaseMarkupSerializer + +
+          Base class for a serializer supporting both DOM and SAX pretty + serializing of XML/HTML/XHTML documents.
+ classHTMLSerializer + +
+          Implements an HTML/XHTML serializer supporting both DOM and SAX + pretty serializing.
+ classTextSerializer + +
+          Implements a text serializer supporting both DOM and SAX + serializing.
+ classXHTMLSerializer + +
+          Implements an XHTML serializer supporting both DOM and SAX + pretty serializing.
+ classXMLSerializer + +
+          Implements an XML serializer supporting both DOM and SAX pretty + serializing.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in org.apache.xml.serialize that return Serializer
+abstract  SerializerSerializerFactory.makeSerializer(OutputFormat format) + +
+          Create a new serializer based on the OutputFormat.
+abstract  SerializerSerializerFactory.makeSerializer(java.io.Writer writer, + OutputFormat format) + +
+          Create a new serializer, based on the OutputFormat and + using the writer as the output character stream.
+abstract  SerializerSerializerFactory.makeSerializer(java.io.OutputStream output, + OutputFormat format) + +
+          Create a new serializer, based on the OutputFormat and + using the output byte stream and the encoding specified in the + output format.
+  +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/SerializerFactory.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/SerializerFactory.html new file mode 100644 index 0000000..935238e --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/SerializerFactory.html @@ -0,0 +1,149 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.SerializerFactory + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.SerializerFactory

+
+ + + + + + + + + +
+Packages that use SerializerFactory
org.apache.xml.serialize  
+  +

+ + + + + +
+Uses of SerializerFactory in org.apache.xml.serialize
+  +

+ + + + + + + + + +
Methods in org.apache.xml.serialize that return SerializerFactory
+static SerializerFactorySerializerFactory.getSerializerFactory(java.lang.String method) + +
+          Register a serializer factory, keyed by the given + method string.
+  +

+ + + + + + + + + +
Methods in org.apache.xml.serialize with parameters of type SerializerFactory
+static voidSerializerFactory.registerSerializerFactory(SerializerFactory factory) + +
+          Register a serializer factory, keyed by the given + method string.
+  +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/SieveEncodingInfo.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/SieveEncodingInfo.html new file mode 100644 index 0000000..dc811ed --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/SieveEncodingInfo.html @@ -0,0 +1,95 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.SieveEncodingInfo + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.SieveEncodingInfo

+
+No usage of org.apache.xml.serialize.SieveEncodingInfo +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/TextSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/TextSerializer.html new file mode 100644 index 0000000..c0f22eb --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/TextSerializer.html @@ -0,0 +1,95 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.TextSerializer + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.TextSerializer

+
+No usage of org.apache.xml.serialize.TextSerializer +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/XHTMLSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/XHTMLSerializer.html new file mode 100644 index 0000000..d3090dd --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/XHTMLSerializer.html @@ -0,0 +1,95 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.XHTMLSerializer + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.XHTMLSerializer

+
+No usage of org.apache.xml.serialize.XHTMLSerializer +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/XMLSerializer.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/XMLSerializer.html new file mode 100644 index 0000000..87b5b9d --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/class-use/XMLSerializer.html @@ -0,0 +1,95 @@ + + + + + + +Xerces-J API: Uses of Class org.apache.xml.serialize.XMLSerializer + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Class
org.apache.xml.serialize.XMLSerializer

+
+No usage of org.apache.xml.serialize.XMLSerializer +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-frame.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-frame.html new file mode 100644 index 0000000..70078a9 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-frame.html @@ -0,0 +1,73 @@ + + + + + + +Xerces-J API: Package org.apache.xml.serialize + + + + + +org.apache.xml.serialize + + + + +
+Interfaces  + +
+DOMSerializer +
+Serializer
+ + + + + + +
+Classes  + +
+BaseMarkupSerializer +
+ElementState +
+EncodingInfo +
+Encodings +
+HTMLdtd +
+HTMLSerializer +
+IndentPrinter +
+LineSeparator +
+Method +
+OutputFormat +
+OutputFormat.Defaults +
+OutputFormat.DTD +
+Printer +
+SerializerFactory +
+SieveEncodingInfo +
+TextSerializer +
+XHTMLSerializer +
+XMLSerializer
+ + + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-summary.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-summary.html new file mode 100644 index 0000000..7ba2fa5 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-summary.html @@ -0,0 +1,200 @@ + + + + + + +Xerces-J API: Package org.apache.xml.serialize + + + + + + + + + + + + + + + + + +
+ +
+ + +
+

+Package org.apache.xml.serialize +

+ + + + + + + + + + + + + +
+Interface Summary
DOMSerializerInterface for a DOM serializer implementation.
SerializerInterface for a DOM serializer implementation, factory for DOM and SAX + serializers, and static methods for serializing DOM documents.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
BaseMarkupSerializerBase class for a serializer supporting both DOM and SAX pretty + serializing of XML/HTML/XHTML documents.
ElementStateHolds the state of the currently serialized element.
EncodingInfoThis class represents an encoding.
EncodingsProvides information about encodings.
HTMLdtdUtility class for accessing information specific to HTML documents.
HTMLSerializerImplements an HTML/XHTML serializer supporting both DOM and SAX + pretty serializing.
IndentPrinterExtends Printer and adds support for indentation and line + wrapping.
LineSeparator 
Method 
OutputFormatSpecifies an output format to control the serializer.
OutputFormat.Defaults 
OutputFormat.DTD 
PrinterThe printer is responsible for sending text to the output stream + or writer.
SerializerFactory 
SieveEncodingInfoThis class represents an encoding.
TextSerializerImplements a text serializer supporting both DOM and SAX + serializing.
XHTMLSerializerImplements an XHTML serializer supporting both DOM and SAX + pretty serializing.
XMLSerializerImplements an XML serializer supporting both DOM and SAX pretty + serializing.
+  + +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-tree.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-tree.html new file mode 100644 index 0000000..1875604 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-tree.html @@ -0,0 +1,118 @@ + + + + + + +Xerces-J API: org.apache.xml.serialize Class Hierarchy + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Hierarchy For Package org.apache.xml.serialize +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + + diff --git a/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-use.html b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-use.html new file mode 100644 index 0000000..a5cff65 --- /dev/null +++ b/xerces-1_4_4/docs/html/apiDocs/org/apache/xml/serialize/package-use.html @@ -0,0 +1,173 @@ + + + + + + +Xerces-J API: Uses of Package org.apache.xml.serialize + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+

+Uses of Package
org.apache.xml.serialize

+
+ + + + + + + + + +
+Packages that use org.apache.xml.serialize
org.apache.xml.serialize  
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in org.apache.xml.serialize used by org.apache.xml.serialize
BaseMarkupSerializer + +
+          Base class for a serializer supporting both DOM and SAX pretty + serializing of XML/HTML/XHTML documents.
DOMSerializer + +
+          Interface for a DOM serializer implementation.
ElementState + +
+          Holds the state of the currently serialized element.
EncodingInfo + +
+          This class represents an encoding.
HTMLSerializer + +
+          Implements an HTML/XHTML serializer supporting both DOM and SAX + pretty serializing.
OutputFormat + +
+          Specifies an output format to control the serializer.
Printer + +
+          The printer is responsible for sending text to the output stream + or writer.
Serializer + +
+          Interface for a DOM serializer implementation, factory for DOM and SAX + serializers, and static methods for serializing DOM documents.
SerializerFactory + +
+           
+  +

+


+ + + + + + + + + + + + + +
+ +
+ + +
+Copyright � 1999-2001 Apache XML Project. All Rights Reserved. + +