Class: CLIUtils::PrefAction

Inherits:

Object

• Object
• CLIUtils::PrefAction

Includes:

Messaging

Defined in:

lib/cliutils/prefs/pref_actions/pref_action.rb

Overview

The generic base class for a Pref Action.

Direct Known Subclasses

OpenUrlAction

Instance Attribute Summary

• #parameters ⇒ Hash

  Holds the parameters that apply to this Action.

Instance Method Summary

• #run ⇒ void

  Runs the Action.

Methods included from Messaging

#messenger

Instance Attribute Details

#parameters ⇒ Hash

Holds the parameters that apply to this Action.

Returns:

• (Hash)

# File 'lib/cliutils/prefs/pref_actions/pref_action.rb', line 10

def parameters
  @parameters
end

Instance Method Details

#run ⇒ void

This method returns an undefined value.

Runs the Action. Note that the method implemented here will throw an exception by default, meaning that the user’s subclass needs to implement it.

Parameters:

• parameters (Hash)

Raises:

• (StandardError) —

  if the subclass doesn’t implement this method.

# File 'lib/cliutils/prefs/pref_actions/pref_action.rb', line 21

def run
  fail "`run` method not implemented on caller: #{ self.class }"
end