Java toXmlFile - XmlObjectInterface

In This Topic

void toXmlFile(String fileName)
                             throws LtException,
                                        FileNotFoundException
                                        UnsupportedEncodingException,
                                        IOException

void toXmlFile(String FileName, EOLType EOL)
                             throws LtException,
                                        FileNotFoundException,
                                        IOException;

void toXmlFile(                String fileName,
                                        boolean bIncludeDocHeader,
                                        Formatting formatting,
                                        Encoding encoding,
                                        EOLType EOL)
                             throws LtException,
                                        FileNotFoundException,
                                        UnsupportedEncodingException,
                                        IOException;

void toXmlFile(                String FileName,
                                        boolean includeDocHeader,
                                        Formatting formatting,
                                        Encoding encoding,
                                        EOLType EOL,
                                        com.liquid_technologies.ltxmllib20.SerializationContext context)
                             throws LtException,
                                        FileNotFoundException,
                                        UnsupportedEncodingException,
                                        IOException;

		Property	Description
		Method Name	toXMLFile
		Argument - fileName	The name of the file to write the XML to
		Argument - includeDocHeader	Default true. If this is true then then header <?xml version="1.0" standalone="yes"?> is applied to the output (making it a proper XML document as opposed to a snippet).
		Argument - formatting	Default Formatting.Indented. Indicates how the XML should be formatted
		Argument - encoding	Default Encoding.UTF8. Allows you to change the encoding used (UTF8, UTF16 etc)
		Argument - EOL	Default EOLType.CRLF. Allows you to change the Eond Of Line token (CR for unix or CRLF windows)
		Argument - context	The SerializationContext object controls the way in which XML is serialized/de-serialized. Its main role is to control the way in which validation is performed and which namespaces are output. If this is not specified, the a default (SerializationContext.Default global static) instance of the class is used. If you are using several libraries generated from different schemas, or you want to change the way validation is performed for during the lifetime of the application or you are writing multithreaded code, then you should consider creating your own instance(s) of the SerializationContext. If you are writing a multithreaded app it is highly recommended that you use a different instance of this class on each thread, as access to the static instance is not synchronized. Although read only operations to the static instance (SerializationContext ::Default) of the class are thread safe, if the global instance SerializationContext ::Default is modified, then this could potentially cause threading problems.
		Description	Writes XML from the current object to a file
		Remarks	If the file already exists it is overwritten, if it does not exist it is created. It will raise an exception if the XML within the object is not invalid, i.e. invalid number of entries in a collection. If the encoding is UTF-8 (the default) then the file is written out using the UTF-8 encoding scheme. It should be noted that UTF-8 encoding will encode characters using 1-4 bytes. As such if the file is examined with a viewer that is not capable of decoding UTF-8, it will appear to contain odd characters. However if it is viewed with a compliant viewer (e.g. IExplorer) the file will appear as expected. See Multi-Language Support for more information. If the encoding selected is UNICODE, then the file is written out using 2 bytes per character. The standard 0xff 0xfe are placed at the beginning of the file to indicate to other applications that it is a UNICODE file.

Send Feedback