C# Class SimpleFramework.Xml.Core.Variable

The Variable object is used to represent a variable for a method or field of a deserialized object. It has the value for the field or method as well as the details from the annotation. This is used by the Collector to populate an object once all the values for that object have been collected.

Inheritance: Label

Afficher le fichier Open project: ngallagher/simplexml

Méthodes publiques

Méthode	Description
GetConverter ( Context context ) : Converter
GetEmpty ( Context context ) : Object	This is used to provide a configured empty value used when the annotated value is null. This ensures that XML can be created with required details regardless of whether values are null or not. It also provides a means for sensible default values.
GetName ( Context context ) : String	This is used to acquire the name of the element or attribute that is used by the class schema. The name is determined by checking for an override within the annotation. If it contains a name then that is used, if however the annotation does not specify a name the the field or method name is used instead.
IsAttribute ( ) : bool	This method is used to determine if the label represents an attribute. This is used to style the name so that elements are styled as elements and attributes are styled as required.
IsCollection ( ) : bool	This is used to determine if the label is a collection. If the label represents a collection then any original assignment to the field or method can be written to without the need to create a new collection. This allows obscure collections to be used and also allows initial entries to be maintained.
IsData ( ) : bool
IsInline ( ) : bool	This is used to determine whether the label represents an inline XML entity. The `ElementList` annotation and the `Text` annotation represent inline items. This means that they contain no containing element and so can not specify overrides or special attributes.
IsRequired ( ) : bool	Determines whether the XML attribute or element is required. This ensures that if an XML element is missing from a document that deserialization can continue. Also, in the process of serialization, if a value is null it does not need to be written to the resulting XML document.
ToString ( ) : String	This is used to describe the annotation and method or field that this label represents. This is used to provide error messages that can be used to debug issues that occur when processing a method. This should provide enough information such that the problem can be isolated correctly.
Variable ( Label label, Object value ) : SimpleFramework.Xml.Strategy	Constructor for the `Variable` object. This is used to create an object that holds a deserialized value, as well as the details of the annotated method or field it is to be set to. This allows the value to be repeatedly deserialized.

Method Details

GetConverter() public méthode

public GetConverter ( Context context ) : Converter
context	Context	/// this is the context object for the serialization ///
Résultat	Converter

GetEmpty() public méthode

This is used to provide a configured empty value used when the annotated value is null. This ensures that XML can be created with required details regardless of whether values are null or not. It also provides a means for sensible default values.

public GetEmpty ( Context context ) : Object
context	Context	/// this is the context object for the serialization ///
Résultat	Object

GetName() public méthode

This is used to acquire the name of the element or attribute that is used by the class schema. The name is determined by checking for an override within the annotation. If it contains a name then that is used, if however the annotation does not specify a name the the field or method name is used instead.

public GetName ( Context context ) : String
context	Context	/// this is the context used to style the name ///
Résultat	String

IsAttribute() public méthode

This method is used to determine if the label represents an attribute. This is used to style the name so that elements are styled as elements and attributes are styled as required.

public IsAttribute ( ) : bool
Résultat	bool

IsCollection() public méthode

This is used to determine if the label is a collection. If the label represents a collection then any original assignment to the field or method can be written to without the need to create a new collection. This allows obscure collections to be used and also allows initial entries to be maintained.

public IsCollection ( ) : bool
Résultat	bool

IsData() public méthode

public IsData ( ) : bool
Résultat	bool

IsInline() public méthode

This is used to determine whether the label represents an inline XML entity. The ElementList annotation and the Text annotation represent inline items. This means that they contain no containing element and so can not specify overrides or special attributes.

public IsInline ( ) : bool
Résultat	bool

IsRequired() public méthode

Determines whether the XML attribute or element is required. This ensures that if an XML element is missing from a document that deserialization can continue. Also, in the process of serialization, if a value is null it does not need to be written to the resulting XML document.

public IsRequired ( ) : bool
Résultat	bool

ToString() public méthode

This is used to describe the annotation and method or field that this label represents. This is used to provide error messages that can be used to debug issues that occur when processing a method. This should provide enough information such that the problem can be isolated correctly.

public ToString ( ) : String
Résultat	String

Variable() public méthode

Constructor for the Variable object. This is used to create an object that holds a deserialized value, as well as the details of the annotated method or field it is to be set to. This allows the value to be repeatedly deserialized.

public Variable ( Label label, Object value ) : SimpleFramework.Xml.Strategy
label	Label	/// this is the label for the field or method used ///
value	Object	/// the deserialized object for the method or field ///
Résultat	SimpleFramework.Xml.Strategy