Contents

module CLIUtils
  # The generic base class for a Pref
  # action.
  class PrefAction
    include Messaging

    # Holds a reference to the pref that
    # is implementing this action.
    # @return [Pref]
    attr_accessor :pref

    # Runs the plugin. Note that the
    # method implemented here shows
    # an error (indicating that it
    # needs to be implemented in a
    # subclass).
    # @parameter [Hash] parameters
    # @return [void]
    def run(parameters = {})
      messenger.error("`run` method not implemented on caller: #{ self.class }")
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
cliutils-1.4.2	lib/cliutils/prefs/pref_actions/pref_action.rb
cliutils-1.4.1	lib/cliutils/prefs/pref_actions/pref_action.rb