BaseLocalOptimizer Class

Summary

The base class for local, tool based optimizers
graph BT Type-->Base0["BaseOptimizer"] click Base0 "/api/Cake.ImageOptimizer/BaseOptimizer" Base0-->Base1["Object"] Type["BaseLocalOptimizer"] class Type type-node Derived0["JpegTranOptimizer"]-->Type click Derived0 "/api/Cake.ImageOptimizer/JpegTranOptimizer" Derived1["GifsicleOptimizer"]-->Type click Derived1 "/api/Cake.ImageOptimizer/GifsicleOptimizer" Derived2["PngOutOptimizer"]-->Type click Derived2 "/api/Cake.ImageOptimizer/PngOutOptimizer"

Syntax

public abstract class BaseLocalOptimizer : BaseOptimizer

Constructors

Fields

Name Constant Value Summary
_Environment
Represents the environment Cake operates in.
Inherited from BaseOptimizer
_FileSystem
Represents a file system.
Inherited from BaseOptimizer
_Log
Represents a log.
Inherited from BaseOptimizer
_Runner
Represents a process runner.
_Tools
Responsible for finding the tool.

Properties

Name Value Summary
Extensions IList<string>
A list of extensions supported by the Optimizer
Inherited from BaseOptimizer
FileSize int
Gets the maximum file size to optimize.
Inherited from BaseOptimizer
Name string
Gets the name of the optimizer.
Inherited from BaseOptimizer
Timeout int
Gets the maximum timespan for the request.
Inherited from BaseOptimizer

Methods

Name Value Summary
Optimize(FilePath) ImageOptimizerResult
Optimizes the specified file.
RunTool(FilePath, FilePath) void
Runs the optimizer tool
Supports(string) bool
Does the specified file.
Inherited from BaseOptimizer

Extension Methods

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