1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
# encoding: utf-8
require_relative '../hocon'
require_relative '../hocon/config_error'
#
# An opaque handle to something that can be parsed, obtained from
# {@link ConfigIncludeContext}.
#
# <p>
# <em>Do not implement this interface</em>; 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.
#
module Hocon::ConfigParseable
#
# Parse whatever it is. The options should come from
# {@link ConfigParseable#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
#
def parse(options)
raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigParseable` must implement `parse` (#{self.class})"
end
#
# Returns a {@link ConfigOrigin} describing the origin of the parseable
# item.
# @return the origin of the parseable item
#
def origin
raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigParseable` must implement `origin` (#{self.class})"
end
#
# 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
#
def options
raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigParseable` must implement `options` (#{self.class})"
end
end
|
