Class List

A list of Values for serialization by an IConfigProvider. Use List() or From(IEnumerable<Value>) to create.

Inheritance

System.Object

Value

List

Implements

System.Collections.Generic.IList<Value>

System.Collections.Generic.ICollection<Value>

System.Collections.Generic.IEnumerable<Value>

System.Collections.IEnumerable

Inherited Members

Value.Null()

Value.List()

Value.Map()

Value.From(String)

Value.Text(String)

Value.From(Int64)

Value.Integer(Int64)

Value.From(Decimal)

Value.Float(Decimal)

Value.From(Boolean)

Value.Bool(Boolean)

Value.From(IEnumerable<Value>)

Value.From(IDictionary<String, Value>)

Value.From(IEnumerable<KeyValuePair<String, Value>>)

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.Data

Assembly: IPA.Loader.dll

Syntax

public sealed class List : Value, IList<Value>, ICollection<Value>, IEnumerable<Value>, IEnumerable

Properties

Count

Gets the number of elements in the List.

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

See Also

System.Collections.Generic.ICollection<T>.Count

Item[Int32]

Gets the value at the given index in this List.

Declaration

public Value this[int index] { get; set; }

Parameters

Type	Name	Description
System.Int32	index	the index to retrieve the Value at

Property Value

Type	Description
Value	the Value at index

See Also

System.Collections.Generic.IList<T>.Item[System.Int32]

Methods

Add(Value)

Adds a Value to the end of this List.

Declaration

public void Add(Value item)

Parameters

Type	Name	Description
Value	item	the Value to add

See Also

System.Collections.Generic.ICollection<T>.Add(T)

AddRange(IEnumerable<Value>)

Adds a range of Values to the end of this List.

Declaration

public void AddRange(IEnumerable<Value> vals)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<Value>	vals	the range of Values to add

Clear()

Clears the List.

Declaration

public void Clear()

See Also

System.Collections.Generic.ICollection<T>.Clear()

Contains(Value)

Checks if the List contains a certian item.

Declaration

public bool Contains(Value item)

Parameters

Type	Name	Description
Value	item	the Value to check for

Returns

Type	Description
System.Boolean	true if the item was founc, otherwise false

See Also

System.Collections.Generic.ICollection<T>.Contains(T)

CopyTo(Value[], Int32)

Copies the Values in the List to the System.Array in array.

Declaration

public void CopyTo(Value[] array, int arrayIndex)

Parameters

Type	Name	Description
Value[]	array	the System.Array to copy to
System.Int32	arrayIndex	the starting index to copy to

See Also

System.Collections.Generic.ICollection<T>.CopyTo(T[], System.Int32)

GetEnumerator()

Gets an enumerator to enumerate the List.

Declaration

public IEnumerator<Value> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<Value>	an System.Collections.Generic.IEnumerator<T> for this List

See Also

System.Collections.Generic.IEnumerable<T>.GetEnumerator()

IndexOf(Value)

Gets the index that a given Value is in the List.

Declaration

public int IndexOf(Value item)

Parameters

Type	Name	Description
Value	item	the Value to search for

Returns

Type	Description
System.Int32	the index that the item was at, or -1.

See Also

System.Collections.Generic.IList<T>.IndexOf(T)

Insert(Int32, Value)

Inserts a Value at an index.

Declaration

public void Insert(int index, Value item)

Parameters

Type	Name	Description
System.Int32	index	the index to insert at
Value	item	the Value to insert

See Also

System.Collections.Generic.IList<T>.Insert(System.Int32, T)

Remove(Value)

Removes a Value from the List.

Declaration

public bool Remove(Value item)

Parameters

Type	Name	Description
Value	item	the Value to remove

Returns

Type	Description
System.Boolean	true if the item was removed, false otherwise

See Also

System.Collections.Generic.ICollection<T>.Remove(T)

RemoveAt(Int32)

Removes a Value at an index.

Declaration

public void RemoveAt(int index)

Parameters

Type	Name	Description
System.Int32	index	the index to remove a Value at

See Also

System.Collections.Generic.IList<T>.RemoveAt(System.Int32)

ToString()

Converts this Value into a human-readable format.

Declaration

public override string ToString()

Returns

Type	Description
System.String	a comma-seperated list of the result of ToString() wrapped in square brackets

Overrides

Value.ToString()

Explicit Interface Implementations

ICollection<Value>.IsReadOnly

Declaration

bool ICollection<Value>.IsReadOnly { get; }

Returns

Type	Description
System.Boolean

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator

Implements

System.Collections.Generic.IList<T>

System.Collections.Generic.ICollection<T>

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable

Extension Methods

EnumerableExtensions.NonNull<T>(IEnumerable<T>)

EnumerableExtensions.NonNull<T, U>(IEnumerable<T>, Func<T, U>)

EnumerableExtensions.NonNull<T, U>(IEnumerable<T>, Func<T, Nullable<U>>)

ReflectionUtil.SetField<T, U>(T, String, U)

ReflectionUtil.GetField<U, T>(T, String)

ReflectionUtil.SetProperty<T, U>(T, String, U)

ReflectionUtil.GetProperty<U, T>(T, String)

ReflectionUtil.InvokeMethod<U, T>(T, String, Object[])