xyz.cofe.xml

Class FormatXMLWriter

java.lang.Object

xyz.cofe.xml.FormatXMLWriter

All Implemented Interfaces:

XMLStreamWriter

public class FormatXMLWriter
extends Object
implements XMLStreamWriter

XMLWriter с поддержкой отступов, и поддержкой экранирования

Author:

gocha

Constructor Summary

Constructors

Constructor and Description
FormatXMLWriter() Конструктор по умолчанию
FormatXMLWriter(File file, Charset encoding)
FormatXMLWriter(File file, Charset encoding)
FormatXMLWriter(OutputStream stream) Конструктор
FormatXMLWriter(OutputStream stream, Charset enconding) Конструктор
FormatXMLWriter(OutputStream stream, String enconding) Конструктор
FormatXMLWriter(Path file, Charset encoding)
FormatXMLWriter(Result result) Конструктр
FormatXMLWriter(Writer writer) Конструктор
FormatXMLWriter(XMLStreamWriter writer) Конструктор

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
Integer	getLevel()
NamespaceContext	getNamespaceContext()
String	getNewline()
String	getPrefix(String uri)
Object	getProperty(String name)
String	getSpacer()
XMLStreamWriter	getWriter()
static String	htmlDecode(String html) Декодирует строку html (замееняет символы &,<,> на соответствующие)
static String	htmlEncode(String text) Кодирует строку в формат html (замееняет символы &,<,> на соответствующие)
boolean	isEscapeWriteChars() Экранирует символы проходящие через методы writeCharacters.
boolean	isWriteOutline()
boolean	isWriteStartDocument()
void	setDefaultNamespace(String uri)
void	setEscapeWriteChars(boolean escapeWriteChars) Устанавливае Экранирует символы проходящие через методы writeCharacters.
void	setNamespaceContext(NamespaceContext context)
void	setNewline(String newline)
void	setPrefix(String prefix, String uri)
void	setSpacer(String spacer)
void	setWriteOutline(boolean writeOutline)
void	setWriteStartDocument(boolean writeStartDocument)
static String	toStringWithException(Node xmlDocument) Конвертирует XMLDOM древо в текстовое представление
static String	toStringWithoutException(Node xmlDocument, String defaultResult) Конвертирует XMLDOM древо в текстовое представление с подовлением исключений
void	writeAttribute(String localName, String value)
void	writeAttribute(String namespaceURI, String localName, String value)
void	writeAttribute(String prefix, String namespaceURI, String localName, String value)
void	writeCData(String data)
void	writeCharacters(char[] text, int start, int len)
void	writeCharacters(String text)
void	writeComment(String data)
void	writeDefaultNamespace(String namespaceURI)
void	writeDTD(String dtd)
void	writeEmptyElement(String localName)
void	writeEmptyElement(String namespaceURI, String localName)
void	writeEmptyElement(String prefix, String localName, String namespaceURI)
void	writeEndDocument()
void	writeEndElement()
void	writeEntityRef(String name)
void	writeEscapeCharacters(char[] text, int start, int len)
void	writeEscapeCharacters(String text) Кодирует и пишет текст
void	writeNamespace(String prefix, String namespaceURI)
void	writeProcessingInstruction(String target)
void	writeProcessingInstruction(String target, String data)
void	writeStartDocument()
void	writeStartDocument(String version)
void	writeStartDocument(String encoding, String version)
void	writeStartElement(String localName)
void	writeStartElement(String namespaceURI, String localName)
void	writeStartElement(String prefix, String localName, String namespaceURI)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatXMLWriter

public FormatXMLWriter(File file,
                       Charset encoding)

FormatXMLWriter

public FormatXMLWriter(Path file,
                       Charset encoding)

FormatXMLWriter

public FormatXMLWriter(File file,
                       Charset encoding)

FormatXMLWriter

public FormatXMLWriter()

Конструктор по умолчанию

FormatXMLWriter

public FormatXMLWriter(XMLStreamWriter writer)

Конструктор

Parameters:

writer - исходный XMLStreamWriter

FormatXMLWriter

public FormatXMLWriter(Writer writer)
                throws XMLStreamException

Конструктор

Parameters:

writer - исходный Writer

Throws:

XMLStreamException - Ошибка IO

FormatXMLWriter

public FormatXMLWriter(OutputStream stream,
                       String enconding)
                throws XMLStreamException

Конструктор

Parameters:

stream - Поток куда будет писаться

enconding - Кодировка

Throws:

XMLStreamException - Мало ли что

FormatXMLWriter

public FormatXMLWriter(OutputStream stream,
                       Charset enconding)
                throws XMLStreamException

Конструктор

Parameters:

stream - Поток куда будет писаться

enconding - Кодировка

Throws:

XMLStreamException - Мало ли что

FormatXMLWriter

public FormatXMLWriter(OutputStream stream)
                throws XMLStreamException

Конструктор

Parameters:

stream - Поток куда будет писаться

Throws:

XMLStreamException - Мало ли что

FormatXMLWriter

public FormatXMLWriter(Result result)
                throws XMLStreamException

Конструктр

Parameters:

result - Поток куда будет писаться

Throws:

XMLStreamException - Мало ли что

Method Detail

isWriteOutline

public boolean isWriteOutline()

setWriteOutline

public void setWriteOutline(boolean writeOutline)

isEscapeWriteChars

public boolean isEscapeWriteChars()

Экранирует символы проходящие через методы writeCharacters. (по умол. нет)

Returns:

Экранирует (по умол. нет)

setEscapeWriteChars

public void setEscapeWriteChars(boolean escapeWriteChars)

Устанавливае Экранирует символы проходящие через методы writeCharacters. (по умол. нет)

Parameters:

escapeWriteChars - Экранирует (по умол. нет)

htmlEncode

public static String htmlEncode(String text)

Кодирует строку в формат html (замееняет символы &,<,> на соответствующие)

Parameters:

text - Текст

Returns:

Кодированный текст

htmlDecode

public static String htmlDecode(String html)

Декодирует строку html (замееняет символы &,<,> на соответствующие)

Parameters:

html - Текст

Returns:

Декодированный текст

writeEscapeCharacters

public void writeEscapeCharacters(String text)
                           throws XMLStreamException

Кодирует и пишет текст

Parameters:

text - Текст

Throws:

XMLStreamException - IO Ошибка

writeEscapeCharacters

public void writeEscapeCharacters(char[] text,
                                  int start,
                                  int len)
                           throws XMLStreamException

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String namespaceURI,
                              String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String prefix,
                              String localName,
                              String namespaceURI)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument()
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(String version)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(String encoding,
                               String version)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target,
                                       String data)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Throws:

XMLStreamException

writeNamespace

public void writeNamespace(String prefix,
                           String namespaceURI)
                    throws XMLStreamException

Specified by:

writeNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

writeEntityRef

public void writeEntityRef(String name)
                    throws XMLStreamException

Specified by:

writeEntityRef in interface XMLStreamWriter

Throws:

XMLStreamException

writeEndElement

public void writeEndElement()
                     throws XMLStreamException

Specified by:

writeEndElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEndDocument

public void writeEndDocument()
                      throws XMLStreamException

Specified by:

writeEndDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String namespaceURI,
                              String localName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String prefix,
                              String localName,
                              String namespaceURI)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String localName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeDefaultNamespace

public void writeDefaultNamespace(String namespaceURI)
                           throws XMLStreamException

Specified by:

writeDefaultNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

writeDTD

public void writeDTD(String dtd)
              throws XMLStreamException

Specified by:

writeDTD in interface XMLStreamWriter

Throws:

XMLStreamException

writeComment

public void writeComment(String data)
                  throws XMLStreamException

Specified by:

writeComment in interface XMLStreamWriter

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(String text)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(char[] text,
                            int start,
                            int len)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Throws:

XMLStreamException

writeCData

public void writeCData(String data)
                throws XMLStreamException

Specified by:

writeCData in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String localName,
                           String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String prefix,
                           String namespaceURI,
                           String localName,
                           String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String namespaceURI,
                           String localName,
                           String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

setSpacer

public void setSpacer(String spacer)

setPrefix

public void setPrefix(String prefix,
                      String uri)
               throws XMLStreamException

Specified by:

setPrefix in interface XMLStreamWriter

Throws:

XMLStreamException

setNewline

public void setNewline(String newline)

setNamespaceContext

public void setNamespaceContext(NamespaceContext context)
                         throws XMLStreamException

Specified by:

setNamespaceContext in interface XMLStreamWriter

Throws:

XMLStreamException

setDefaultNamespace

public void setDefaultNamespace(String uri)
                         throws XMLStreamException

Specified by:

setDefaultNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

getWriter

public XMLStreamWriter getWriter()

getSpacer

public String getSpacer()

getProperty

public Object getProperty(String name)
                   throws IllegalArgumentException

Specified by:

getProperty in interface XMLStreamWriter

Throws:

IllegalArgumentException

getPrefix

public String getPrefix(String uri)
                 throws XMLStreamException

Specified by:

getPrefix in interface XMLStreamWriter

Throws:

XMLStreamException

getNewline

public String getNewline()

getNamespaceContext

public NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface XMLStreamWriter

getLevel

public Integer getLevel()

flush

public void flush()
           throws XMLStreamException

Specified by:

flush in interface XMLStreamWriter

Throws:

XMLStreamException

close

public void close()
           throws XMLStreamException

Specified by:

close in interface XMLStreamWriter

Throws:

XMLStreamException

isWriteStartDocument

public boolean isWriteStartDocument()

setWriteStartDocument

public void setWriteStartDocument(boolean writeStartDocument)

toStringWithException

public static String toStringWithException(Node xmlDocument)
                                    throws XMLStreamException,
                                           TransformerConfigurationException,
                                           TransformerException,
                                           IOException

Конвертирует XMLDOM древо в текстовое представление

Parameters:

xmlDocument - XMLDOM древо

Returns:

Текстовое представление XMLDOM древа

Throws:

XMLStreamException - Если не смогло

TransformerConfigurationException - Если не смогло

TransformerException - Если не смогло

IOException - Если не смогло

toStringWithoutException

public static String toStringWithoutException(Node xmlDocument,
                                              String defaultResult)

Конвертирует XMLDOM древо в текстовое представление с подовлением исключений

Parameters:

xmlDocument - XMLDOM древо

defaultResult - Результат возвращаем в случае, если не смогло сковертировать

Returns:

Текстовое представление XMLDOM древа