IXmlSerializer Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Define an interface to serialization of XML Infoset.
[Android.Runtime.Register("org/xmlpull/v1/XmlSerializer", "", "Org.XmlPull.V1.IXmlSerializerInvoker")]
public interface IXmlSerializer : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable[<Android.Runtime.Register("org/xmlpull/v1/XmlSerializer", "", "Org.XmlPull.V1.IXmlSerializerInvoker")>]
type IXmlSerializer = interface
interface IJavaObject
interface IDisposable
interface IJavaPeerable- Attributes
- Implements
Remarks
Define an interface to serialization of XML Infoset. This interface abstracts away if serialized XML is XML 1.0 compatible text or other formats of XML 1.0 serializations (such as binary XML for example with WBXML).
<b>PLEASE NOTE:</b> This interface will be part of XmlPull 1.2 API. It is included as basis for discussion. It may change in any way.
Exceptions that may be thrown are: IOException or runtime exception (more runtime exceptions can be thrown but are not declared and as such have no semantics defined for this interface): <ul> <li><em>IllegalArgumentException</em> - for almost all methods to signal that argument is illegal <li><em>IllegalStateException</em> - to signal that call has good arguments but is not expected here (violation of contract) and for features/properties when requesting setting unimplemented feature/property (UnsupportedOperationException would be better but it is not in MIDP) </ul>
<b>NOTE:</b> writing CDSECT, ENTITY_REF, IGNORABLE_WHITESPACE, PROCESSING_INSTRUCTION, COMMENT, and DOCDECL in some implementations may not be supported (for example when serializing to WBXML). In such case IllegalStateException will be thrown and it is recommended to use an optional feature to signal that implementation is not supporting this kind of output.
Java documentation for org.xmlpull.v1.XmlSerializer.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Properties
| Depth |
Returns the current depth of the element. |
| Handle |
Gets the JNI value of the underlying Android object. (Inherited from IJavaObject) |
| JniIdentityHashCode |
Returns the value of |
| JniManagedPeerState |
State of the managed peer. (Inherited from IJavaPeerable) |
| JniPeerMembers |
Member access and invocation support. (Inherited from IJavaPeerable) |
| Name |
Returns the name of the current element as set by startTag(). |
| Namespace |
Returns the namespace URI of the current element as set by startTag(). |
| PeerReference |
Returns a JniObjectReference of the wrapped Java object instance. (Inherited from IJavaPeerable) |
Methods
| Attribute(String, String, String) |
Write an attribute. |
| Cdsect(String) | |
| Comment(String) | |
| Disposed() |
Called when the instance has been disposed. (Inherited from IJavaPeerable) |
| DisposeUnlessReferenced() |
If there are no outstanding references to this instance, then
calls |
| Docdecl(String) | |
| EndDocument() |
Finish writing. |
| EndTag(String, String) |
Write end tag. |
| EntityRef(String) | |
| Finalized() |
Called when the instance has been finalized. (Inherited from IJavaPeerable) |
| Flush() |
Write all pending output to the stream. |
| GetFeature(String) |
Return the current value of the feature with given name. |
| GetPrefix(String, Boolean) |
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. |
| GetProperty(String) |
Look up the value of a property. |
| IgnorableWhitespace(String) | |
| ProcessingInstruction(String) | |
| SetFeature(String, Boolean) |
Set feature identified by name (recommended to be URI for uniqueness). |
| SetJniIdentityHashCode(Int32) |
Set the value returned by |
| SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from IJavaPeerable) |
| SetOutput(Stream, String) |
Set to use binary output stream with given encoding. |
| SetOutput(Writer) |
Set the output to the given writer. |
| SetPeerReference(JniObjectReference) |
Set the value returned by |
| SetPrefix(String, String) |
Binds the given prefix to the given namespace. |
| SetProperty(String, Object) |
Set the value of a property. |
| StartDocument(String, Boolean) |
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. |
| StartTag(String, String) |
Writes a start tag with the given namespace and name. |
| Text(Char[], Int32, Int32) |
Writes text, where special XML chars are escaped automatically |
| Text(String) |
Writes text, where special XML chars are escaped automatically |
| UnregisterFromRuntime() |
Unregister this instance so that the runtime will not return it from future Java.Interop.JniRuntime+JniValueManager.PeekValue invocations. (Inherited from IJavaPeerable) |