Class HttpErrorHandlerCollection

Namespace

Kampute.HttpClient

Assembly

Kampute.HttpClient.dll

Represents a specialized collection of IHttpErrorHandler instances.

public sealed class HttpErrorHandlerCollection : ICollection<IHttpErrorHandler>, IEnumerable<IHttpErrorHandler>, IEnumerable

Inheritance

object

HttpErrorHandlerCollection

Implements

ICollection<IHttpErrorHandler>

IEnumerable<IHttpErrorHandler>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This collection enables the management of IHttpErrorHandler instances for handling HTTP errors, with capabilities such as adding, removing, and querying error handlers based on HTTP status codes.

Properties

Count

Gets the number of IHttpErrorHandler instances contained in the collection.

public int Count { get; }

Property Value

int

The number of IHttpErrorHandler instances contained in the collection.

Methods

Add(IHttpErrorHandler)

Adds an IHttpErrorHandler to the collection.

public void Add(IHttpErrorHandler errorHandler)

Parameters

errorHandler IHttpErrorHandler

The IHttpErrorHandler to add.

Exceptions

ArgumentNullException

Thrown if errorHandler is null.

ArgumentException

Thrown if errorHandler is already present in the collection, as duplicates are not allowed.

Clear()

Removes all items from the collection.

public void Clear()

Contains(IHttpErrorHandler)

Determines whether the collection contains a specific IHttpErrorHandler.

public bool Contains(IHttpErrorHandler errorHandler)

Parameters

errorHandler IHttpErrorHandler

The IHttpErrorHandler to locate in the collection.

Returns

bool

true if errorHandler is found in the collection; otherwise, false.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<IHttpErrorHandler> GetEnumerator()

Returns

IEnumerator<IHttpErrorHandler>

A IEnumerator<T> for IHttpErrorHandler.

GetHandlersFor(HttpStatusCode)

Retrieves all IHttpErrorHandler instances in the collection that support handling a specific HTTP status code.

public IEnumerable<IHttpErrorHandler> GetHandlersFor(HttpStatusCode statusCode)

Parameters

statusCode HttpStatusCode

The HTTP status code to query.

Returns

IEnumerable<IHttpErrorHandler>

An enumerable of IHttpErrorHandler that can handle the specified status code.

Remove(IHttpErrorHandler)

Removes the first occurrence of a specific IHttpErrorHandler from the collection.

public bool Remove(IHttpErrorHandler errorHandler)

Parameters

errorHandler IHttpErrorHandler

The IHttpErrorHandler to remove from the collection.

Returns

bool

true if errorHandler was successfully removed from the collection; otherwise, false.