Click or drag to resize
ToStringBuilder Class
A class used to generate string representations of objects for debugging purposes in the ToString method.
Inheritance Hierarchy
SystemObject
  Capgemini.CommonObjectUtilsToStringBuilder

Namespace: Capgemini.CommonObjectUtils
Assembly: Capgemini.CommonObjectUtils (in Capgemini.CommonObjectUtils.dll) Version: 1.3.0.0
Syntax
Copy
public class ToStringBuilder

The ToStringBuilder type exposes the following members.

Constructors
  NameDescription
Public methodToStringBuilder
Initializes a new instance of the ToStringBuilder class.
Top
Methods
  NameDescription
Public methodAppendT
Append a field to the string representation.
Public methodAppendBase
Append a base class string representation.
Public methodAppendManyT
Append an enumerable field to the string representation.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Gets the built string representation.
(Overrides ObjectToString.)
Top
Remarks

Strings built by this class start with the subject object's (short) class name. If fields are appended, the class name will be followed by an square bracket delimited list of the fields. Each field will be represented by its name followed by an equals sign and then its value. The text "null" follows the equals sign if a field is null. A brace delimited list of values follows the equals sign if a field is a collection.

This class allows you to append fields to the string in a fluent style.

This is a partial port of the Apache commons ToStringBuilder class.

Examples
Copy
class Foo 
{
    private int field1 = "bar";
    private int[] field2 = new int[]{1, 2};

    ...

    public override string ToString()
    {
        return new ToStringBuilder(this)
            .Append("field1", field1)
            .AppendMany("field2", field2)
            .ToString();
    }
}
This would produce the following output:
Copy
Foo[field1=bar, field2={1, 2}]
See Also