Interface ConfigOrigin
ConfigValue
for use in error messages. Obtain the origin of a value
with ConfigValue.origin()
. Exceptions may have an origin, see
ConfigException.origin
, but be careful because
ConfigException.origin()
may return null.
It's best to use this interface only for debugging; its accuracy is "best effort" rather than guaranteed, and a potentially-noticeable amount of memory could probably be saved if origins were not kept around, so in the future there might be some option to discard origins.
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.
-
Method Summary
Modifier and TypeMethodDescriptioncomments()
Returns any comments that appeared to "go with" this place in the file.Returns a string describing the origin of a value or exception.filename()
Returns a filename describing the origin.int
Returns a line number where the value or exception originated.resource()
Returns a classpath resource name describing the origin.url()
Returns a URL describing the origin.withComments
(List<String> comments) Returns aConfigOrigin
based on this one, but with the given comments.withLineNumber
(int lineNumber) Returns aConfigOrigin
based on this one, but with the given line number.
-
Method Details
-
description
String description()Returns a string describing the origin of a value or exception. This will never return null.- Returns:
- string describing the origin
-
filename
String filename()Returns a filename describing the origin. This will return null if the origin was not a file.- Returns:
- filename of the origin or null
-
url
URL url()Returns a URL describing the origin. This will return null if the origin has no meaningful URL.- Returns:
- url of the origin or null
-
resource
String resource()Returns a classpath resource name describing the origin. This will return null if the origin was not a classpath resource.- Returns:
- resource name of the origin or null
-
lineNumber
int lineNumber()Returns a line number where the value or exception originated. This will return -1 if there's no meaningful line number.- Returns:
- line number or -1 if none is available
-
comments
Returns any comments that appeared to "go with" this place in the file. Often an empty list, but never null. The details of this are subject to change, but at the moment comments that are immediately before an array element or object field, with no blank line after the comment, "go with" that element or field.- Returns:
- any comments that seemed to "go with" this origin, empty list if none
-
withComments
Returns aConfigOrigin
based on this one, but with the given comments. Does not modify this instance or anyConfigValue
s with this origin (since they are immutable). To set the returned origin to aConfigValue
, useConfigValue.withOrigin(com.typesafe.config.ConfigOrigin)
.Note that when the given comments are equal to the comments on this object, a new instance may not be created and
this
is returned directly.- Parameters:
comments
- the comments used on the returned origin- Returns:
- the ConfigOrigin with the given comments
- Since:
- 1.3.0
-
withLineNumber
Returns aConfigOrigin
based on this one, but with the given line number. This origin must be a FILE, URL or RESOURCE. Does not modify this instance or anyConfigValue
s with this origin (since they are immutable). To set the returned origin to aConfigValue
, useConfigValue.withOrigin(com.typesafe.config.ConfigOrigin)
.Note that when the given lineNumber are equal to the lineNumber on this object, a new instance may not be created and
this
is returned directly.- Parameters:
lineNumber
- the new line number- Returns:
- the created ConfigOrigin
- Since:
- 1.3.0
-