Arrow::Config::Loader

Abstract base class (and Factory) for configuration loader delegates. Create specific instances with the Arrow::Config::Loader.create method.

Public Class Methods

derivativeDirs() click to toggle source

Returns a list of directories to search for deriviatives.

     # File /Users/ged/source/ruby/Arrow/lib/arrow/config.rb, line 597
597:         def self::derivativeDirs
598:             ["arrow/config-loaders"]
599:         end

Public Instance Methods

is_newer?( name, time ) click to toggle source

Returns true if the configuration values in the storage medium associated with the given name has changed since the given time.

     # File /Users/ged/source/ruby/Arrow/lib/arrow/config.rb, line 631
631:         def is_newer?( name, time )
632:             raise NotImplementedError,
633:                 "required method 'is_newer?' not implemented in '#{self.class.name}'"
634:         end

load( name ) click to toggle source

Load configuration values from the storage medium associated with the given name (e.g., filename, rowid, etc.) and return them in the form of a (possibly multi-dimensional) Hash.

     # File /Users/ged/source/ruby/Arrow/lib/arrow/config.rb, line 613
613:         def load( name )
614:             raise NotImplementedError,
615:                 "required method 'load' not implemented in '#{self.class.name}'"
616:         end

save( confighash, name ) click to toggle source

Save configuration values from the given confighash to the storage medium associated with the given name (e.g., filename, rowid, etc.) and return them.

     # File /Users/ged/source/ruby/Arrow/lib/arrow/config.rb, line 622
622:         def save( confighash, name )
623:             raise NotImplementedError,
624:                 "required method 'save' not implemented in '#{self.class.name}'"
625:         end

secsequence

--- SEC00034

seccomment

--- ""

method_list

--- 
- methods: 
  - visibility: public
    aref: M000287
    name: derivativeDirs
    sourcecode: "     <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/config.rb, line 597</span>\n\
      597:         <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-keyword kw\">self</span><span class=\"ruby-operator\">::</span><span class=\"ruby-identifier\">derivativeDirs</span>\n\
      598:             [<span class=\"ruby-value str\">&quot;arrow/config-loaders&quot;</span>]\n\
      599:         <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Returns a list of directories to search for deriviatives.
      </p>
    params: ()
  category: Class
  type: Public
- methods: 
  - visibility: public
    aref: M000290
    name: is_newer?
    sourcecode: "     <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/config.rb, line 631</span>\n\
      631:         <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">is_newer?</span>( <span class=\"ruby-identifier\">name</span>, <span class=\"ruby-identifier\">time</span> )\n\
      632:             <span class=\"ruby-identifier\">raise</span> <span class=\"ruby-constant\">NotImplementedError</span>,\n\
      633:                 <span class=\"ruby-node\">&quot;required method 'is_newer?' not implemented in '#{self.class.name}'&quot;</span>\n\
      634:         <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Returns <tt>true</tt> if the configuration values in the storage medium
      associated with the given <tt>name</tt> has changed since the given
      <tt>time</tt>.
      </p>
    params: ( name, time )
  - visibility: public
    aref: M000288
    name: load
    sourcecode: "     <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/config.rb, line 613</span>\n\
      613:         <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">load</span>( <span class=\"ruby-identifier\">name</span> )\n\
      614:             <span class=\"ruby-identifier\">raise</span> <span class=\"ruby-constant\">NotImplementedError</span>,\n\
      615:                 <span class=\"ruby-node\">&quot;required method 'load' not implemented in '#{self.class.name}'&quot;</span>\n\
      616:         <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Load configuration values from the storage medium associated with the given
      <tt>name</tt> (e.g., filename, rowid, etc.) and return them in the form of
      a (possibly multi-dimensional) Hash.
      </p>
    params: ( name )
  - visibility: public
    aref: M000289
    name: save
    sourcecode: "     <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/config.rb, line 622</span>\n\
      622:         <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">save</span>( <span class=\"ruby-identifier\">confighash</span>, <span class=\"ruby-identifier\">name</span> )\n\
      623:             <span class=\"ruby-identifier\">raise</span> <span class=\"ruby-constant\">NotImplementedError</span>,\n\
      624:                 <span class=\"ruby-node\">&quot;required method 'save' not implemented in '#{self.class.name}'&quot;</span>\n\
      625:         <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Save configuration values from the given <tt>confighash</tt> to the storage
      medium associated with the given <tt>name</tt> (e.g., filename, rowid,
      etc.) and return them.
      </p>
    params: ( confighash, name )
  category: Instance
  type: Public

sectitle

---

In Files

Parent

Methods

Included Modules