ITaskGraphGenerator Interface

Summary

Interface for generating the file contents for graph files
graph BT Type["ITaskGraphGenerator"] class Type type-node Implementing0["MermaidHtmlGenerator"]-.->Type click Implementing0 "/api/Cake.Graph.Generators/MermaidHtmlGenerator" Implementing1["CytoscapeWyamGenerator"]-.->Type click Implementing1 "/api/Cake.Graph.Generators/CytoscapeWyamGenerator" Implementing2["CytoscapeHtmlGenerator"]-.->Type click Implementing2 "/api/Cake.Graph.Generators/CytoscapeHtmlGenerator" Implementing3["MermaidGraphGenerator"]-.->Type click Implementing3 "/api/Cake.Graph.Generators/MermaidGraphGenerator" Implementing4["CytoscapeGraphGenerator"]-.->Type click Implementing4 "/api/Cake.Graph.Generators/CytoscapeGraphGenerator"

Syntax

public interface ITaskGraphGenerator

Properties

Name Value Summary
Extension string
The file extension to use for this type of graph file

Methods

Name Value Summary
SerializeAsync(ICakeContext, ICakeTaskInfo, IReadOnlyList<ICakeTaskInfo>) Task<string>
Converts the task to a graph and outputs the string for displaying

Extension Methods

Name Value Summary
Dump<ITaskGraphGenerator>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ITaskGraphGenerator>(ITaskGraphGenerator[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ITaskGraphGenerator>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ITaskGraphGenerator>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ITaskGraphGenerator>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ITaskGraphGenerator>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin