Class Recipe

Namespace

ZeroInstall.Model

Assembly

ZeroInstall.Model.dll

Retrieves an implementation by applying a list of IRecipeSteps, such as downloading and combining multiple archives.

[Serializable]
[Equatable]
public sealed class Recipe : RetrievalMethod, IEquatable<XmlUnknown>, IEquatable<FeedElement>, ICloneable<RetrievalMethod>, IEquatable<Recipe>

Inheritance

object

XmlUnknown

FeedElement

RetrievalMethod

Recipe

Implements

IEquatable<XmlUnknown>

IEquatable<FeedElement>

ICloneable<RetrievalMethod>

IEquatable<Recipe>

Inherited Members

FeedElement.IfZeroInstallVersion

XmlUnknown.UnknownAttributes

XmlUnknown.UnknownElements

XmlUnknown.ToShortXml()

XmlUnknown.Equals(XmlUnknown)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

ContainsUnknownSteps

Indicates whether this recipe contains steps of unknown type and therefore can not be processed.

[Browsable(false)]
[IgnoreEquality]
public bool ContainsUnknownSteps { get; }

Property Value

bool

Steps

An ordered list of IRecipeSteps to execute.

[OrderedEquality]
public List<IRecipeStep> Steps { get; }

Property Value

List<IRecipeStep>

Methods

Clone()

Creates a deep copy of this Recipe instance.

public override RetrievalMethod Clone()

Returns

RetrievalMethod

The new copy of the Recipe.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

Normalize(FeedUri?)

Converts legacy elements, sets default values, etc..

public override void Normalize(FeedUri? feedUri = null)

Parameters

feedUri FeedUri

The feed the data was originally loaded from.

Exceptions

UriFormatException

Href is relative and feedUri is a remote URI.

InvalidDataException

A required property is not set or invalid.

ToString()

Returns the recipe in the form "Recipe (X steps)". Not safe for parsing!

public override string ToString()

Returns

string

Operators

operator ==(Recipe?, Recipe?)

Indicates whether the object on the left is equal to the object on the right.

public static bool operator ==(Recipe? left, Recipe? right)

Parameters

left Recipe

The left object

right Recipe

The right object

Returns

bool

true if the objects are equal; otherwise, false.

operator !=(Recipe?, Recipe?)

Indicates whether the object on the left is not equal to the object on the right.

public static bool operator !=(Recipe? left, Recipe? right)

Parameters

left Recipe

The left object

right Recipe

The right object

Returns

bool

true if the objects are not equal; otherwise, false.