zerowaste
API
Generated with
zerowaste/com.github.ghik.zerowaste/ZerowastePlugin

ZerowastePlugin

com.github.ghik.zerowaste.ZerowastePlugin
class ZerowastePlugin extends StandardPlugin

Attributes

Graph
Supertypes
trait StandardPlugin
trait Plugin
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def description: String

A one-line description of the plugin

A one-line description of the plugin

Attributes

def init(options: List[String]): List[PluginPhase]

Non-research plugins should override this method to return the phases

Non-research plugins should override this method to return the phases

Value parameters

options:

commandline options to the plugin, -P:plugname:opt1,opt2 becomes List(opt1, opt2)

Attributes

Returns

a list of phases to be added to the phase plan

def name: String

The name of this plugin

The name of this plugin

Attributes

Inherited methods

def isResearch: Boolean

Is this plugin a research plugin?

Is this plugin a research plugin?

Research plugin receives a phase plan and return a new phase plan, while non-research plugin returns a list of phases to be inserted.

Attributes

Inherited from:
Plugin

Inherited fields

val optionsHelp: Option[String]

A description of this plugin's options, suitable as a response to the -help command-line option. Conventionally, the options should be listed with the -P:plugname: part included.

A description of this plugin's options, suitable as a response to the -help command-line option. Conventionally, the options should be listed with the -P:plugname: part included.

Attributes

Inherited from:
Plugin
Generated with