module Hocon::ConfigParseable

An opaque handle to something that can be parsed, obtained from {@link ConfigIncludeContext}.

<p> Do not implement this interface; it should only be implemented by the config library. Arbitrary implementations will not work because the library internals assume a specific concrete implementation. Also, this interface is likely to grow new methods over time, so third-party implementations will break.

Public Instance Methods

options() click to toggle source

Get the initial options, which can be modified then passed to parse(). These options will have the right description, includer, and other parameters already set up. @return the initial options

# File lib/hocon/config_parseable.rb, line 47
def options
  raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigParseable` must implement `options` (#{self.class})"
end
origin() click to toggle source

Returns a {@link ConfigOrigin} describing the origin of the parseable item. @return the origin of the parseable item

# File lib/hocon/config_parseable.rb, line 37
def origin
  raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigParseable` must implement `origin` (#{self.class})"
end
parse(options) click to toggle source

Parse whatever it is. The options should come from {@link #options options()} but you could tweak them if you like.

@param options

parse options, should be based on the ones from
{@link ConfigParseable#options options()}

@return the parsed object

# File lib/hocon/config_parseable.rb, line 28
def parse(options)
  raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigParseable` must implement `parse` (#{self.class})"
end