C# Class SimpleFramework.Xml.Core.Composite

Constructor for the Composite object. This creates a converter object capable of serializing and deserializing root objects labeled with XML annotations. The XML schema class must be given to the instance in order to perform deserialization.

This is used to determine whether the specified value has been overridden by the strategy. If the item has been overridden then no more serialization is require for that value, this is effectively telling the serialization process to stop writing.

This read method performs deserialization of the XML schema class type by traversing the contacts and instantiating them using details from the provided XML element. Because this will convert a non-primitive value it delegates to other converters to perform deserialization of lists and primitives.

If any of the required contacts are not present within the provided XML element this will terminate deserialization and throw an exception. The annotation missing is reported in the exception.

This read method performs deserialization of the XML schema class type by traversing the contacts and instantiating them using details from the provided XML element. Because this will convert a non-primitive value it delegates to other converters to perform deserialization of lists and primitives.

If any of the required contacts are not present within the provided XML element this will terminate deserialization and throw an exception. The annotation missing is reported in the exception.

This read method performs deserialization of the XML schema class type by traversing the contacts and instantiating them using details from the provided XML element. Because this will convert a non-primitive value it delegates to other converters to perform deserialization of lists and primitives.

If any of the required contacts are not present within the provided XML element this will terminate deserialization and throw an exception. The annotation missing is reported in the exception.

This read method is used to perform deserialization of the provided node object using a delegate converter. This is typically another Composite converter, or if the node is an attribute a Primitive converter. When the delegate converter has completed the deserialized value is assigned to the contact.

This read method performs deserialization of the XML schema class type by traversing the contacts and instantiating them using details from the provided XML element. Because this will convert a non-primitive value it delegates to other converters to perform deserialization of lists and primitives.

If any of the required contacts are not present within the provided XML element this will terminate deserialization and throw an exception. The annotation missing is reported in the exception.

This read method performs deserialization of the XML schema class type by traversing the contacts and instantiating them using details from the provided XML element. Because this will convert a non-primitive value it delegates to other converters to perform deserialization of lists and primitives.

If any of the required contacts are not present within the provided XML element this will terminate deserialization and throw an exception. The annotation missing is reported in the exception.

This readAttribute method is used for deserialization of the provided node object using a delegate converter. This is typically another Composite converter, or if the node is an attribute a Primitive converter. When the delegate converter has completed the deserialized value is assigned to the contact.

This readAttributes method reads the attributes from the provided XML element. This will iterate over all attributes within the element and convert those attributes as primitives to contact values within the source object.

Once all attributes within the XML element have been evaluated the Schema is checked to ensure that there are no required contacts annotated with the Attribute that remain. If any required attribute remains an exception is thrown.

This readConstructor method performs deserialization of the XML schema class type by traversing the contacts and creating them using details from the provided XML element. Because this will convert a non-primitive value it delegates to other converters to perform deserialization of lists and primitives.

This takes the approach of reading the XML elements and attributes before instantiating the object. Instantiation is performed using a declared constructor. The parameters for the constructor are taken from the deserialized objects.

This readDefault method performs deserialization of the XM schema class type by traversing the contacts and instantiating them using details from the provided XML element. Because this will convert a non-primitive value it delegates to other converters to perform deserialization of lists and primitives.

This takes the approach that the object is instantiated first and then the annotated fields and methods are deserialized from the XML elements and attributes. When all the details have be deserialized they are set on the internal contacts of the object.

This readElement method is used for deserialization of the provided node object using a delegate converter. This is typically another Composite converter, or if the node is an attribute a Primitive converter. When the delegate converter has completed the deserialized value is assigned to the contact.

This readElements method reads the elements from the provided XML element. This will iterate over all elements within the element and convert those elements to primitives or composite objects depending on the contact annotation.

Once all elements within the XML element have been evaluated the Schema is checked to ensure that there are no required contacts annotated with the Element that remain. If any required element remains an exception is thrown.

This readObject method is used to perform the deserialization of the XML in to any original value. If there is no original value then this will do a read and instantiate a new value to deserialize in to. Reading in to the original ensures that existing lists or maps can be read in to.

This readPrimitive method will extract the text value from the node and replace any template variables before converting it to a primitive value. This uses a Primitive object to convert the node text to the resulting string. This will also respect all references on the node so cycle can be followed.

The readResolve method is used to determine if there is a resolution method which can be used to substitute the object deserialized. The resolve method is used when an object wishes to provide a substitute within the deserialized object graph. This acts as an equivalent to the Java Object Serialization readResolve method for the object deserialization.

This readText method is used to read the text value from the XML element node specified. This will check the class schema to determine if a Text annotation was specified. If one was specified then the text within the XML element input node is used to populate the contact value.

This method is used to read the version from the provided input node. Once the version has been read it is used to determine how to deserialize the object. If the version is not the initial version then it is read in a manner that ignores excessive XML elements and attributes. Also none of the annotated fields or methods are required if the version is not the initial version.

This method is used to read the version from the provided input node. Once the version has been read it is used to determine how to deserialize the object. If the version is not the initial version then it is read in a manner that ignores excessive XML elements and attributes. Also none of the annotated fields or methods are required if the version is not the initial version.

This validate method performs validation of the XML schema class type by traversing the contacts and validating them using details from the provided XML element. Because this will validate a non-primitive value it delegates to other converters to perform validation of lists, maps, and primitives.

If any of the required contacts are not present within the given XML element this will terminate validation and throw an exception The annotation missing is reported in the exception.

This validate method performs validation of the XML schema class type by traversing the contacts and validating them using details from the provided XML element. Because this will validate a non-primitive value it delegates to other converters to perform validation of lists, maps, and primitives.

If any of the required contacts are not present within the given XML element this will terminate validation and throw an exception The annotation missing is reported in the exception.

This validate method is used to perform validation of the provided node object using a delegate converter. This is typically another Composite converter, or if the node is an attribute a Primitive converter. If this fails validation then an exception is thrown to report the issue.

This method checks to see if there are any Label objects remaining in the provided map that are required. This is used when validation is performed to ensure the the XML element validated contains sufficient details to satisfy the XML schema class annotations. If there is a required label that remains it is reported within the exception thrown.

This method checks to see if there are any Label objects remaining in the provided map that are required. This is used when deserialization is performed to ensure the the XML element deserialized contains sufficient details to satisfy the XML schema class annotations. If there is a required label that remains it is reported within the exception thrown.

This validateAttribute method performs a validation of the provided node object using a delegate converter. This is typically another Composite converter, or if the node is an attribute a Primitive converter. If this fails validation then an exception is thrown to report the issue.

This validateAttributes method validates the attributes from the provided XML element. This will iterate over all attributes within the element and validate those attributes as primitives to contact values within the source object.

Once all attributes within the XML element have been evaluated the Schema is checked to ensure that there are no required contacts annotated with the Attribute that remain. If any required attribute remains an exception is thrown.

This validateElement method performs a validation of the provided node object using a delegate converter. This is typically another Composite converter, or if the node is an attribute a Primitive converter. If this fails validation then an exception is thrown to report the issue.

This validateElements method validates the elements from the provided XML element. This will iterate over all elements within the element and validate those elements as primitives or composite objects depending on the contact annotation.

Once all elements within the XML element have been evaluated the Schema is checked to ensure that there are no required contacts annotated with the Element that remain. If any required element remains an exception is thrown.

This validateText method validates the text value from the XML element node specified. This will check the class schema to determine if a Text annotation was used. If one was specified then the text within the XML element input node is checked to determine if it is a valid entry.

This write method is used to perform serialization of the given source object. Serialization is performed by appending elements and attributes from the source object to the provided XML element object. How the objects contacts are serialized is determined by the XML schema class that the source object is an instance of. If a required contact is null an exception is thrown.

This write method is used to perform serialization of the given source object. Serialization is performed by appending elements and attributes from the source object to the provided XML element object. How the objects contacts are serialized is determined by the XML schema class that the source object is an instance of. If a required contact is null an exception is thrown.

This write method is used to set the value of the provided object as an attribute to the XML element. This will acquire the string value of the object using toString only if the object provided is not an enumerated type. If the object is an enumerated type then the Enum.name method is used.

This write method is used to write all the attribute contacts from the provided source object to the XML element. This visits all the contacts marked with the Attribute annotation in the source object. All annotated contacts are written as attributes to the XML element. This will throw an exception if a required contact within the source object is null.

This is used write the element specified using the specified converter. Writing the value using the specified converter will result in the node being populated with the elements, attributes, and text values to the provided node. If there is a problem writing the value using the converter an exception is thrown.

This write method is used to append the provided object as an element to the given XML element object. This will recursively write the contacts from the provided object as elements. This is done using the Converter acquired from the contact label. If the type of the contact value is not of the same type as the XML schema class a "class" attribute is appended.

If the element being written is inline, then this will not check to see if there is a "class" attribute specifying the name of the class. This is because inline elements do not have an outer class and thus could never have an override.

This write method is used to write all the element contacts from the provided source object to the XML element. This visits all the contacts marked with the Element annotation in the source object. All annotated contacts are written as children to the XML element. This will throw an exception if a required contact within the source object is null.

This is used to apply Decorator objects to the provided node before it is written. Application of decorations before the node is written allows namespaces and comments to be applied to the node. Decorations such as this do not affect the overall structure of the XML that is written.

The replace method is used to replace an object before it is serialized. This is used so that an object can give a substitute to be written to the XML document in the event that the actual object is not suitable or desired for serialization. This acts as an equivalent to the Java Object Serialization writeReplace method for the object serialization.

This write method is used to set the value of the provided object as the text for the XML element. This will acquire the string value of the object using toString only if the object provided is not an enumerated type. If the object is an enumerated type then the Enum.name method is used.

This write method is used to write the text contact from the provided source object to the XML element. This takes the text value from the source object and writes it to the single contact marked with the Text annotation. If the value is null and the contact value is required an exception is thrown.

This method is used to write the version attribute. A version is written only if it is not the initial version or if it required. The version is used to determine how to deserialize the XML. If the version is different from the expected version then it allows the object to be deserialized in a manner that does not require any attributes or elements, and unmatched nodes are ignored.