diff --git a/spring-core/src/main/java/org/springframework/core/CollectionFactory.java b/spring-core/src/main/java/org/springframework/core/CollectionFactory.java
index 4923464910d0e3ff65b30f4cb5a35846c49a4438..6df7b4daac1339a3fb6ea2c29aa92efc5552b8a8 100644
--- a/spring-core/src/main/java/org/springframework/core/CollectionFactory.java
+++ b/spring-core/src/main/java/org/springframework/core/CollectionFactory.java
@@ -346,6 +346,50 @@ public final class CollectionFactory {
};
}
+ /**
+ * Create a variant of {@link java.util.Properties} that sorts properties
+ * alphanumerically based on their keys.
+ *
+ *
This can be useful when storing the {@link Properties} instance in a
+ * properties file, since it allows such files to be generated in a repeatable
+ * manner with consistent ordering of properties. Comments in generated
+ * properties files can also be optionally omitted.
+ *
+ * @param omitComments {@code true} if comments should be omitted when
+ * storing properties in a file
+ * @return a new {@code Properties} instance
+ * @since 5.2
+ * @see #createSortedProperties(Properties, boolean)
+ */
+ public static Properties createSortedProperties(boolean omitComments) {
+ return new SortedProperties(omitComments);
+ }
+
+ /**
+ * Create a variant of {@link java.util.Properties} that sorts properties
+ * alphanumerically based on their keys.
+ *
+ *
This can be useful when storing the {@code Properties} instance in a
+ * properties file, since it allows such files to be generated in a repeatable
+ * manner with consistent ordering of properties. Comments in generated
+ * properties files can also be optionally omitted.
+ *
+ *
The returned {@code Properties} instance will be populated with
+ * properties from the supplied {@code properties} object, but default
+ * properties from the supplied {@code properties} object will not be copied.
+ *
+ * @param properties the {@code Properties} object from which to copy the
+ * initial properties
+ * @param omitComments {@code true} if comments should be omitted when
+ * storing properties in a file
+ * @return a new {@code Properties} instance
+ * @since 5.2
+ * @see #createSortedProperties(boolean)
+ */
+ public static Properties createSortedProperties(Properties properties, boolean omitComments) {
+ return new SortedProperties(properties, omitComments);
+ }
+
/**
* Cast the given type to a subtype of {@link Enum}.
* @param enumType the enum type, never {@code null}
diff --git a/spring-core/src/main/java/org/springframework/core/SortedProperties.java b/spring-core/src/main/java/org/springframework/core/SortedProperties.java
new file mode 100644
index 0000000000000000000000000000000000000000..f1c2e8417b6b961f9c14c65087d288a36c39e363
--- /dev/null
+++ b/spring-core/src/main/java/org/springframework/core/SortedProperties.java
@@ -0,0 +1,161 @@
+/*
+ * Copyright 2002-2019 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.core;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.StringWriter;
+import java.io.Writer;
+import java.nio.charset.StandardCharsets;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.Enumeration;
+import java.util.Map.Entry;
+import java.util.Properties;
+import java.util.Set;
+import java.util.TreeSet;
+
+import org.springframework.util.StringUtils;
+
+/**
+ * Specialization of {@link Properties} that sorts properties alphanumerically
+ * based on their keys.
+ *
+ *
This can be useful when storing the {@link Properties} instance in a
+ * properties file, since it allows such files to be generated in a repeatable
+ * manner with consistent ordering of properties.
+ *
+ *
Comments in generated properties files can also be optionally omitted.
+ *
+ * @author Sam Brannen
+ * @since 5.2
+ * @see java.util.Properties
+ */
+@SuppressWarnings("serial")
+class SortedProperties extends Properties {
+
+ static final String EOL = System.getProperty("line.separator");
+
+ private static final Comparator