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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
# encoding: utf-8
require_relative '../hocon'
require_relative '../hocon/config_mergeable'
#
# An immutable value, following the <a href="http://json.org">JSON</a> type
# schema.
#
# <p>
# Because this object is immutable, it is safe to use from multiple threads and
# there's no need for "defensive copies."
#
# <p>
# <em>Do not implement interface {@code ConfigValue}</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::ConfigValue
include Hocon::ConfigMergeable
#
# The origin of the value (file, line number, etc.), for debugging and
# error messages.
#
# @return where the value came from
#
def origin
raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigValue` must implement `origin` (#{self.class})"
end
#
# The {@link ConfigValueType} of the value; matches the JSON type schema.
#
# @return value's type
#
def value_type
raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigValue` must implement `value_type` (#{self.class})"
end
#
# Returns the value as a plain Java boxed value, that is, a {@code String},
# {@code Number}, {@code Boolean}, {@code Map<String,Object>},
# {@code List<Object>}, or {@code null}, matching the {@link #valueType()}
# of this {@code ConfigValue}. If the value is a {@link ConfigObject} or
# {@link ConfigList}, it is recursively unwrapped.
# @return a plain Java value corresponding to this ConfigValue
#
def unwrapped
raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigValue` must implement `unwrapped` (#{self.class})"
end
#
# Renders the config value to a string, using the provided options.
#
# <p>
# If the config value has not been resolved (see {@link Config#resolve}),
# it's possible that it can't be rendered as valid HOCON. In that case the
# rendering should still be useful for debugging but you might not be able
# to parse it. If the value has been resolved, it will always be parseable.
#
# <p>
# If the config value has been resolved and the options disable all
# HOCON-specific features (such as comments), the rendering will be valid
# JSON. If you enable HOCON-only features such as comments, the rendering
# will not be valid JSON.
#
# @param options
# the rendering options
# @return the rendered value
#
def render(options)
raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigValue` must implement `render` (#{self.class})"
end
def with_fallback(other)
raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigValue` must implement `with_fallback` (#{self.class})"
end
#
# Places the value inside a {@link Config} at the given path. See also
# {@link ConfigValue#atKey(String)}.
#
# @param path
# path to store this value at.
# @return a {@code Config} instance containing this value at the given
# path.
#
def at_path(path)
raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigValue` must implement `at_path` (#{self.class})"
end
#
# Places the value inside a {@link Config} at the given key. See also
# {@link ConfigValue#atPath(String)}.
#
# @param key
# key to store this value at.
# @return a {@code Config} instance containing this value at the given key.
#
def at_key(key)
raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigValue` must implement `at_key` (#{self.class})"
end
#
# Returns a {@code ConfigValue} based on this one, but with the given
# origin. This is useful when you are parsing a new format of file or setting
# comments for a single ConfigValue.
#
# @since 1.3.0
#
# @param origin the origin set on the returned value
# @return the new ConfigValue with the given origin
#
def with_origin(origin)
raise Hocon::ConfigError::ConfigBugOrBrokenError, "subclasses of `ConfigValue` must implement `with_origin` (#{self.class})"
end
end
|
