Class StringBuilderPool

Namespace

CodeProject.ObjectPool.Specialized

Assembly

CodeProject.ObjectPool.dll

An IObjectPool<T> ready to be used. StringBuilder management can be further configured using the MinimumStringBuilderCapacity and MaximumStringBuilderCapacity properties.

public sealed class StringBuilderPool : ObjectPool<PooledStringBuilder>, IStringBuilderPool, IObjectPool<PooledStringBuilder>

Inheritance

object

ObjectPool<PooledStringBuilder>

StringBuilderPool

Implements

IStringBuilderPool

IObjectPool<PooledStringBuilder>

Inherited Members

ObjectPool<PooledStringBuilder>.AsyncFactoryMethod

ObjectPool<PooledStringBuilder>.Diagnostics

ObjectPool<PooledStringBuilder>.FactoryMethod

ObjectPool<PooledStringBuilder>.MaximumPoolSize

ObjectPool<PooledStringBuilder>.ObjectsInPoolCount

ObjectPool<PooledStringBuilder>.Clear()

ObjectPool<PooledStringBuilder>.GetObject()

ObjectPool<PooledStringBuilder>.GetObjectAsync(CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

StringBuilderPool()

Builds the specialized pool.

public StringBuilderPool()

Fields

DefaultMaximumStringBuilderCapacity

Default maximum string builder capacity. Shared by all IStringBuilderPool instances, defaults to 524288 characters.

public const int DefaultMaximumStringBuilderCapacity = 524288

Field Value

int

DefaultMinimumStringBuilderCapacity

Default minimum string builder capacity. Shared by all IStringBuilderPool instances, defaults to 4096 characters.

public const int DefaultMinimumStringBuilderCapacity = 4096

Field Value

int

Properties

Instance

Thread-safe pool instance.

public static IStringBuilderPool Instance { get; }

Property Value

IStringBuilderPool

MaximumStringBuilderCapacity

Maximum capacity a StringBuilder might have in order to be able to return to pool. Defaults to DefaultMaximumStringBuilderCapacity.

public int MaximumStringBuilderCapacity { get; set; }

Property Value

int

MinimumStringBuilderCapacity

Minimum capacity a StringBuilder should have when created and this is the minimum capacity of all builders stored in the pool. Defaults to DefaultMinimumStringBuilderCapacity.

public int MinimumStringBuilderCapacity { get; set; }

Property Value

int

Methods

GetObject(string)

Returns a pooled string builder using given string as initial value.

public PooledStringBuilder GetObject(string value)

Parameters

value string

The string used to initialize the value of the instance.

Returns

PooledStringBuilder

A pooled string builder.