Module: Hocon::ConfigIncluderFile

Defined in:
lib/hocon/config_includer_file.rb

Overview

Implement this in addition to ConfigIncluder if you want to support inclusion of files with the include file(“filename”) syntax. If you do not implement this but do implement ConfigIncluder, attempts to load files will use the default includer.

Instance Method Summary collapse

Instance Method Details

#include_file(context, what) ⇒ Object

Parses another item to be included. The returned object typically would not have substitutions resolved. You can throw a ConfigException here to abort parsing, or return an empty object, but may not return null.

Parameters:

  • context —

    some info about the include context

  • what —

    the include statement’s argument

Returns:

  • a non-null ConfigObject

Raises:



24
25
26
 
# File 'lib/hocon/config_includer_file.rb', line 24

def include_file(context, what)
  raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigIncluderFile` must implement `include_file` (#{self.class})"
end