From d5ba11fbb5cea694c1b9fb7321b947ddec11d9ce Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martynas=20Mickevi=C4=8Dius?=
* You can find an example app and library on
+ * href="https://github.com/lightbend/config/tree/master/examples">on
* GitHub. Also be sure to read the package overview which
* describes the big picture as shown in those examples.
@@ -56,7 +56,7 @@ import java.util.concurrent.TimeUnit;
* in a JSON object; it's just a string that's the key in a map. A "path" is a
* parseable expression with a syntax and it refers to a series of keys. Path
* expressions are described in the spec for
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">spec for
* Human-Optimized Config Object Notation. In brief, a path is
* period-separated so "a.b.c" looks for key c in object b in object a in the
* root object. Sometimes double quotes are needed around special characters in
@@ -110,7 +110,7 @@ import java.util.concurrent.TimeUnit;
*
* Substitutions are the You can find an example app and library on
+ * href="https://github.com/lightbend/config/tree/master/examples">on
* GitHub. Also be sure to read the package
* overview which describes the big picture as shown in those
@@ -570,7 +570,7 @@ public final class ConfigFactory {
/**
* Converts a Java {@link java.util.Properties} object to a
* {@link ConfigObject} using the rules documented in the HOCON
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">HOCON
* spec. The keys in the
* The semantics of merging are described in the spec
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">spec
* for HOCON. Merging typically occurs when either the same object is
* created twice in the same file, or two config files are both loaded. For
* example:
diff --git a/config/src/main/java/com/typesafe/config/ConfigResolveOptions.java b/config/src/main/java/com/typesafe/config/ConfigResolveOptions.java
index 96e0eca0..526da1ef 100644
--- a/config/src/main/java/com/typesafe/config/ConfigResolveOptions.java
+++ b/config/src/main/java/com/typesafe/config/ConfigResolveOptions.java
@@ -6,7 +6,7 @@ package com.typesafe.config;
/**
* A set of options related to resolving substitutions. Substitutions use the
*
* Typically this class would be used with the method
diff --git a/config/src/main/java/com/typesafe/config/ConfigSyntax.java b/config/src/main/java/com/typesafe/config/ConfigSyntax.java
index ed560296..749387d7 100644
--- a/config/src/main/java/com/typesafe/config/ConfigSyntax.java
+++ b/config/src/main/java/com/typesafe/config/ConfigSyntax.java
@@ -5,7 +5,7 @@ package com.typesafe.config;
/**
* The syntax of a character stream (JSON, HOCON
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">HOCON
* aka ".conf", or Java properties).
@@ -21,7 +21,7 @@ public enum ConfigSyntax {
JSON,
/**
* The JSON-superset HOCON format. Associated with the
-An API for loading and using configuration files, see the project site
+An API for loading and using configuration files, see the project site
for more information.
Typically you would load configuration with a static method from {@link com.typesafe.config.ConfigFactory} and then use
it with methods in the {@link com.typesafe.config.Config} interface. Configuration may be in the form of JSON files,
-Java properties, or HOCON files; you may also
+Java properties, or HOCON files; you may also
build your own configuration in code or from your own file formats.
${foo.bar}
syntax in config
* files, described in the specification. Resolving substitutions replaces these references with real
* values.
*
@@ -189,7 +189,7 @@ public interface Config extends ConfigMergeable {
/**
* Returns a replacement config with all substitutions (the
* ${foo.bar}
syntax, see the
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* spec) resolved. Substitutions are looked up using this
* Config
as the root object, that is, a substitution
* ${foo.bar}
will be replaced with the result of
@@ -670,7 +670,7 @@ public interface Config extends ConfigMergeable {
* the value is already a number, then it's left alone; if it's a string,
* it's parsed understanding unit suffixes such as "128K", as documented in
* the the
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* spec.
*
* @param path
@@ -690,7 +690,7 @@ public interface Config extends ConfigMergeable {
* the value is already a number, then it's left alone; if it's a string,
* it's parsed understanding unit suffixes such as "128K", as documented in
* the the
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* spec.
*
* @since 1.3.0
@@ -711,7 +711,7 @@ public interface Config extends ConfigMergeable {
* Get value as a duration in milliseconds. If the value is already a
* number, then it's left alone; if it's a string, it's parsed understanding
* units suffixes like "10m" or "5ns" as documented in the the
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* spec.
*
* @deprecated As of release 1.1, replaced by {@link #getDuration(String, TimeUnit)}
@@ -754,7 +754,7 @@ public interface Config extends ConfigMergeable {
* number, then it's taken as milliseconds and then converted to the
* requested TimeUnit; if it's a string, it's parsed understanding units
* suffixes like "10m" or "5ns" as documented in the the
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* spec.
*
* @since 1.2.0
@@ -778,7 +778,7 @@ public interface Config extends ConfigMergeable {
* already a number, then it's taken as milliseconds; if it's
* a string, it's parsed understanding units suffixes like
* "10m" or "5ns" as documented in the the
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* spec. This method never returns null.
*
* @since 1.3.0
@@ -800,7 +800,7 @@ public interface Config extends ConfigMergeable {
* already a number, then it's taken as days; if it's
* a string, it's parsed understanding units suffixes like
* "10d" or "5w" as documented in the the
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">the
* spec. This method never returns null.
*
* @since 1.3.0
diff --git a/config/src/main/java/com/typesafe/config/ConfigFactory.java b/config/src/main/java/com/typesafe/config/ConfigFactory.java
index 7938dc91..86d995e3 100644
--- a/config/src/main/java/com/typesafe/config/ConfigFactory.java
+++ b/config/src/main/java/com/typesafe/config/ConfigFactory.java
@@ -28,7 +28,7 @@ import java.util.concurrent.Callable;
* from a resource and nothing else.
*
* Properties
object are split on the
* period character '.' and treated as paths. The values will all end up as
* string values. If you have both "a=foo" and "a.b=bar" in your properties
diff --git a/config/src/main/java/com/typesafe/config/ConfigMergeable.java b/config/src/main/java/com/typesafe/config/ConfigMergeable.java
index 7af36f7b..58b2663e 100644
--- a/config/src/main/java/com/typesafe/config/ConfigMergeable.java
+++ b/config/src/main/java/com/typesafe/config/ConfigMergeable.java
@@ -27,7 +27,7 @@ public interface ConfigMergeable {
*
* ${foo.bar}
syntax and are documented in the HOCON
+ * href="https://github.com/lightbend/config/blob/master/HOCON.md">HOCON
* spec.
* .conf
file extension
* and application/hocon
Content-Type.
*/
diff --git a/config/src/main/java/com/typesafe/config/impl/ConfigParser.java b/config/src/main/java/com/typesafe/config/impl/ConfigParser.java
index b2ce0455..cce54163 100644
--- a/config/src/main/java/com/typesafe/config/impl/ConfigParser.java
+++ b/config/src/main/java/com/typesafe/config/impl/ConfigParser.java
@@ -192,7 +192,7 @@ final class ConfigParser {
// we really should make this work, but for now throwing an
// exception is better than producing an incorrect result.
- // See https://github.com/typesafehub/config/issues/160
+ // See https://github.com/lightbend/config/issues/160
if (arrayCount > 0 && obj.resolveStatus() != ResolveStatus.RESOLVED)
throw parseError("Due to current limitations of the config parser, when an include statement is nested inside a list value, "
+ "${} substitutions inside the included file cannot be resolved correctly. Either move the include outside of the list value or "
@@ -247,7 +247,7 @@ final class ConfigParser {
// we really should make this work, but for now throwing
// an exception is better than producing an incorrect
// result. See
- // https://github.com/typesafehub/config/issues/160
+ // https://github.com/lightbend/config/issues/160
if (arrayCount > 0)
throw parseError("Due to current limitations of the config parser, += does not work nested inside a list. "
+ "+= expands to a ${} substitution and the path in ${} cannot currently refer to list elements. "
diff --git a/config/src/main/java/com/typesafe/config/impl/package.html b/config/src/main/java/com/typesafe/config/impl/package.html
index 4df65c25..52592b0d 100644
--- a/config/src/main/java/com/typesafe/config/impl/package.html
+++ b/config/src/main/java/com/typesafe/config/impl/package.html
@@ -17,7 +17,7 @@ Please check out the {@link com.typesafe.config.Config public API} instead, unle
you're interested in browsing implementation details. None of the ABI
under impl
has any guarantees; it will change whenever someone
feels like changing it. If you feel you need access to something
-in impl
, please
+in impl
, please
file a feature request.
Example application code: Java and Scala.
-
Showing a couple of more special-purpose features, a more complex example: Java and Scala.
+
Example application code: Java and Scala.
+
Showing a couple of more special-purpose features, a more complex example: Java and Scala.
@@ -36,21 +36,21 @@ A library or framework should ship a file "reference.conf" in its jar, and allow
call {@link com.typesafe.config.ConfigFactory#load()}
to get the default one. Typically a library might offer two constructors, one with a Config
parameter
and one which uses {@link com.typesafe.config.ConfigFactory#load()}.
-
Example library code: Java and Scala.
+
Example library code: Java and Scala.
-Check out the full examples directory on GitHub. +Check out the full examples directory on GitHub.
What else to read:
.conf
files in addition to .json
and .properties
,
- see the README for some short examples
- and the full HOCON spec for the long version.
* Because this object is immutable, it is safe to use from multiple threads and
diff --git a/config/src/main/java/com/typesafe/config/parser/package.html b/config/src/main/java/com/typesafe/config/parser/package.html
index ef099cc4..b0e7b3ce 100644
--- a/config/src/main/java/com/typesafe/config/parser/package.html
+++ b/config/src/main/java/com/typesafe/config/parser/package.html
@@ -14,7 +14,7 @@ files. You do not want this package for everyday config in your app: see
the com.typesafe.config
package instead. You would use the raw
parser if you're doing something like reading, modifying, and re-saving a config
file. For info on the main config API this parser is a part of,
-see the project site.
+see the project site.
diff --git a/config/src/test/scala/com/typesafe/config/impl/ConcatenationTest.scala b/config/src/test/scala/com/typesafe/config/impl/ConcatenationTest.scala index aa70347e..acf898c3 100644 --- a/config/src/test/scala/com/typesafe/config/impl/ConcatenationTest.scala +++ b/config/src/test/scala/com/typesafe/config/impl/ConcatenationTest.scala @@ -346,7 +346,7 @@ class ConcatenationTest extends TestUtils { } // We would ideally make this case NOT throw an exception but we need to do some work - // to get there, see https://github.com/typesafehub/config/issues/160 + // to get there, see https://github.com/lightbend/config/issues/160 @Test def plusEqualsMultipleTimesNestedInArray() { val e = intercept[ConfigException.Parse] { @@ -357,7 +357,7 @@ class ConcatenationTest extends TestUtils { } // We would ideally make this case NOT throw an exception but we need to do some work - // to get there, see https://github.com/typesafehub/config/issues/160 + // to get there, see https://github.com/lightbend/config/issues/160 @Test def plusEqualsMultipleTimesNestedInPlusEquals() { val e = intercept[ConfigException.Parse] { @@ -367,7 +367,7 @@ class ConcatenationTest extends TestUtils { assertTrue(e.getMessage.contains("limitation")) } - // from https://github.com/typesafehub/config/issues/177 + // from https://github.com/lightbend/config/issues/177 @Test def arrayConcatenationInDoubleNestedDelayedMerge() { val unresolved = parseConfig("""d { x = [] }, c : ${d}, c { x += 1, x += 2 }""") @@ -375,7 +375,7 @@ class ConcatenationTest extends TestUtils { assertEquals(Seq(1, 2), conf.getIntList("c.x").asScala) } - // from https://github.com/typesafehub/config/issues/177 + // from https://github.com/lightbend/config/issues/177 @Test def arrayConcatenationAsPartOfDelayedMerge() { val unresolved = parseConfig(""" c { x: [], x : ${c.x}[1], x : ${c.x}[2] }""") @@ -383,7 +383,7 @@ class ConcatenationTest extends TestUtils { assertEquals(Seq(1, 2), conf.getIntList("c.x").asScala) } - // from https://github.com/typesafehub/config/issues/177 + // from https://github.com/lightbend/config/issues/177 @Test def arrayConcatenationInDoubleNestedDelayedMerge2() { val unresolved = parseConfig("""d { x = [] }, c : ${d}, c { x : ${c.x}[1], x : ${c.x}[2] }""") @@ -391,7 +391,7 @@ class ConcatenationTest extends TestUtils { assertEquals(Seq(1, 2), conf.getIntList("c.x").asScala) } - // from https://github.com/typesafehub/config/issues/177 + // from https://github.com/lightbend/config/issues/177 @Test def arrayConcatenationInTripleNestedDelayedMerge() { val unresolved = parseConfig("""{ r: { d.x=[] }, q: ${r}, q : { d { x = [] }, c : ${q.d}, c { x : ${q.c.x}[1], x : ${q.c.x}[2] } } }""") diff --git a/config/src/test/scala/com/typesafe/config/impl/ConfigValueTest.scala b/config/src/test/scala/com/typesafe/config/impl/ConfigValueTest.scala index 50add678..9d1a49a4 100644 --- a/config/src/test/scala/com/typesafe/config/impl/ConfigValueTest.scala +++ b/config/src/test/scala/com/typesafe/config/impl/ConfigValueTest.scala @@ -280,7 +280,7 @@ class ConfigValueTest extends TestUtils { } /** - * Reproduces the issue #461. + * Reproduces the issue #461. *
* We use a custom de-/serializer that encodes String objects in a JDK-incompatible way. Encoding used here * is rather simplistic: a long indicating the length in bytes (JDK uses a variable length integer) followed diff --git a/config/src/test/scala/com/typesafe/config/impl/PublicApiTest.scala b/config/src/test/scala/com/typesafe/config/impl/PublicApiTest.scala index 7d63026f..d25d4365 100644 --- a/config/src/test/scala/com/typesafe/config/impl/PublicApiTest.scala +++ b/config/src/test/scala/com/typesafe/config/impl/PublicApiTest.scala @@ -906,7 +906,7 @@ class PublicApiTest extends TestUtils { } // We would ideally make this case NOT throw an exception but we need to do some work - // to get there, see https://github.com/typesafehub/config/issues/160 + // to get there, see https://github.com/lightbend/config/issues/160 @Test def detectIncludeFromList() { val e = intercept[ConfigException.Parse] { @@ -1070,7 +1070,7 @@ class PublicApiTest extends TestUtils { @Test def heuristicIncludeChecksClasspath(): Unit = { - // from https://github.com/typesafehub/config/issues/188 + // from https://github.com/lightbend/config/issues/188 withScratchDirectory("heuristicIncludeChecksClasspath") { dir => val f = new File(dir, "foo.conf") writeFile(f, """ diff --git a/config/src/test/scala/com/typesafe/config/impl/UnitParserTest.scala b/config/src/test/scala/com/typesafe/config/impl/UnitParserTest.scala index f03593d1..a06a40c1 100644 --- a/config/src/test/scala/com/typesafe/config/impl/UnitParserTest.scala +++ b/config/src/test/scala/com/typesafe/config/impl/UnitParserTest.scala @@ -70,7 +70,7 @@ class UnitParserTest extends TestUtils { assertTrue(s"${e2.getMessage} was not the expected error message", e2.getMessage.contains("time unit 'seconds'")) } - // https://github.com/typesafehub/config/issues/117 + // https://github.com/lightbend/config/issues/117 // this broke because "1d" is a valid double for parseDouble @Test def parseOneDayAsMilliseconds(): Unit = { diff --git a/project/linksource.scala b/project/linksource.scala index 01c3226d..3c183497 100644 --- a/project/linksource.scala +++ b/project/linksource.scala @@ -37,7 +37,7 @@ object LinkSourcePlugin extends AutoPlugin { private def rewriteSourceLinks(dir: File, sourceBaseUrl: String, log: Logger): Unit = { // Convert to - // "https://github.com/typesafehub/config/blob/v1.2.1/config/src/main/java/com/typesafe/config/Config.java#L165" + // "https://github.com/lightbend/config/blob/v1.2.1/config/src/main/java/com/typesafe/config/Config.java#L165" // in all .html files found underneath dir val origRegex = "href=\".*src-html/([^\"]+)\"".r def listFiles(d: File): Seq[File] = IO.listFiles(d).toSeq.flatMap { f =>