Class: OpenfireAdmin::Plugin

Inherits:
Object
  • Object
show all
Defined in:
lib/openfire_admin/plugin.rb

Overview

plugin abstract class

Direct Known Subclasses

AvailablePlugin, InstalledPlugin

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, key) ⇒ Plugin

Returns a new instance of Plugin.



49
50
51
52
# File 'lib/openfire_admin/plugin.rb', line 49

def initialize(client, key)
  @client = client
  @key = key.downcase
end

Instance Attribute Details

#descriptionObject

Returns the value of attribute description.



47
48
49
# File 'lib/openfire_admin/plugin.rb', line 47

def description
  @description
end

#keyObject (readonly)

Returns the value of attribute key.



48
49
50
# File 'lib/openfire_admin/plugin.rb', line 48

def key
  @key
end

#nameObject

Returns the value of attribute name.



47
48
49
# File 'lib/openfire_admin/plugin.rb', line 47

def name
  @name
end

#versionObject

Returns the value of attribute version.



47
48
49
# File 'lib/openfire_admin/plugin.rb', line 47

def version
  @version
end

Instance Method Details

#eql?(obj) ⇒ Boolean

Returns:

  • (Boolean)


59
60
61
62
63
64
65
66
67
68
# File 'lib/openfire_admin/plugin.rb', line 59

def eql?(obj)
  case obj
  when Plugin
    self.key == obj.key
  when String
    self.key == obj.downcase
  else
    false
  end
end

#inspectObject



53
54
55
# File 'lib/openfire_admin/plugin.rb', line 53

def inspect
  to_s
end

#to_sObject



56
57
58
# File 'lib/openfire_admin/plugin.rb', line 56

def to_s
  "#<#{self.class} #{key} #{version} (#{name.inspect} #{description.inspect})>"
end