パッケージ org.xmlpull.v1.wrapper.classic

クラス XmlSerializerDelegate

java.lang.Object

org.xmlpull.v1.wrapper.classic.XmlSerializerDelegate

すべての実装されたインタフェース:

XmlSerializer

直系の既知のサブクラス:

StaticXmlSerializerWrapper

public class XmlSerializerDelegate
extends Object
implements XmlSerializer

This is simple class that implements serializer interface by delegating all calls to actual serialzier implementation passed in constructor. Purpose of this class is to work as base class to allow extending interface by wrapping exsiting parser implementation and allowing ot add new methods.

作成者:

Aleksander Slominski

フィールドの概要

フィールド

修飾子とタイプ	フィールド	説明
protected XmlSerializer	xs

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
XmlSerializerDelegate(XmlSerializer serializer)

メソッドの概要

修飾子とタイプ	メソッド	説明
XmlSerializer	attribute(String namespace, String name, String value)	Write an attribute.
void	cdsect(String text)
void	comment(String text)
void	docdecl(String text)
void	endDocument()	Finish writing.
XmlSerializer	endTag(String namespace, String name)	Write end tag.
void	entityRef(String text)
void	flush()	Write all pending output to the stream.
int	getDepth()	Returns the current depth of the element.
boolean	getFeature(String name)	Return the current value of the feature with given name.
String	getName()	Returns the name of the current element as set by startTag().
String	getNamespace()	Returns the namespace URI of the current element as set by startTag().
String	getPrefix(String namespace, boolean generatePrefix)	Return namespace that corresponds to given prefix If there is no prefix bound to this namespace return null but if generatePrefix is false then return generated prefix.
Object	getProperty(String name)	Look up the value of a property.
void	ignorableWhitespace(String text)
void	processingInstruction(String text)
void	setFeature(String name, boolean state)	Set feature identified by name (recommended to be URI for uniqueness).
void	setOutput(OutputStream os, String encoding)	Set to use binary output stream with given encoding.
void	setOutput(Writer writer)	Set the output to the given writer.
void	setPrefix(String prefix, String namespace)	Binds the given prefix to the given namespace.
void	setProperty(String name, Object value)	Set the value of a property.
void	startDocument(String encoding, Boolean standalone)	Write <?xml declaration with encoding (if encoding not null) and standalone flag (if standalone not null) This method can only be called just after setOutput.
XmlSerializer	startTag(String namespace, String name)	Writes a start tag with the given namespace and name.
XmlSerializer	text(char[] buf, int start, int len)	Writes text, where special XML chars are escaped automatically
XmlSerializer	text(String text)	Writes text, where special XML chars are escaped automatically

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

xs

protected XmlSerializer xs

コンストラクタの詳細

XmlSerializerDelegate

public XmlSerializerDelegate(XmlSerializer serializer)

メソッドの詳細

getName

public String getName()

インタフェースからコピーされた説明: XmlSerializer

Returns the name of the current element as set by startTag(). It can only be null before first call to startTag() or when last endTag() is called to close first startTag().

定義:

getName インタフェース内 XmlSerializer

戻り値:

namespace set by startTag() that is currently in scope

setPrefix

public void setPrefix(String prefix,
                      String namespace)
               throws IOException,
                      IllegalArgumentException,
                      IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Binds the given prefix to the given namespace. This call is valid for the next element including child elements. The prefix and namespace MUST be always declared even if prefix is not used in element (startTag() or attribute()) - for XML 1.0 it must result in declaring xmlns:prefix='namespace' (or xmlns:prefix="namespace" depending what character is used to quote attribute value).

NOTE: this method MUST be called directly before startTag() and if anything but startTag() or setPrefix() is called next there will be exception.

NOTE: prefixes "xml" and "xmlns" are already bound and can not be redefined see: Namespaces in XML Errata.

NOTE: to set default namespace use as prefix empty string.

定義:

setPrefix インタフェース内 XmlSerializer

パラメータ:

prefix - must be not null (or IllegalArgumentException is thrown)

namespace - must be not null

例外:

IOException

IllegalArgumentException

IllegalStateException

setOutput

public void setOutput(OutputStream os,
                      String encoding)
               throws IOException,
                      IllegalArgumentException,
                      IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Set to use binary output stream with given encoding.

定義:

setOutput インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

endDocument

public void endDocument()
                 throws IOException,
                        IllegalArgumentException,
                        IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Finish writing. All unclosed start tags will be closed and output will be flushed. After calling this method no more output can be serialized until next call to setOutput()

定義:

endDocument インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

comment

public void comment(String text)
             throws IOException,
                    IllegalArgumentException,
                    IllegalStateException

定義:

comment インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

getDepth

public int getDepth()

インタフェースからコピーされた説明: XmlSerializer

Returns the current depth of the element. Outside the root element, the depth is 0. The depth is incremented by 1 when startTag() is called. The depth is decremented after the call to endTag() event was observed.

 <!-- outside -->     0
 <root>               1
   sometext                 1
     <foobar>         2
     </foobar>        2
 </root>              1
 <!-- outside -->     0
 

定義:

getDepth インタフェース内 XmlSerializer

setProperty

public void setProperty(String name,
                        Object value)
                 throws IllegalArgumentException,
                        IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Set the value of a property. (the property name is recommened to be URI for uniqueness). Some well known optional properties are defined in http://www.xmlpull.org/v1/doc/properties.html. If property is not recocgnized or can not be set then IllegalStateException MUST be thrown.

定義:

setProperty インタフェース内 XmlSerializer

例外:

IllegalStateException - if the property is not supported or can not be set

IllegalArgumentException

cdsect

public void cdsect(String text)
            throws IOException,
                   IllegalArgumentException,
                   IllegalStateException

定義:

cdsect インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

setFeature

public void setFeature(String name,
                       boolean state)
                throws IllegalArgumentException,
                       IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Set feature identified by name (recommended to be URI for uniqueness). Some well known optional features are defined in http://www.xmlpull.org/v1/doc/features.html. If feature is not recocgnized or can not be set then IllegalStateException MUST be thrown.

定義:

setFeature インタフェース内 XmlSerializer

例外:

IllegalStateException - If the feature is not supported or can not be set

IllegalArgumentException

entityRef

public void entityRef(String text)
               throws IOException,
                      IllegalArgumentException,
                      IllegalStateException

定義:

entityRef インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

processingInstruction

public void processingInstruction(String text)
                           throws IOException,
                                  IllegalArgumentException,
                                  IllegalStateException

定義:

processingInstruction インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

setOutput

public void setOutput(Writer writer)
               throws IOException,
                      IllegalArgumentException,
                      IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Set the output to the given writer.

WARNING no information about encoding is available!

定義:

setOutput インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

docdecl

public void docdecl(String text)
             throws IOException,
                    IllegalArgumentException,
                    IllegalStateException

定義:

docdecl インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

flush

public void flush()
           throws IOException

インタフェースからコピーされた説明: XmlSerializer

Write all pending output to the stream. If method startTag() or attribute() was called then start tag is closed (final >) before flush() is called on underlying output stream.

NOTE: if there is need to close start tag (so no more attribute() calls are allowed) but without flushinging output call method text() with empty string (text("")).

定義:

flush インタフェース内 XmlSerializer

例外:

IOException

getProperty

public Object getProperty(String name)

インタフェースからコピーされた説明: XmlSerializer

Look up the value of a property. The property name is any fully-qualified URI. I

NOTE: unknown properties are always returned as null

定義:

getProperty インタフェース内 XmlSerializer

パラメータ:

name - The name of property to be retrieved.

戻り値:

The value of named property.

startTag

public XmlSerializer startTag(String namespace,
                              String name)
                       throws IOException,
                              IllegalArgumentException,
                              IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Writes a start tag with the given namespace and name. If there is no prefix defined for the given namespace, a prefix will be defined automatically. The explicit prefixes for namespaces can be established by calling setPrefix() immediately before this method. If namespace is null no namespace prefix is printed but just name. If namespace is empty string then serialzier will make sure that default empty namespace is declared (in XML 1.0 xmlns='') or throw IllegalStateException if default namespace is already bound to non-empty string.

定義:

startTag インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

ignorableWhitespace

public void ignorableWhitespace(String text)
                         throws IOException,
                                IllegalArgumentException,
                                IllegalStateException

定義:

ignorableWhitespace インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

text

public XmlSerializer text(String text)
                   throws IOException,
                          IllegalArgumentException,
                          IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Writes text, where special XML chars are escaped automatically

定義:

text インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

getFeature

public boolean getFeature(String name)

インタフェースからコピーされた説明: XmlSerializer

Return the current value of the feature with given name.

NOTE: unknown properties are always returned as null

定義:

getFeature インタフェース内 XmlSerializer

パラメータ:

name - The name of feature to be retrieved.

戻り値:

The value of named feature.

attribute

public XmlSerializer attribute(String namespace,
                               String name,
                               String value)
                        throws IOException,
                               IllegalArgumentException,
                               IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Write an attribute. Calls to attribute() MUST follow a call to startTag() immediately. If there is no prefix defined for the given namespace, a prefix will be defined automatically. If namespace is null or empty string no namespace prefix is printed but just name.

定義:

attribute インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

startDocument

public void startDocument(String encoding,
                          Boolean standalone)
                   throws IOException,
                          IllegalArgumentException,
                          IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Write <?xml declaration with encoding (if encoding not null) and standalone flag (if standalone not null) This method can only be called just after setOutput.

定義:

startDocument インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

getPrefix

public String getPrefix(String namespace,
                        boolean generatePrefix)
                 throws IllegalArgumentException

インタフェースからコピーされた説明: XmlSerializer

Return namespace that corresponds to given prefix If there is no prefix bound to this namespace return null but if generatePrefix is false then return generated prefix.

NOTE: if the prefix is empty string "" and defualt namespace is bound to this prefix then empty string ("") is returned.

NOTE: prefixes "xml" and "xmlns" are already bound will have values as defined Namespaces in XML specification

定義:

getPrefix インタフェース内 XmlSerializer

例外:

IllegalArgumentException

getNamespace

public String getNamespace()

インタフェースからコピーされた説明: XmlSerializer

Returns the namespace URI of the current element as set by startTag().

NOTE: that measn in particaulr that:

• if there was startTag("", ...) then getNamespace() returns ""
• if there was startTag(null, ...) then getNamespace() returns null

定義:

getNamespace インタフェース内 XmlSerializer

戻り値:

namespace set by startTag() that is currently in scope

endTag

public XmlSerializer endTag(String namespace,
                            String name)
                     throws IOException,
                            IllegalArgumentException,
                            IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Write end tag. Repetition of namespace and name is just for avoiding errors.

Background: in kXML endTag had no arguments, and non matching tags were very difficult to find... If namespace is null no namespace prefix is printed but just name. If namespace is empty string then serialzier will make sure that default empty namespace is declared (in XML 1.0 xmlns='').

定義:

endTag インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException

text

public XmlSerializer text(char[] buf,
                          int start,
                          int len)
                   throws IOException,
                          IllegalArgumentException,
                          IllegalStateException

インタフェースからコピーされた説明: XmlSerializer

Writes text, where special XML chars are escaped automatically

定義:

text インタフェース内 XmlSerializer

例外:

IOException

IllegalArgumentException

IllegalStateException