C# Class SimpleFramework.Xml.Core.MethodContact

The MethodContact object is acts as a contact that can set and get data to and from an object using methods. This requires a get method and a set method that share the same class type for the return and parameter respectively.

Inheritance: Contact

显示文件 Open project: ngallagher/simplexml

Public Methods

Method	Description
Get ( Object source ) : Object	This is used to get the specified value on the provided object. The value returned from this method will be an instance of the contact class type. If the returned object is of a different type then the serialization process will fail.
IsReadOnly ( ) : bool	This is used to determine if the annotated contact is for a read only variable. A read only variable is a field that can be set from within the constructor such as a blank readonly variable. It can also be a method with no set counterpart.
MethodContact ( MethodPart get ) : System	Constructor for the `MethodContact` object. This is used to compose a point of contact that makes use of a get and set method on a class. The specified methods will be invoked during the serialization process to get and set values.
MethodContact ( MethodPart get, MethodPart set ) : System	Constructor for the `MethodContact` object. This is used to compose a point of contact that makes use of a get and set method on a class. The specified methods will be invoked during the serialization process to get and set values.
Set ( Object source, Object value ) : void
ToString ( ) : String	This is used to describe the contact as it exists within the owning class. It is used to provide error messages that can be used to debug issues that occur when processing a contact. The string provided contains both the set and get methods.

Private Methods

Method	Description
getAnnotation ( Class type ) : T

Method Details

Get() public method

This is used to get the specified value on the provided object. The value returned from this method will be an instance of the contact class type. If the returned object is of a different type then the serialization process will fail.

public Get ( Object source ) : Object
source	Object	/// this is the object to acquire the value from ///
return	Object

IsReadOnly() public method

This is used to determine if the annotated contact is for a read only variable. A read only variable is a field that can be set from within the constructor such as a blank readonly variable. It can also be a method with no set counterpart.

public IsReadOnly ( ) : bool
return	bool

MethodContact() public method

Constructor for the MethodContact object. This is used to compose a point of contact that makes use of a get and set method on a class. The specified methods will be invoked during the serialization process to get and set values.

public MethodContact ( MethodPart get ) : System
get	MethodPart	/// this forms the get method for the object ///
return	System

MethodContact() public method

public MethodContact ( MethodPart get, MethodPart set ) : System
get	MethodPart	/// this forms the get method for the object ///
set	MethodPart	/// this forms the get method for the object ///
return	System

Set() public method

public Set ( Object source, Object value ) : void
source	Object	/// this is the object to set the value on ///
value	Object	/// this is the value that is to be set on the object ///
return	void

ToString() public method

This is used to describe the contact as it exists within the owning class. It is used to provide error messages that can be used to debug issues that occur when processing a contact. The string provided contains both the set and get methods.

public ToString ( ) : String
return	String