extends System.ValueType
extends System.IComparable
| Variables: |
|---|
public System.Int32 Days |
public System.Int32 Hours |
public System.Int32 Milliseconds |
public System.Int32 Minutes |
public System.Int32 Seconds |
public System.Int64 Ticks |
public System.Double TotalDays |
public System.Double TotalHours |
public System.Double TotalMilliseconds |
public System.Double TotalMinutes |
public System.Double TotalSeconds |
| Constructors: |
|---|
public System.TimeSpan(System.Int64 ticks) Constructs and initializes a new System.TimeSpan with the specified number of ticks. Parameter ticks: A System.Int64 that specifies the number of ticks with which to initialize the new System.TimeSpan . |
public System.TimeSpan(System.Int32 hours, System.Int32 minutes, System.Int32 seconds) Constructs and initializes a new System.TimeSpan with the specified numbers of hours, minutes, and seconds. Parameter hours: A System.Int32 that specifies the number of hours with which to initialize the new System.TimeSpan. Parameter minutes: A System.Int32 that specifies the number of minutes with which to initialize the new System.TimeSpan. Parameter seconds: A System.Int32 that specifies the number of seconds with which to initialize the new System.TimeSpan. Throws: : The parameters specify a System.TimeSpan value less than System.TimeSpan.MinValue or greater than System.TimeSpan.MaxValue. The specified hours, minutes, and seconds are converted to ticks, and that value is used to initialize the new System.TimeSpan. |
public System.TimeSpan(System.Int32 days, System.Int32 hours, System.Int32 minutes, System.Int32 seconds, System.Int32 milliseconds) Constructs and initializes a new System.TimeSpan with the specified numbers of days, hours, minutes, seconds, and milliseconds. Parameter days: A System.Int32 that specifies the number of days with which to initialize the new System.TimeSpan. Parameter hours: A System.Int32 that specifies the number of hours with which to initialize the new System.TimeSpan. Parameter minutes: A System.Int32 that specifies the number of minutes with which to initialize the new System.TimeSpan. Parameter seconds: A System.Int32 that specifies the number of seconds with which to initialize the new System.TimeSpan. Parameter milliseconds: A System.Int32 that specifies the number of milliseconds with which to initialize the new System.TimeSpan. Throws: : The parameters specify a System.TimeSpan value less than System.TimeSpan.MinValue or greater than System.TimeSpan.MaxValue. The specified days, hours, minutes, seconds, and milliseconds are converted to ticks, and that value is used to initialize the new System.TimeSpan. |
public System.TimeSpan(System.Int32 days, System.Int32 hours, System.Int32 minutes, System.Int32 seconds) Constructs and initializes a new System.TimeSpan with the specified numbers of days, hours, minutes, and seconds. Parameter days: A System.Int32 that specifies the number of days with which to initialize the new System.TimeSpan. Parameter hours: A System.Int32 that specifies the number of hours with which to initialize the new System.TimeSpan. Parameter minutes: A System.Int32 that specifies the number of minutes with which to initialize the new System.TimeSpan. Parameter seconds: A System.Int32 that specifies the number of seconds with which to initialize the new System.TimeSpan. Throws: : The parameters specify a System.TimeSpan value less than System.TimeSpan.MinValue or greater than System.TimeSpan.MaxValue. The specified days, hours, minutes, and seconds are converted to ticks, and that value is used to initialize the new System.TimeSpan. |
| Functions: |
|---|
public System.TimeSpan Add(System.TimeSpan ts) Adds the specified System.TimeSpan to the current instance. Parameter ts: A System.TimeSpan instance to add to the current instance. Returns: A System.TimeSpan that represents the value of the current instance plus the value of ts. Throws: : The sum of the value of the current instance and the value of ts is less than System.TimeSpan.MinValue or greater than System.TimeSpan.MaxValue. Example: This example demonstrates the System.TimeSpan.Add(System.TimeSpan) method. using System;
public class TimeSpanAddExample {
public static void Main() {
TimeSpan ts = new TimeSpan(Int32.MaxValue);
Console.WriteLine("The value of the timespan 'ts' is {0}", ts);
Console.WriteLine("ts.Add(ts) = {0}", ts.Add(ts));
}
}
The output is The value of the timespan 'ts' is 00:03:34.7483647 ts.Add(ts) = 00:07:09.4967294 |
public static System.Int32 Compare(System.TimeSpan t1, System.TimeSpan t2) Returns the sort order of two System.TimeSpan structures. Parameter t1: The first System.TimeSpan to compare. Parameter t2: The second System.TimeSpan to compare. Returns: A System.Int32 containing a value that reflects the sort order of t1 as compared to t2. The following table defines the conditions under which the returned value is a negative number, zero, or a positive number. |
public System.Int32 CompareTo(System.Object value) Returns the sort order of the current instance compared to the specified System.Object. Parameter value: The System.Object to compare to the current instance. Returns: A System.Int32 containing a value that reflects the sort order of the current instance as compared to value. The following table defines the conditions under which the returned value is a negative number, zero, or a positive number. Throws: : value is not a System.TimeSpan and is not a null reference. This method is implemented to support the System.IComparable interface. |
public System.TimeSpan Duration() Returns a System.TimeSpan whose value is the absolute value of the current instance. Returns: A System.TimeSpan whose value is the absolute value of the current instance. Throws: : The value of the current instance is System.TimeSpan.MinValue. Example: The following example demonstrates the System.TimeSpan.Duration method. using System;
public class TimeSpanDurationExample {
public static void Main() {
TimeSpan ts = new TimeSpan(Int32.MinValue);
Console.Write("The absolute value of TimeSpan {0} ", ts);
Console.WriteLine("is {0}", ts.Duration());
}
}
The output is The absolute value of TimeSpan -00:03:34.7483648 is 00:03:34.7483648 |
public static System.Boolean Equals(System.TimeSpan t1, System.TimeSpan t2) Determines whether two System.TimeSpan structures represent the same type and value. Parameter t1: The first instance of System.TimeSpan to compare for equality. Parameter t2: The second instance of System.TimeSpan to compare for equality. Returns: true if t1 and t2 represent the same value; otherwise, false. |
public System.Boolean Equals(System.Object value) Determines whether the current instance and the specified System.Object represent the same type and value. Parameter value: The System.Object to compare to the current instance. Returns: true if value represents the same type and value as the current instance. If value is a null reference or is not a System.TimeSpan, returns false. This method overrides System.Object.Equals(System.Object). |
public static System.TimeSpan FromDays(System.Double value) Returns a System.TimeSpan that represents the specified number of days where the specification is accurate to the nearest millisecond. Parameter value: A System.Double that specifies the number of days with which the new System.TimeSpan is initialized. Returns: A System.TimeSpan that represents value. Throws: : The System.TimeSpan represented by value is greater than System.TimeSpan.MaxValue or less than System.TimeSpan.MinValue. Throws: : value is equal to System.Double.NaN. value will only be considered accurate to the nearest millisecond. If value is System.Double.PositiveInfinity, a System.TimeSpan with the value System.TimeSpan.MaxValue is returned. If value is System.Double.NegativeInfinity, a System.TimeSpan with the value System.TimeSpan.MinValue is returned. |
public static System.TimeSpan FromHours(System.Double value) Returns a System.TimeSpan that represents the specified number of hours where the specification is accurate to the nearest millisecond. Parameter value: A System.Double that specifies the number of hours with which the new System.TimeSpan is initialized. Returns: A System.TimeSpan that represents value. Throws: : The System.TimeSpan represented by value is greater than System.TimeSpan.MaxValue or less than System.TimeSpan.MinValue. Throws: : value is equal to System.Double.NaN. value will only be considered accurate to the nearest millisecond. If value is System.Double.PositiveInfinity, a System.TimeSpan with the value System.TimeSpan.MaxValue is returned. If value is System.Double.NegativeInfinity, a System.TimeSpan with the value System.TimeSpan.MinValue is returned. |
public static System.TimeSpan FromMilliseconds(System.Double value) Returns a System.TimeSpan that represents the specified number of milliseconds where the specification is accurate to the nearest millisecond. Parameter value: A System.Double that specifies the number of milliseconds with which the new System.TimeSpan is initialized. Returns: A System.TimeSpan that represents value. Throws: : The System.TimeSpan represented by value is greater than System.TimeSpan.MaxValue or less than System.TimeSpan.MinValue. Throws: : value is equal to System.Double.NaN. value will only be considered accurate to the nearest millisecond. If value is System.Double.PositiveInfinity, a System.TimeSpan with the value System.TimeSpan.MaxValue is returned. If value is System.Double.NegativeInfinity, a System.TimeSpan with the value System.TimeSpan.MinValue is returned. |
public static System.TimeSpan FromMinutes(System.Double value) Returns a System.TimeSpan that represents the specified number of minutes where the specification is accurate to the nearest millisecond. Parameter value: A System.Double that specifies the number of minutes with which the new System.TimeSpan is initialized. Returns: A System.TimeSpan that represents value. Throws: : The System.TimeSpan represented by value is greater than System.TimeSpan.MaxValue or less than System.TimeSpan.MinValue. Throws: : value is equal to System.Double.NaN. value will only be considered accurate to the nearest millisecond. If value is System.Double.PositiveInfinity, a System.TimeSpan with the value System.TimeSpan.MaxValue is returned. If value is System.Double.NegativeInfinity, a System.TimeSpan with the value System.TimeSpan.MinValue is returned. |
public static System.TimeSpan FromSeconds(System.Double value) Returns a System.TimeSpan that represents the specified number of seconds where the specification is accurate to the nearest millisecond. Parameter value: A System.Double that specifies the number of seconds with which the new System.TimeSpan is initialized. Returns: A System.TimeSpan that represents value. Throws: : The System.TimeSpan represented by value is greater than System.TimeSpan.MaxValue or less than System.TimeSpan.MinValue. Throws: : value is equal to System.Double.NaN. value will only be considered accurate to the nearest millisecond. If value is System.Double.PositiveInfinity, a System.TimeSpan with the value System.TimeSpan.MaxValue is returned. If value is System.Double.NegativeInfinity, a System.TimeSpan with the value System.TimeSpan.MinValue is returned. |
public static System.TimeSpan FromTicks(System.Int64 value) Returns a System.TimeSpan that represents the specified number of ticks. Parameter value: A System.Int64 that specifies the number of ticks with which the new System.TimeSpan is initialized. Returns: A System.TimeSpan with a value of value. This method is equivalent to the System.TimeSpan(System.Int64) constructor. |
public System.Int32 GetHashCode() Generates a hash code for the current instance. Returns: A System.Int32 value containing a hash code for the current instance. The algorithm used to generate the hash code is unspecified. This method overrides System.Object.GetHashCode. |
public System.TimeSpan Negate() Returns a System.TimeSpan with the same absolute value but opposite sign as the current instance. Returns: A System.TimeSpan with the same absolute value but with the opposite sign as the current instance. Throws: : The value of the current instance is System.TimeSpan.MinValue. |
public static System.TimeSpan op_Addition(System.TimeSpan t1, System.TimeSpan t2) Adds the values of two System.TimeSpan instances. Parameter t1: The first System.TimeSpan. Parameter t2: The second System.TimeSpan. Returns: A System.TimeSpan whose value is the sum of the values of t1 and t2. Throws: : The sum of t1 and t2 is less than System.TimeSpan.MinValue or greater than System.TimeSpan.MaxValue. |
public static System.Boolean op_Equality(System.TimeSpan t1, System.TimeSpan t2) Determines whether the value of one System.TimeSpan is equal to the value of another System.TimeSpan. Parameter t1: The first System.TimeSpan Parameter t2: The second System.TimeSpan Returns: true if the values of t1 and t2 are equal; otherwise, false. |
public static System.Boolean op_GreaterThan(System.TimeSpan t1, System.TimeSpan t2) Determines whether the value one System.TimeSpan is greater than the value of another System.TimeSpan. Parameter t1: The first System.TimeSpan. Parameter t2: The second System.TimeSpan. Returns: true if the value of t1 is greater than the value of t2; otherwise, false. |
public static System.Boolean op_GreaterThanOrEqual(System.TimeSpan t1, System.TimeSpan t2) Determines whether the value of one System.TimeSpan is greater than or equal to the value of another System.TimeSpan. Parameter t1: The first System.TimeSpan. Parameter t2: The second System.TimeSpan. Returns: true if the value of t1 is greater than or equal to the value of t2; otherwise, false. |
public static System.Boolean op_Inequality(System.TimeSpan t1, System.TimeSpan t2) Determines whether the value of one System.TimeSpan is unequal to the value of another System.TimeSpan. Parameter t1: The first System.TimeSpan. Parameter t2: The second System.TimeSpan. Returns: true if the values of t1 and t2 are unequal; otherwise, false. |
public static System.Boolean op_LessThan(System.TimeSpan t1, System.TimeSpan t2) Determines whether the value of one System.TimeSpan is less than the value of another System.TimeSpan. Parameter t1: The first System.TimeSpan. Parameter t2: The second System.TimeSpan. Returns: true if the value of t1 is less than the value of t2; otherwise, false. |
public static System.Boolean op_LessThanOrEqual(System.TimeSpan t1, System.TimeSpan t2) Determines whether the value of one System.TimeSpan is less than or equal to the value of another System.TimeSpan. Parameter t1: The first System.TimeSpan. Parameter t2: The second System.TimeSpan. Returns: true if the value of t1 is less than or equal to the value of t2; otherwise, false. |
public static System.TimeSpan op_Subtraction(System.TimeSpan t1, System.TimeSpan t2) Subtracts the value of one System.TimeSpan from the value of another System.TimeSpan. Parameter t1: The first System.TimeSpan. Parameter t2: The second System.TimeSpan. Returns: A System.TimeSpan whose value is the result of the value of t1 minus the value of t2. Throws: : The value of t2 subtracted from t1 is less than System.TimeSpan.MinValue or greater than System.TimeSpan.MaxValue. |
public static System.TimeSpan op_UnaryNegation(System.TimeSpan t) Returns a System.TimeSpan whose value is the negated value of a specified System.TimeSpan. Parameter t: A System.TimeSpan whose value will be negated. Returns: A System.TimeSpan with the same absolute value but the opposite sign as t. Throws: : t equals System.TimeSpan.MinValue. |
public static System.TimeSpan op_UnaryPlus(System.TimeSpan t) Returns the specified instance of System.TimeSpan. Parameter t: A System.TimeSpan. Returns: System.TimeSpan t. This method returns System.TimeSpan t. |
public static System.TimeSpan Parse(System.String s) Returns the specified System.String converted to a System.TimeSpan value. Parameter s: A System.String containing the value to convert. s contains a time interval in the following form: [ws][-][d.]hh:mm:ss[.ff][ws] Items in square brackets ('[' and']') are optional. Colons and periods (':' and'.') are literal characters. For details on the remaining symbols, see the description section. Returns: The System.TimeSpan value obtained from s. Throws: : s is a null reference. Throws: : s is in an invalid format. Throws: : s represents a number greater than System.TimeSpan.MaxValue or less than System.TimeSpan.MinValue. -or- At least one of the hours, minutes, or seconds components is outside its valid range. The symbols used in the parameter description for s are as follows: Example: This example demonstrates parsing a string to obtain a System.TimeSpan. using System;
public class TimeSpanParseExample {
public static void Main() {
String str = " -5.12:34:56.789 ";
TimeSpan ts = TimeSpan.Parse(str);
Console.WriteLine(@"The string ""{0}""", str);
Console.WriteLine("parses to TimeSpan {0}", ts);
}
}
The output is
The string " -5.12:34:56.789 "
parses to TimeSpan -5.12:34:56.7890000
|
public System.TimeSpan Subtract(System.TimeSpan ts) Subtracts the value of the specified System.TimeSpan from the value of the current instance. Parameter ts: A System.TimeSpan whose value to subtract from the value of the current instance. Returns: A System.TimeSpan whose value is equal to the value of the current instance minus the value of ts. Throws: : The difference between the value of the current instance and ts is less than System.TimeSpan.MinValue or greater than System.TimeSpan.MaxValue. |
public System.String ToString() Returns a System.String representation of the value of the current instance. Returns: A System.String representation of the current instance formatted as follows: [-][d.]hh:mm:ss[.ff] Items in square brackets ('[' and ']') are included provisionally: '-' is included if and only if the current instance is negative; "d." and ".ff" are included if and only if those components are non-zero. Colons and periods (':' and '.') are literal characters. Other components are as follows. This method overrides System.Object.ToString. Example: This example demonstrates the System.TimeSpan.ToString method. using System;
public class TimeSpanToStringExample {
public static void Main() {
TimeSpan tsOne = new TimeSpan(1, 23, 45, 54, 321);
TimeSpan tsTwo = new TimeSpan(0, 23, 45, 54, 0);
Console.Write("TimeSpan one, with d. and .ff: ");
Console.WriteLine("{0}", tsOne.ToString());
Console.Write("TimeSpan two, without d. and .ff: ");
Console.WriteLine("{0}", tsTwo.ToString());
}
}
The output is TimeSpan one, with d. and .ff: 1.23:45:54.3210000 TimeSpan two, without d. and .ff: 23:45:54 |
| Functions inherited from System.ValueType: |
|---|
public System.Boolean Equals(System.Object obj) Determines whether the current instance and a specified System.Object represent the same value. Parameter obj: The System.Object to compare the current instance to. Returns: true if obj and the current instance are of the same type and represent the same value; otherwise, false. This method overrides System.Object.Equals(System.Object) . |
public System.Int32 GetHashCode() Generates a hash code for the current instance. Returns: A System.Int32 containing the hash code for the current instance. The algorithm used to generate the hash code is unspecified. This method overrides System.Object.GetHashCode . |
public System.String ToString() Returns a System.String representation of the fully-qualified name of the type of the current instance. Returns: A System.String representation of the fully-qualified name of the type of the current instance. This method overrides System.Object.ToString. This method returns the System.Type.FullName property. |
| Functions inherited from System.Object: |
|---|
public virtual System.Boolean Equals(System.Object obj) Determines whether the specified System.Object is equal to the current instance. Parameter obj: The System.Object to compare with the current instance. Returns: true if obj is equal to the current instance; otherwise, false. The statements listed below are required to be true for all implementations of the System.Object.Equals(System.Object) method. In the list, x, y, and z represent non-null object references. See System.Object.GetHashCode for additional required behaviors pertaining to the System.Object.Equals(System.Object) method. Implementations of System.Object.Equals(System.Object) should not throw exceptions. The System.Object.Equals(System.Object) method tests for referential equality , which means that System.Object.Equals(System.Object) returns true if the specified instance of Object and the current instance are the same instance; otherwise, it returns false . An implementation of the System.Object.Equals(System.Object) method is shown in the following C# code: public virtual bool Equals(Object obj) { return this == obj; } For some kinds of objects, it is desirable to have System.Object.Equals(System.Object) test for value equality instead of referential equality. Such implementations of Equals return true if the two objects have the same "value", even if they are not the same instance. The definition of what constitutes an object's "value" is up to the implementer of the type, but it is typically some or all of the data stored in the instance variables of the object. For example, the value of a System.String is based on the characters of the string; the Equals method of the System.String class returns true for any two string instances that contain exactly the same characters in the same order. When the Equals method of a base class provides value equality, an override of Equals in a class derived from that base class should invoke the inherited implementation of Equals . It is recommended (but not required) that types overriding System.Object.Equals(System.Object) also override System.Object.GetHashCode. Hashtables cannot be relied on to work correctly if this recommendation is not followed. If your programming language supports operator overloading, and if you choose to overload the equality operator for a given type, that type should override the Equals method. Such implementations of the Equals method should return the same results as the equality operator. Following this guideline will help ensure that class library code using Equals (such as System.Collections.ArrayList and System.Collections.Hashtable ) behaves in a manner that is consistent with the way the equality operator is used by application code. If you are implementing a value type, you should follow these guidelines: For reference types, the guidelines are as follows: If you implement System.IComparable on a given type, you should override Equals on that type. The System.Object.Equals(System.Object) method is called by methods in collections classes that perform search operations, including the System.Array.IndexOf(System.Array,System.Object) method and the System.Collections.ArrayList.Contains(System.Object) method. Example: Example 1: The following example contains two calls to the default implementation of System.Object.Equals(System.Object) . using System;
class MyClass {
static void Main() {
Object obj1 = new Object();
Object obj2 = new Object();
Console.WriteLine(obj1.Equals(obj2));
obj1 = obj2;
Console.WriteLine(obj1.Equals(obj2));
}
}
The output is False True Example 2: The following example shows a Point class that overrides the System.Object.Equals(System.Object) method to provide value equality and a class Point3D, which is derived from Point . Because Point's override of System.Object.Equals(System.Object) is the first in the inheritance chain to introduce value equality, the Equals method of the base class (which is inherited from System.Object and checks for referential equality) is not invoked. However, Point3D.Equals invokes Point.Equals because Point implements Equals in a manner that provides value equality. using System;
public class Point: object {
int x, y;
public override bool Equals(Object obj) {
//Check for null and compare run-time types.
if (obj == null || GetType() != obj.GetType()) return false;
Point p = (Point)obj;
return (x == p.x) && (y == p.y);
}
public override int GetHashCode() {
return x ^ y;
}
}
class Point3D: Point {
int z;
public override bool Equals(Object obj) {
return base.Equals(obj) && z == ((Point3D)obj).z;
}
public override int GetHashCode() {
return base.GetHashCode() ^ z;
}
}
The Point.Equals method checks that the obj
argument is non-null and that it references an instance of the same type as this
object. If either of those checks fail, the method returns false. The
System.Object.Equals(System.Object) method uses
System.Object.GetType to determine whether
the run-time types of the two objects are identical. (Note that
typeof is not used here because it returns the static type.) If
instead the method had used a check of the form
In Point3D.Equals , the inherited Equals method is invoked before anything else is done; the inherited Equals method checks to see that obj is non-null, that obj is an instance of the same class as this object, and that the inherited instance variables match. Only when the inherited Equals returns true does the method compare the instance variables introduced in the subclass. Specifically, the cast to Point3D is not executed unless obj has been determined to be of type Point3D or a subclass of Point3D . Example 3: In the previous example, operator == (the equality operator) is used to compare the individual instance variables. In some cases, it is appropriate to use the System.Object.Equals(System.Object) method to compare instance variables in an Equals implementation, as shown in the following example: using System;
class Rectangle {
Point a, b;
public override bool Equals(Object obj) {
if (obj == null || GetType() != obj.GetType()) return false;
Rectangle r = (Rectangle)obj;
//Use Equals to compare instance variables
return a.Equals(r.a) && b.Equals(r.b);
}
public override int GetHashCode() {
return a.GetHashCode() ^ b.GetHashCode();
}
}
Example 4: In some languages, such as C#, operator overloading is supported. When a type overloads operator ==, it should also override the System.Object.Equals(System.Object) method to provide the same functionality. This is typically accomplished by writing the Equals method in terms of the overloaded operator ==. For example: using System;
public struct Complex {
double re, im;
public override bool Equals(Object obj) {
return obj is Complex && this == (Complex)obj;
}
public override int GetHashCode() {
return re.GetHashCode() ^ im.GetHashCode();
}
public static bool operator ==(Complex x, Complex y) {
return x.re == y.re && x.im == y.im;
}
public static bool operator !=(Complex x, Complex y) {
return !(x == y);
}
}
Because Complex is a C# struct (a value type), it is known that there will be no subclasses of Complex . Therefore, the System.Object.Equals(System.Object) method need not compare the GetType() results for each object, but can instead use the is operator to check the type of the obj parameter. |
public static System.Boolean Equals(System.Object objA, System.Object objB) Determines whether two object references are equal. Parameter objA: First object to compare. Parameter objB: Second object to compare. Returns: true if one or more of the following statements is true: otherwise returns false. This static method checks for null references before it calls objA.Equals(objB ) and returns false if either objA or objB is null. If the Equals(object obj) implementation throws an exception, this method throws an exception. Example: The following example demonstrates the System.Object.Equals(System.Object) method. using System;
public class MyClass {
public static void Main() {
string s1 = "Tom";
string s2 = "Carol";
Console.WriteLine("Object.Equals(\"{0}\", \"{1}\") => {2}",
s1, s2, Object.Equals(s1, s2));
s1 = "Tom";
s2 = "Tom";
Console.WriteLine("Object.Equals(\"{0}\", \"{1}\") => {2}",
s1, s2, Object.Equals(s1, s2));
s1 = null;
s2 = "Tom";
Console.WriteLine("Object.Equals(null, \"{1}\") => {2}",
s1, s2, Object.Equals(s1, s2));
s1 = "Carol";
s2 = null;
Console.WriteLine("Object.Equals(\"{0}\", null) => {2}",
s1, s2, Object.Equals(s1, s2));
s1 = null;
s2 = null;
Console.WriteLine("Object.Equals(null, null) => {2}",
s1, s2, Object.Equals(s1, s2));
}
}
The output is Object.Equals("Tom", "Carol") => False Object.Equals("Tom", "Tom") => True Object.Equals(null, "Tom") => False Object.Equals("Carol", null) => False Object.Equals(null, null) => True |
public System.Void Finalize() Allows a System.Object to perform cleanup operations before the memory allocated for the System.Object is automatically reclaimed. During execution, System.Object.Finalize is automatically called after an object becomes inaccessible, unless the object has been exempted from finalization by a call to System.GC.SuppressFinalize(System.Object). During shutdown of an application domain, System.Object.Finalize is automatically called on objects that are not exempt from finalization, even those that are still accessible. System.Object.Finalize is automatically called only once on a given instance, unless the object is re-registered using a mechanism such as System.GC.ReRegisterForFinalize(System.Object) and System.GC.SuppressFinalize(System.Object) has not been subsequently called. Conforming implementations of the CLI are required to make every effort to ensure that for every object that has not been exempted from finalization, the System.Object.Finalize method is called after the object becomes inaccessible. However, there may be some circumstances under which Finalize is not called. Conforming CLI implementations are required to explicitly specify the conditions under which Finalize is not guaranteed to be called. For example, Finalize might not be guaranteed to be called in the event of equipment failure, power failure, or other catastrophic system failures. In addition to System.GC.ReRegisterForFinalize(System.Object) and System.GC.SuppressFinalize(System.Object), conforming implementations of the CLI are allowed to provide other mechanisms that affect the behavior of System.Object.Finalize . Any mechanisms provided are required to be specified by the CLI implementation. The order in which the Finalize methods of two objects are run is unspecified, even if one object refers to the other. The thread on which Finalize is run is unspecified. Every implementation of System.Object.Finalize in a derived type is required to call its base type's implementation of Finalize . This is the only case in which application code calls System.Object.Finalize . The System.Object.Finalize implementation does nothing. A type should implement Finalize when it uses unmanaged resources such as file handles or database connections that must be released when the managed object that uses them is reclaimed. Because Finalize methods may be invoked in any order (including from multiple threads), synchronization may be necessary if the Finalize method may interact with other objects, whether accessible or not. Furthermore, since the order in which Finalize is called is unspecified, implementers of Finalize (or of destructors implemented through overriding Finalize) must take care to correctly handle references to other objects, as their Finalize method may already have been invoked. In general, referenced objects should not be considered valid during finalization. See the System.IDisposable interface for an alternate means of disposing of resources. For C# developers: Destructors are the C# mechanism for performing cleanup operations. Destructors provide appropriate safeguards, such as automatically calling the base type's destructor. In C# code, System.Object.Finalize cannot be called or overridden. |
public virtual System.Int32 GetHashCode() Generates a hash code for the current instance. Returns: A System.Int32 containing the hash code for the current instance. System.Object.GetHashCode serves as a hash function for a specific type. A hash function is used to quickly generate a number (a hash code) corresponding to the value of an object. Hash functions are used with hashtables. A good hash function algorithm rarely generates hash codes that collide. For more information about hash functions, see The Art of Computer Programming , Vol. 3, by Donald E. Knuth. All implementations of System.Object.GetHashCode are required to ensure that for any two object references x and y, if x.Equals(y) == true, then x.GetHashCode() == y.GetHashCode(). Hash codes generated by System.Object.GetHashCode need not be unique. Implementations of System.Object.GetHashCode are not permitted to throw exceptions. The System.Object.GetHashCode implementation attempts to produce a unique hash code for every object, but the hash codes generated by this method are not guaranteed to be unique. Therefore, System.Object.GetHashCode may generate the same hash code for two different instances. It is recommended (but not required) that types overriding System.Object.GetHashCode also override System.Object.Equals(System.Object) . Hashtables cannot be relied on to work correctly if this recommendation is not followed. Use this method to obtain the hash code of an object. Hash codes should not be persisted (i.e. in a database or file) as they are allowed to change from run to run. Example: Example 1 In some cases, System.Object.GetHashCode is implemented to simply return an integer value. The following example illustrates an implementation of System.Int32.GetHashCode , which returns an integer value: using System;
public struct Int32 {
int value;
//other methods...
public override int GetHashCode() {
return value;
}
}
Example 2 Frequently, a type has multiple data members that can participate in generating the hash code. One way to generate a hash code is to combine these fields using an xor (exclusive or) operation, as shown in the following example: using System;
public struct Point {
int x;
int y;
//other methods
public override int GetHashCode() {
return x ^ y;
}
}
Example 3 The following example illustrates another case where the type's fields are combined using xor (exclusive or) to generate the hash code. Notice that in this example, the fields represent user-defined types, each of which implements System.Object.GetHashCode (and should implement System.Object.Equals(System.Object) as well): using System;
public class SomeType {
public override int GetHashCode() {
return 0;
}
}
public class AnotherType {
public override int GetHashCode() {
return 1;
}
}
public class LastType {
public override int GetHashCode() {
return 2;
}
}
public class MyClass {
SomeType a = new SomeType();
AnotherType b = new AnotherType();
LastType c = new LastType();
public override int GetHashCode () {
return a.GetHashCode() ^ b.GetHashCode() ^ c.GetHashCode();
}
}
Avoid implementing System.Object.GetHashCode in a manner that results in circular references. In other words, if AClass.GetHashCode calls BClass.GetHashCode, it should not be the case that BClass.GetHashCode calls AClass.GetHashCode. Example 4 In some cases, the data member of the class in which you are implementing System.Object.GetHashCode is bigger than a System.Int32. In such cases, you could combine the high order bits of the value with the low order bits using an XOR operation, as shown in the following example: using System;
public struct Int64 {
long value;
//other methods...
public override int GetHashCode() {
return ((int)value ^ (int)(value >> 32));
}
}
|
public System.Type GetType() Gets the type of the current instance. Returns: The instance of System.Type that represents the run-time type (the exact type) of the current instance. For two objects x and y that have identical run-time types, System.Object.ReferenceEquals(System.Object,System.Object)(x.GetType(),y.GetType()) returns true . Example: The following example demonstrates the fact that System.Object.GetType returns the run-time type of the current instance: using System;
public class MyBaseClass: Object {
}
public class MyDerivedClass: MyBaseClass {
}
public class Test {
public static void Main() {
MyBaseClass myBase = new MyBaseClass();
MyDerivedClass myDerived = new MyDerivedClass();
object o = myDerived;
MyBaseClass b = myDerived;
Console.WriteLine("mybase: Type is {0}", myBase.GetType());
Console.WriteLine("myDerived: Type is {0}", myDerived.GetType());
Console.WriteLine("object o = myDerived: Type is {0}", o.GetType());
Console.WriteLine("MyBaseClass b = myDerived: Type is {0}", b.GetType());
}
}
The output is mybase: Type is MyBaseClass myDerived: Type is MyDerivedClass object o = myDerived: Type is MyDerivedClass MyBaseClass b = myDerived: Type is MyDerivedClass |
protected System.Object MemberwiseClone() Creates a shallow copy of the current instance. Returns: A shallow copy of the current instance. The run-time type (the exact type) of the returned object is the same as the run-time type of the object that was copied. System.Object.MemberwiseClone creates a new instance of the same type as the current instance and then copies each of the object's non-static fields in a manner that depends on whether the field is a value type or a reference type. If the field is a value type, a bit-by-bit copy of all the field's bits is performed. If the field is a reference type, only the reference is copied. The algorithm for performing a shallow copy is as follows (in pseudo-code): for each instance field f in this instance if (f is a value type) bitwise copy the field if (f is a reference type) copy the reference end for loop This mechanism is referred to as a shallow copy because it copies rather than clones the non-static fields. Because System.Object.MemberwiseClone implements the above algorithm, for any object, a, the following statements are required to be true: System.Object.MemberwiseClone does not call any of the type's constructors. If System.Object.Equals(System.Object) has been overridden, a.MemberwiseClone().Equals(a) might return false . For an alternate copying mechanism, see System.ICloneable . System.Object.MemberwiseClone is protected (rather than public) to ensure that from verifiable code it is only possible to clone objects of the same class as the one performing the operation (or one of its subclasses). Although cloning an object does not directly open security holes, it does allow an object to be created without running any of its constructors. Since these constructors may establish important invariants, objects created by cloning may not have these invariants established, and this may lead to incorrect program behavior. For example, a constructor might add the new object to a linked list of all objects of this class, and cloning the object would not add the new object to that list -- thus operations that relied on the list to locate all instances would fail to notice the cloned object. By making the method protected, only objects of the same class (or a subclass) can produce a clone and implementers of those classes are (presumably) aware of the appropriate invariants and can arrange for them to be true without necessarily calling a constructor. Example: The following example shows a class called MyClass as well as a representation of the instance of MyClass returned by System.Object.MemberwiseClone . using System;
class MyBaseClass {
public static string CompanyName = "My Company";
public int age;
public string name;
}
class MyDerivedClass: MyBaseClass {
static void Main() {
//Create an instance of MyDerivedClass
//and assign values to its fields.
MyDerivedClass m1 = new MyDerivedClass();
m1.age = 42;
m1.name = "Sam";
//Do a shallow copy of m1
//and assign it to m2.
MyDerivedClass m2 = (MyDerivedClass) m1.MemberwiseClone();
}
}
A graphical representation of m1 and m2 might look like this
+---------------+
| 42 | m1
+---------------+
| +---------|-----------------> "Sam"
+---------------+ /|\
|
+---------------+ |
| 42 | | m2
+---------------+ |
| +--------|---------------------|
+---------------+
|
public static System.Boolean ReferenceEquals(System.Object objA, System.Object objB) Determines whether two object references are identical. Parameter objA: First object to compare. Parameter objB: Second object to compare. Returns: True if a and b refer to the same object or are both null references; otherwise, false. This static method provides a way to compare two objects for reference equality. It does not call any user-defined code, including overrides of System.Object.Equals(System.Object) . Example: using System;
class MyClass {
static void Main() {
object o = null;
object p = null;
object q = new Object();
Console.WriteLine(Object.ReferenceEquals(o, p));
p = q;
Console.WriteLine(Object.ReferenceEquals(p, q));
Console.WriteLine(Object.ReferenceEquals(o, p));
}
}
The output is True True False |
public virtual System.String ToString() Creates and returns a System.String representation of the current instance. Returns: A System.String representation of the current instance. System.Object.ToString returns a string whose content is intended to be understood by humans. Where the object contains culture-sensitive data, the string representation returned by System.Object.ToString takes into account the current system culture. For example, for an instance of the System.Double class whose value is zero, the implementation of System.Double.ToString might return "0.00" or "0,00" depending on the current UI culture. Although there are no exact requirements for the format of the returned string, it should as much as possible reflect the value of the object as perceived by the user. System.Object.ToString is equivalent to calling System.Object.GetType to obtain the System.Type object for the current instance and then returning the result of calling the System.Object.ToString implementation for that type. The value returned includes the full name of the type. It is recommended, but not required, that System.Object.ToString be overridden in a derived class to return values that are meaningful for that type. For example, the base data types, such as System.Int32, implement System.Object.ToString so that it returns the string form of the value the object represents. Subclasses that require more control over the formatting of strings than System.Object.ToString provides should implement System.IFormattable, whose System.Object.ToString method uses the culture of the current thread. Example: The following example outputs the textual description of the value of an object of type System.Object to the console. using System;
class MyClass {
static void Main() {
object o = new object();
Console.WriteLine (o.ToString());
}
}
The output is System.Object |
| Functions inherited from System.IComparable: |
|---|
public System.Int32 CompareTo(System.Object obj) Returns the sort order of the current instance compared to the specified object. Parameter obj: The System.Object to compare to the current instance. Returns: A System.Int32 containing a value that reflects the sort order of the current instance as compared to object. The following table defines the conditions under which the returned value is a negative number, zero, or a positive number. For any objects A, B and C, the following are required to be true: A.CompareTo(A) is required to return zero. If A.CompareTo(B) returns zero then B.CompareTo(A) is required to return zero. If A.CompareTo(B) returns zero and B.CompareTo(C) returns zero then A.CompareTo(C) is required to return zero. If A.CompareTo(B) returns a value other than zero then B.CompareTo(A) is required to return a value of the opposite sign. If A.CompareTo(B) returns a value x not equal to zero, and B.CompareTo(C) returns a value y of the same sign as x, then A.CompareTo(C) is required to a value of the same sign as x and y . The exact behavior of this method is unspecified. The intent of this method is to provide a mechanism that orders instances of a class in a manner that is consistent with the mathematical definitions of the relational operators (<, >, and ==), without regard for class-specific definitions of the operators. Use the System.IComparable.CompareTo(System.Object) method to determine the ordering of instances of a class. |