Show / Hide Table of Contents

Class Recipe

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

Inheritance
Object
XmlUnknown
FeedElement
RetrievalMethod
Recipe
Implements
IEquatable<XmlUnknown>
IEquatable<FeedElement>
ICloneable<RetrievalMethod>
IEquatable<Recipe>
Inherited Members
FeedElement.FilterMismatch<T>(T)
FeedElement.FilterMismatch(IRecipeStep)
FeedElement.Equals(FeedElement)
FeedElement.IfZeroInstallVersion
FeedElement.IfZeroInstallVersionString
XmlUnknown.UnknownAttributes
XmlUnknown.UnknownElements
XmlUnknown.EnsureAttribute(Object, String)
XmlUnknown.EnsureAttributeSafeID(String, String)
XmlUnknown.ToShortXml()
XmlUnknown.Equals(XmlUnknown)
Namespace: ZeroInstall.Model
Assembly: ZeroInstall.Model.dll
Syntax
public sealed class Recipe : RetrievalMethod

Constructors

Recipe()

Declaration
public Recipe()

Properties

ContainsUnknownSteps

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

Declaration
public bool ContainsUnknownSteps { get; }
Property Value
Type Description
Boolean

Steps

An ordered list of IRecipeSteps to execute.

Declaration
public List<IRecipeStep> Steps { get; }
Property Value
Type Description
List<IRecipeStep>

StepsArray

Used for XML serialization.

Declaration
public object[] StepsArray { get; set; }
Property Value
Type Description
Object[]
See Also
Steps

Methods

Clone()

Creates a deep copy of this Recipe instance.

Declaration
public override RetrievalMethod Clone()
Returns
Type Description
RetrievalMethod

The new copy of the Recipe.

Overrides
RetrievalMethod.Clone()

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides
FeedElement.Equals(Object)

Equals(Recipe)

Declaration
public bool Equals(Recipe other)
Parameters
Type Name Description
Recipe other
Returns
Type Description
Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
FeedElement.GetHashCode()

Normalize(FeedUri)

Converts legacy elements, sets default values, etc..

Declaration
public override void Normalize(FeedUri feedUri = null)
Parameters
Type Name Description
FeedUri feedUri

The feed the data was originally loaded from.

Overrides
RetrievalMethod.Normalize(FeedUri)
Exceptions
Type Condition
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!

Declaration
public override string ToString()
Returns
Type Description
String

Operators

Equality(Recipe, Recipe)

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

Declaration
public static bool operator ==(Recipe left, Recipe right)
Parameters
Type Name Description
Recipe left

The left object

Recipe right

The right object

Returns
Type Description
Boolean

true if the objects are equal; otherwise, false.

Inequality(Recipe, Recipe)

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

Declaration
public static bool operator !=(Recipe left, Recipe right)
Parameters
Type Name Description
Recipe left

The left object

Recipe right

The right object

Returns
Type Description
Boolean

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

Implements

System.IEquatable<T>
System.IEquatable<T>
ICloneable<T>
System.IEquatable<T>

Extension Methods

RetrievalMethodExtensions.CalculateDigest(RetrievalMethod, ICommandExecutor, ITaskHandler, ManifestFormat)
In This Article
Back to top Copyright Bastian Eicher et al