Class CollectionConverter<T, TCollection>

A base class for all System.Collections.Generic.ICollection<T> type converters, providing most of the functionality.

Inheritance
System.Object
ValueConverter<TCollection>
CollectionConverter<T, TCollection>
CollectionConverter<T, TCollection, TConverter>
IListConverter<T>
ISetConverter<T>
ListConverter<T>
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: IPA.Config.Stores.Converters
Assembly: IPA.Loader.dll
Syntax
public class CollectionConverter<T, TCollection> : ValueConverter<TCollection>, IValueConverter where TCollection : ICollection<T>
Type Parameters
Name Description
T

the type of the items in the collection
TCollection

the instantiated type of collection

Constructors

| Improve this Doc View Source

CollectionConverter()

Creates a CollectionConverter<T, TCollection> using the default converter for the element type. Equivalent to calling CollectionConverter(ValueConverter<T>) with Default.

Declaration
public CollectionConverter()
See Also
| Improve this Doc View Source

CollectionConverter(ValueConverter<T>)

Creates a CollectionConverter<T, TCollection> using the specified underlying converter.

Declaration
public CollectionConverter(ValueConverter<T> underlying)
Parameters
Type Name Description
ValueConverter<T> underlying

the ValueConverter<T> to use to convert the values

Properties

| Improve this Doc View Source

BaseConverter

Gets the converter for the collection's value type.

Declaration
protected ValueConverter<T> BaseConverter { get; }
Property Value
Type Description
ValueConverter<T>

Methods

| Improve this Doc View Source

Create(Int32, Object)

Creates a collection of type TCollection using the size and parent.

Declaration
protected virtual TCollection Create(int size, object parent)
Parameters
Type Name Description
System.Int32 size

the initial size of the collecion
System.Object parent

the object that will own the new collection
Returns
Type Description
TCollection

a new instance of TCollection
See Also
FromValue(Value, System.Object)
| Improve this Doc View Source

FromValue(Value, Object)

Deserializes a List in value into a new TCollection owned by parent.

Declaration
public override TCollection FromValue(Value value, object parent)
Parameters
Type Name Description
Value value

the List to convert to a TCollection
System.Object parent

the object that will own the resulting TCollection
Returns
Type Description
TCollection

a new TCollection holding the deserialized content of value
Overrides
IPA.Config.Stores.ValueConverter<TCollection>.FromValue(IPA.Config.Data.Value, System.Object)
See Also
FromValue(Value, System.Object)
| Improve this Doc View Source

PopulateFromValue(TCollection, List, Object)

Populates the colleciton col with the deserialized values from list with the parent parent.

Declaration
protected void PopulateFromValue(TCollection col, List list, object parent)
Parameters
Type Name Description
TCollection col

the collection to populate
List list

the values to populate it with
System.Object parent

the object that will own the new objects
See Also
FromValue(Value, System.Object)
| Improve this Doc View Source

ToValue(TCollection, Object)

Serializes a TCollection into a List.

Declaration
public override Value ToValue(TCollection obj, object parent)
Parameters
Type Name Description
TCollection obj

the TCollection to serialize
System.Object parent

the object owning obj
Returns
Type Description
Value

the List that obj was serialized into
Overrides
IPA.Config.Stores.ValueConverter<TCollection>.ToValue(TCollection, System.Object)
See Also
ToValue(T, System.Object)

Implements

Extension Methods