class Bio::References

DESCRIPTION

This class is OBSOLETED, and will soon be removed. Instead of this class, an array is to be used.

A container class for Bio::Reference objects.

USAGE

This class should NOT be used.

refs = Bio::References.new
refs.append(Bio::Reference.new(hash))
refs.each do |reference|
  ...
end

Attributes

references[RW]

Array of Bio::Reference objects

Public Class Methods

new(ary = []) click to toggle source

This method should not be used. Only for backward compatibility of existing code.

Since Bio::References is obsoleted, ::new not returns Bio::References object, but modifies given ary and returns the ary.

Arguments:

Returns

the given array

# File lib/bio/compat/references.rb, line 77
def self.new(ary = [])
  warn 'Bio::References is obsoleted. Some methods are added to given array to keep backward compatibility.'
  ary.extend(BackwardCompatibility)
  ary
end
new(ary = []) click to toggle source

Normally, users can not call this method.

Create a new Bio::References object

refs = Bio::References.new

Arguments:

Returns

Bio::References object

# File lib/bio/compat/references.rb, line 95
def initialize(ary = [])
  @references = ary
end

Public Instance Methods

append(reference) click to toggle source

Add a Bio::Reference object to the container.

refs.append(reference)

Arguments:

Returns

current Bio::References object

# File lib/bio/compat/references.rb, line 107
def append(reference)
  @references.push(reference) if reference.is_a? Reference
  return self
end
each() { |reference| ... } click to toggle source

Iterate through Bio::Reference objects.

refs.each do |reference|
  ...
end

Block

yields each Bio::Reference object

# File lib/bio/compat/references.rb, line 119
def each
  @references.each do |reference|
    yield reference
  end
end