Performs serialization and deserialization of objects into and from XML documents. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Object.

Public Member Functions

virtual ASPOSECPP_SHARED_API bool CanDeserialize (System::SharedPtr< XmlReader > xmlReader)
 Checks if specific reader is in deserializable state. More...
 
ASPOSECPP_SHARED_API System::SharedPtr< ObjectDeserialize (System::SharedPtr< IO::Stream > stream)
 Deserializes XML document into object. More...
 
ASPOSECPP_SHARED_API System::SharedPtr< ObjectDeserialize (System::SharedPtr< IO::TextReader > textReader)
 Deserializes XML document into object. More...
 
ASPOSECPP_SHARED_API System::SharedPtr< ObjectDeserialize (System::SharedPtr< XmlReader > xmlReader)
 Deserializes XML document into object. More...
 
ASPOSECPP_SHARED_API void Serialize (System::SharedPtr< IO::Stream > stream, System::SharedPtr< Object > o)
 Serializes document into XML. More...
 
ASPOSECPP_SHARED_API void Serialize (System::SharedPtr< IO::TextWriter > textWriter, System::SharedPtr< Object > o)
 Serializes document into XML. More...
 
ASPOSECPP_SHARED_API void Serialize (System::SharedPtr< XmlWriter > xmlWriter, System::SharedPtr< Object > o)
 Serializes document into XML. More...
 
ASPOSECPP_SHARED_API void Serialize (System::SharedPtr< IO::Stream > stream, System::SharedPtr< Object > o, System::SharedPtr< XmlSerializerNamespaces > namespaces)
 Serializes document into XML. More...
 
ASPOSECPP_SHARED_API void Serialize (System::SharedPtr< IO::TextWriter > textWriter, System::SharedPtr< Object > o, System::SharedPtr< XmlSerializerNamespaces > namespaces)
 Serializes document into XML. More...
 
ASPOSECPP_SHARED_API void Serialize (System::SharedPtr< XmlWriter > xmlWriter, System::SharedPtr< Object > o, System::SharedPtr< XmlSerializerNamespaces > namespaces)
 Serializes document into XML. More...
 
ASPOSECPP_SHARED_API System::SharedPtr< ObjectDeserialize (System::SharedPtr< XmlReader > xmlReader, String encodingStyle)
 Deserializes XML document into object. More...
 
ASPOSECPP_SHARED_API void Serialize (System::SharedPtr< XmlWriter > xmlWriter, System::SharedPtr< Object > o, System::SharedPtr< XmlSerializerNamespaces > namespaces, String encodingStyle)
 Serializes document into XML. More...
 
ASPOSECPP_SHARED_API void Serialize (System::SharedPtr< XmlWriter > xmlWriter, System::SharedPtr< Object > o, System::SharedPtr< XmlSerializerNamespaces > namespaces, String encodingStyle, String id)
 Serializes document into XML. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Static Public Attributes

static ASPOSECPP_SHARED_API const String WsdlNamespace
 WSDL namespace name. More...
 
static ASPOSECPP_SHARED_API const String EncodingNamespace
 Encoding namespace name. More...
 
static ASPOSECPP_SHARED_API const String WsdlTypesNamespace
 WSDL types namespace name. More...
 

Protected Member Functions

ASPOSECPP_SHARED_API XmlSerializer ()
 Constructor. More...
 
virtual ASPOSECPP_SHARED_API System::SharedPtr< XmlSerializationReaderCreateReader ()
 Creates reader object. More...
 
virtual ASPOSECPP_SHARED_API System::SharedPtr< XmlSerializationWriterCreateWriter ()
 Creates writer object. More...
 
virtual ASPOSECPP_SHARED_API System::SharedPtr< ObjectDeserialize (System::SharedPtr< XmlSerializationReader > reader)
 Deeserializes document read from specific reader. More...
 
virtual ASPOSECPP_SHARED_API void Serialize (System::SharedPtr< Object > o, System::SharedPtr< XmlSerializationWriter > writer)
 Serializes object. More...
 

Static Protected Member Functions

static ASPOSECPP_SHARED_API System::SharedPtr< Text::Encodingget_DefaultEncoding ()
 Gets encoding used by default. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Performs serialization and deserialization of objects into and from XML documents. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ XmlSerializer()

ASPOSECPP_SHARED_API System::Xml::Serialization::XmlSerializer::XmlSerializer ( )
protected

Constructor.

Member Function Documentation

◆ CanDeserialize()

virtual ASPOSECPP_SHARED_API bool System::Xml::Serialization::XmlSerializer::CanDeserialize ( System::SharedPtr< XmlReader xmlReader)
virtual

Checks if specific reader is in deserializable state.

Parameters
xmlReaderReader to check.
Returns
true if xmlReader can be deserialized, false otherwise.

◆ CreateReader()

virtual ASPOSECPP_SHARED_API System::SharedPtr<XmlSerializationReader> System::Xml::Serialization::XmlSerializer::CreateReader ( )
protectedvirtual

Creates reader object.

◆ CreateWriter()

virtual ASPOSECPP_SHARED_API System::SharedPtr<XmlSerializationWriter> System::Xml::Serialization::XmlSerializer::CreateWriter ( )
protectedvirtual

Creates writer object.

◆ Deserialize() [1/5]

ASPOSECPP_SHARED_API System::SharedPtr<Object> System::Xml::Serialization::XmlSerializer::Deserialize ( System::SharedPtr< IO::Stream stream)

Deserializes XML document into object.

Parameters
streamStream to read document from.
Returns
Object that was previously serialized into the document given.

◆ Deserialize() [2/5]

ASPOSECPP_SHARED_API System::SharedPtr<Object> System::Xml::Serialization::XmlSerializer::Deserialize ( System::SharedPtr< IO::TextReader textReader)

Deserializes XML document into object.

Parameters
textReaderReader to read document from.
Returns
Object that was previously serialized into the document given.

◆ Deserialize() [3/5]

ASPOSECPP_SHARED_API System::SharedPtr<Object> System::Xml::Serialization::XmlSerializer::Deserialize ( System::SharedPtr< XmlReader xmlReader)

Deserializes XML document into object.

Parameters
xmlReaderReader to read document from.
Returns
Object that was previously serialized into the document given.

◆ Deserialize() [4/5]

ASPOSECPP_SHARED_API System::SharedPtr<Object> System::Xml::Serialization::XmlSerializer::Deserialize ( System::SharedPtr< XmlReader xmlReader,
String  encodingStyle 
)

Deserializes XML document into object.

Parameters
xmlReaderReader to read document from.
encodingStyleStyle used to serialize object.
Returns
Object that was previously serialized into the document given.

◆ Deserialize() [5/5]

virtual ASPOSECPP_SHARED_API System::SharedPtr<Object> System::Xml::Serialization::XmlSerializer::Deserialize ( System::SharedPtr< XmlSerializationReader reader)
protectedvirtual

Deeserializes document read from specific reader.

◆ get_DefaultEncoding()

static ASPOSECPP_SHARED_API System::SharedPtr<Text::Encoding> System::Xml::Serialization::XmlSerializer::get_DefaultEncoding ( )
staticprotected

Gets encoding used by default.

◆ Serialize() [1/9]

ASPOSECPP_SHARED_API void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< IO::Stream stream,
System::SharedPtr< Object o 
)

Serializes document into XML.

Parameters
streamDestination stream.
oObject to serialize.

◆ Serialize() [2/9]

ASPOSECPP_SHARED_API void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< IO::TextWriter textWriter,
System::SharedPtr< Object o 
)

Serializes document into XML.

Parameters
textWriterDestination stream.
oObject to serialize.

◆ Serialize() [3/9]

ASPOSECPP_SHARED_API void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< XmlWriter xmlWriter,
System::SharedPtr< Object o 
)

Serializes document into XML.

Parameters
xmlWriterDestination stream.
oObject to serialize.

◆ Serialize() [4/9]

ASPOSECPP_SHARED_API void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< IO::Stream stream,
System::SharedPtr< Object o,
System::SharedPtr< XmlSerializerNamespaces namespaces 
)

Serializes document into XML.

Parameters
streamDestination stream.
oObject to serialize.
namespacesNamespace storage.

◆ Serialize() [5/9]

ASPOSECPP_SHARED_API void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< IO::TextWriter textWriter,
System::SharedPtr< Object o,
System::SharedPtr< XmlSerializerNamespaces namespaces 
)

Serializes document into XML.

Parameters
textWriterDestination stream.
oObject to serialize.
namespacesNamespace storage.

◆ Serialize() [6/9]

ASPOSECPP_SHARED_API void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< XmlWriter xmlWriter,
System::SharedPtr< Object o,
System::SharedPtr< XmlSerializerNamespaces namespaces 
)

Serializes document into XML.

Parameters
xmlWriterDestination stream.
oObject to serialize.
namespacesNamespace storage.

◆ Serialize() [7/9]

ASPOSECPP_SHARED_API void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< XmlWriter xmlWriter,
System::SharedPtr< Object o,
System::SharedPtr< XmlSerializerNamespaces namespaces,
String  encodingStyle 
)

Serializes document into XML.

Parameters
xmlWriterDestination stream.
oObject to serialize.
namespacesNamespace storage.
encodingStyleStyle to use while serializing object.

◆ Serialize() [8/9]

ASPOSECPP_SHARED_API void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< XmlWriter xmlWriter,
System::SharedPtr< Object o,
System::SharedPtr< XmlSerializerNamespaces namespaces,
String  encodingStyle,
String  id 
)

Serializes document into XML.

Parameters
xmlWriterDestination stream.
oObject to serialize.
namespacesNamespace storage.
encodingStyleStyle to use while serializing object.
idObject id to use while serializing it.

◆ Serialize() [9/9]

virtual ASPOSECPP_SHARED_API void System::Xml::Serialization::XmlSerializer::Serialize ( System::SharedPtr< Object o,
System::SharedPtr< XmlSerializationWriter writer 
)
protectedvirtual

Serializes object.

Member Data Documentation

◆ EncodingNamespace

ASPOSECPP_SHARED_API const String System::Xml::Serialization::XmlSerializer::EncodingNamespace
static

Encoding namespace name.

◆ WsdlNamespace

ASPOSECPP_SHARED_API const String System::Xml::Serialization::XmlSerializer::WsdlNamespace
static

WSDL namespace name.

◆ WsdlTypesNamespace

ASPOSECPP_SHARED_API const String System::Xml::Serialization::XmlSerializer::WsdlTypesNamespace
static

WSDL types namespace name.