Class: MusicBrainz::Webservice::AbstractIncludes

Inherits:

Object

• Object
• MusicBrainz::Webservice::AbstractIncludes

Defined in:

lib/rbrainz/webservice/includes.rb

Overview

Base class for all include classes.

Includes are used to specify which detail information should be returned for an entity search. There is one include class for each entity type.

Direct Known Subclasses

ArtistIncludes, LabelIncludes, ReleaseGroupIncludes, ReleaseIncludes, TrackIncludes

Instance Method Summary

• #initialize(includes) ⇒ AbstractIncludes constructor

  A new instance of AbstractIncludes.

• #to_s ⇒ Object

  Returns the includes as a parameter that can be used in a MusicBrainz XML web service URI.

Constructor Details

#initialize(includes) ⇒ AbstractIncludes

Returns a new instance of AbstractIncludes.

# File 'lib/rbrainz/webservice/includes.rb', line 20

def initialize(includes)
  raise 'Tried to initialize abstract class.'
end

Instance Method Details

#to_s ⇒ Object

Returns the includes as a parameter that can be used in a MusicBrainz XML web service URI.

# File 'lib/rbrainz/webservice/includes.rb', line 26

def to_s
  if @parameters.size > 0
    return 'inc=' + CGI.escape(@parameters.join(' '))
  else
    return ''
  end
end