Class LocalizableStringCollection

Namespace

NanoByte.Common.Collections

Assembly

NanoByte.Common.dll

A collection of LocalizableStrings with language-search methods.

[Serializable]
public class LocalizableStringCollection : List<LocalizableString>, ICloneable<LocalizableStringCollection>

Inheritance

object

List<LocalizableString>

LocalizableStringCollection

Implements

ICloneable<LocalizableStringCollection>

Extension Methods

BinaryStorage.SaveBinary<T>(T, Stream)

BinaryStorage.SaveBinary<T>(T, string)

JsonStorage.SaveJson<T>(T, Stream)

JsonStorage.SaveJson<T>(T, string)

JsonStorage.ToJsonString<T>(T)

XmlStorage.SaveXml<T>(T, string, string?)

UpdateUtils.To<TIn, TOut>(TIn, Func<TIn, TOut>)

ConversionUtils.ConvertToString<TType>(TType)

CollectionExtensions.AddIfNew<T>(ICollection<T>, T)

CollectionExtensions.Add<TCollection, TElements>(ICollection<TCollection>, IEnumerable<TElements>)

CollectionExtensions.RemoveAll<T>(ICollection<T>, Func<T, bool>)

CollectionExtensions.Remove<TCollection, TElements>(ICollection<TCollection>, IEnumerable<TElements>)

DictionaryExtensions.ToMultiDictionary<TSource, TKey, TValue>(IEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TValue>)

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

EnumerableExtensions.ContainsAny<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.ContainsOrEmpty<T>(IEnumerable<T>, T)

EnumerableExtensions.DistinctBy<T, TKey>(IEnumerable<T>, Func<T, TKey>)

EnumerableExtensions.Except<T>(IEnumerable<T>, T)

EnumerableExtensions.Except<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.GetSequencedHashCode<T>(IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.GetUnsequencedHashCode<T>(IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.MaxBy<T, TValue>(IEnumerable<T>, Func<T, TValue>, IComparer<TValue>?)

EnumerableExtensions.MinBy<T, TValue>(IEnumerable<T>, Func<T, TValue>, IComparer<TValue>?)

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

EnumerableExtensions.SequencedEquals<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.TopologicalSort<T>(IEnumerable<T>, Func<T, IEnumerable<T>>)

EnumerableExtensions.TrySelect<TSource, TResult, TException>(IEnumerable<TSource>, Func<TSource, TResult>, Action<TException>)

EnumerableExtensions.UnsequencedEquals<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.WhereNotNull<T>(IEnumerable<T?>)

Bucketizer.Bucketize<T>(IEnumerable<T>)

Bucketizer.Bucketize<TElement, TValue>(IEnumerable<TElement>, Func<TElement, TValue>)

ExceptionUtils.TryAnyAsync<T>(IEnumerable<T>, Func<T, Task>)

ExceptionUtils.TryAny<T>(IEnumerable<T>, Action<T>)

ListExtensions.AddRange<TList, TElements>(IList<TList>, IEnumerable<TElements>)

ListExtensions.GetAddedElements<T>(IList<T>?, IList<T>?, IComparer<T>)

ListExtensions.AddOrReplace<T>(List<T>, T)

ListExtensions.AddOrReplace<T, TKey>(List<T>, T, Func<T, TKey>)

ListExtensions.RemoveLast<T>(List<T>, int)

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

XmlStorage.SaveXml(object, Stream, string?)

XmlStorage.ToXmlString(object, string?)

Methods

Add(string)

Adds a new en string to the collection.

public void Add(string value)

Parameters

value string

The actual string value to store.

Add(string, string?)

Adds a new string with an associated language to the collection.

public void Add(string language, string? value)

Parameters

language string

The language of the value.

value string

The actual string value to store.

Clone()

Creates a deep copy of this LocalizableStringCollection (elements are cloned).

public LocalizableStringCollection Clone()

Returns

LocalizableStringCollection

The cloned LocalizableStringCollection.

ContainsExactLanguage(CultureInfo)

Checks if the collection contains an entry exactly matching the specified language.

public bool ContainsExactLanguage(CultureInfo language)

Parameters

language CultureInfo

The exact language to look for.

Returns

bool

true if an element with the specified language exists in the collection; false otherwise.

See Also

GetExactLanguage(CultureInfo)

GetBestLanguage(CultureInfo)

Returns the best-fitting string in the collection for the specified language.

public string? GetBestLanguage(CultureInfo language)

Parameters

language CultureInfo

The language to look for.

Returns

string

The best-fitting string value found in the collection; null if the collection is empty.

Remarks

Language preferences in decreasing order:

1. exact match
   
2. same language with neutral culture
   
3. en
   
4. en-US
   
5. first entry in collection

GetExactLanguage(CultureInfo)

Returns the first string in the collection exactly matching the specified language.

public string? GetExactLanguage(CultureInfo language)

Parameters

language CultureInfo

The exact language to look for.

Returns

string

The string value found in the collection; null if none was found.

See Also

ContainsExactLanguage(CultureInfo)

Set(CultureInfo, string?)

Adds a new string with an associated language to the collection. Preexisting entries with the same language are removed.

public void Set(CultureInfo language, string? value)

Parameters

language CultureInfo

The language of the value.

value string

The actual string value to store; null to remove existing entries.