Class VersionMetadataCollection

Namespace: CmlLib.Core.VersionMetadata
Assembly: CmlLib.Core.dll

public class VersionMetadataCollection : IEnumerable<IVersionMetadata>, IEnumerable

Inheritance

object ← VersionMetadataCollection

Implements

IEnumerable<IVersionMetadata>, IEnumerable

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

VersionMetadataCollection()

public VersionMetadataCollection()

VersionMetadataCollection(IEnumerable<IVersionMetadata>, string?, string?)

public VersionMetadataCollection(IEnumerable<IVersionMetadata> versions, string? latestRelease, string? latestSnapshot)

Parameters

versions IEnumerable<IVersionMetadata>

latestRelease string?

latestSnapshot string?

Fields

Versions

protected OrderedDictionary Versions

Field Value

OrderedDictionary

Properties

LatestReleaseName

public string? LatestReleaseName { get; }

Property Value

string?

LatestSnapshotName

public string? LatestSnapshotName { get; }

Property Value

string?

MaxDepth

public int MaxDepth { get; set; }

Property Value

int

this[int]

public IVersionMetadata this[int index] { get; }

Property Value

IVersionMetadata

Methods

AddVersion(IVersionMetadata)

public void AddVersion(IVersionMetadata version)

Parameters

version IVersionMetadata

Contains(string?)

public bool Contains(string? versionName)

Parameters

versionName string?

Returns

bool

GetAndSaveVersionAsync(string, MinecraftPath, CancellationToken)

public Task<IVersion> GetAndSaveVersionAsync(string name, MinecraftPath path, CancellationToken cancellationToken = default)

Parameters

name string

path MinecraftPath

cancellationToken CancellationToken

Returns

Task<IVersion>

GetAndSaveVersionAsync(IVersionMetadata, MinecraftPath, CancellationToken)

public Task<IVersion> GetAndSaveVersionAsync(IVersionMetadata versionMetadata, MinecraftPath path, CancellationToken cancellationToken = default)

Parameters

versionMetadata IVersionMetadata

path MinecraftPath

cancellationToken CancellationToken

Returns

Task<IVersion>

GetEnumerator()

public IEnumerator<IVersionMetadata> GetEnumerator()

Returns

IEnumerator<IVersionMetadata>

GetVersionAsync(string, CancellationToken)

public Task<IVersion> GetVersionAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

cancellationToken CancellationToken

Returns

Task<IVersion>

GetVersionAsync(IVersionMetadata, CancellationToken)

public Task<IVersion> GetVersionAsync(IVersionMetadata versionMetadata, CancellationToken cancellationToken = default)

Parameters

versionMetadata IVersionMetadata

cancellationToken CancellationToken

Returns

Task<IVersion>

GetVersionMetadata(string)

public IVersionMetadata GetVersionMetadata(string name)

Parameters

name string

Returns

IVersionMetadata

Merge(VersionMetadataCollection)

public void Merge(VersionMetadataCollection from)

Parameters

from VersionMetadataCollection

ToArray(MVersionSortOption)

public IVersionMetadata[] ToArray(MVersionSortOption option)

Parameters

option MVersionSortOption

Returns

IVersionMetadata[]

TryGetVersionMetadata(string, out IVersionMetadata)

public bool TryGetVersionMetadata(string name, out IVersionMetadata version)

Parameters

name string

version IVersionMetadata

Returns

bool