This is an automated email from the ASF dual-hosted git repository.
cziegeler pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature.git
The following commit(s) were added to refs/heads/master by this push:
new 2736610 Update javadocs and remove spurious volatile
2736610 is described below
commit 2736610ca847680b3b621874aa0cccd4f6d07212
Author: Carsten Ziegeler <[email protected]>
AuthorDate: Fri Dec 4 17:09:33 2020 +0100
Update javadocs and remove spurious volatile
---
src/main/java/org/apache/sling/feature/ArtifactId.java | 2 +-
src/main/java/org/apache/sling/feature/Artifacts.java | 3 ++-
src/main/java/org/apache/sling/feature/Bundles.java | 3 ++-
.../sling/feature/ExecutionEnvironmentExtension.java | 3 ++-
src/main/java/org/apache/sling/feature/Extension.java | 4 ++--
src/main/java/org/apache/sling/feature/Feature.java | 18 +++++++++---------
.../java/org/apache/sling/feature/MapWithMetadata.java | 3 ++-
.../sling/feature/io/artifacts/ArtifactManager.java | 4 ++--
.../feature/io/artifacts/ArtifactManagerConfig.java | 7 ++++---
9 files changed, 26 insertions(+), 21 deletions(-)
diff --git a/src/main/java/org/apache/sling/feature/ArtifactId.java
b/src/main/java/org/apache/sling/feature/ArtifactId.java
index 489f109..fa23b82 100644
--- a/src/main/java/org/apache/sling/feature/ArtifactId.java
+++ b/src/main/java/org/apache/sling/feature/ArtifactId.java
@@ -29,7 +29,7 @@ import org.osgi.framework.Version;
* id, artifact id, and version. In addition, the classifier and type can be
* specified. If no type is specified, {@code jar} is assumed.
*
- * This class is not thread-safe.
+ * This class is thread-safe.
*/
public class ArtifactId implements Comparable<ArtifactId> {
diff --git a/src/main/java/org/apache/sling/feature/Artifacts.java
b/src/main/java/org/apache/sling/feature/Artifacts.java
index 09fa233..540cf3d 100644
--- a/src/main/java/org/apache/sling/feature/Artifacts.java
+++ b/src/main/java/org/apache/sling/feature/Artifacts.java
@@ -19,7 +19,8 @@ package org.apache.sling.feature;
import java.util.ArrayList;
/**
- * Groups a list of {@code Artifact}s. This class is not thread-safe.
+ * Groups a list of {@code Artifact}s.
+ * This class is not thread-safe.
*/
public class Artifacts extends ArrayList<Artifact> {
diff --git a/src/main/java/org/apache/sling/feature/Bundles.java
b/src/main/java/org/apache/sling/feature/Bundles.java
index 97899b0..8d2425b 100644
--- a/src/main/java/org/apache/sling/feature/Bundles.java
+++ b/src/main/java/org/apache/sling/feature/Bundles.java
@@ -25,7 +25,8 @@ import java.util.TreeMap;
/**
* Groups a list of bundles {@code Artifact} and provides a means to sort them
- * based on start order. This class is not thread-safe.
+ * based on start order.
+ * This class is not thread-safe.
*/
public class Bundles extends Artifacts {
diff --git
a/src/main/java/org/apache/sling/feature/ExecutionEnvironmentExtension.java
b/src/main/java/org/apache/sling/feature/ExecutionEnvironmentExtension.java
index 7831df6..e2f7595 100644
--- a/src/main/java/org/apache/sling/feature/ExecutionEnvironmentExtension.java
+++ b/src/main/java/org/apache/sling/feature/ExecutionEnvironmentExtension.java
@@ -24,7 +24,8 @@ import javax.json.JsonValue.ValueType;
import org.osgi.framework.Version;
/**
- * Execution environment extension
+ * Execution environment extension.
+ * This class is thread-safe.
* @since 1.4.0
*/
public class ExecutionEnvironmentExtension {
diff --git a/src/main/java/org/apache/sling/feature/Extension.java
b/src/main/java/org/apache/sling/feature/Extension.java
index 2b9873c..1842d61 100644
--- a/src/main/java/org/apache/sling/feature/Extension.java
+++ b/src/main/java/org/apache/sling/feature/Extension.java
@@ -88,10 +88,10 @@ public class Extension {
private final Artifacts artifacts;
/** The text or json (if corresponding type) */
- private volatile String text;
+ private String text;
/** The json structure (if corresponding type) */
- private volatile JsonStructure json;
+ private JsonStructure json;
/** Extension state. */
private final ExtensionState state;
diff --git a/src/main/java/org/apache/sling/feature/Feature.java
b/src/main/java/org/apache/sling/feature/Feature.java
index d4346b3..05f586e 100644
--- a/src/main/java/org/apache/sling/feature/Feature.java
+++ b/src/main/java/org/apache/sling/feature/Feature.java
@@ -61,31 +61,31 @@ public class Feature implements Comparable<Feature> {
private final MapWithMetadata variables = new MapWithMetadata();
/** The optional location. */
- private volatile String location;
+ private String location;
/** The optional title. */
- private volatile String title;
+ private String title;
/** The optional description. */
- private volatile String description;
+ private String description;
/** The optional vendor. */
- private volatile String vendor;
+ private String vendor;
/** The optional license. */
- private volatile String license;
+ private String license;
/** Flag indicating whether this is an assembled feature */
- private volatile boolean assembled = false;
+ private boolean assembled = false;
/** Flag indicating whether this is a final feature */
- private volatile boolean finalFlag = false;
+ private boolean finalFlag = false;
/** Flag indicating whether this is a complete feature */
- private volatile boolean completeFlag = false;
+ private boolean completeFlag = false;
/** The optional prototype. */
- private volatile Prototype prototype;
+ private Prototype prototype;
/**
* Construct a new feature.
diff --git a/src/main/java/org/apache/sling/feature/MapWithMetadata.java
b/src/main/java/org/apache/sling/feature/MapWithMetadata.java
index 9cfbb54..f9a2a81 100644
--- a/src/main/java/org/apache/sling/feature/MapWithMetadata.java
+++ b/src/main/java/org/apache/sling/feature/MapWithMetadata.java
@@ -23,7 +23,8 @@ import java.util.Map;
import java.util.Set;
/**
- * Helper class to maintain metadata for a map
+ * Helper class to maintain metadata for a map.
+ * This class is not thread-safe.
* @since 1.7.0
*/
class MapWithMetadata implements Map<String, String> {
diff --git
a/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactManager.java
b/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactManager.java
index 80d9304..021be9a 100644
--- a/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactManager.java
+++ b/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactManager.java
@@ -343,9 +343,9 @@ public class ArtifactManager
private final Logger logger = LoggerFactory.getLogger(this.getClass());
- private volatile File cacheDir;
+ private File cacheDir;
- private volatile ArtifactProviderContext config;
+ private ArtifactProviderContext config;
@Override
public String getProtocol() {
diff --git
a/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactManagerConfig.java
b/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactManagerConfig.java
index 82e6476..876d895 100644
---
a/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactManagerConfig.java
+++
b/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactManagerConfig.java
@@ -25,14 +25,15 @@ import
org.apache.sling.feature.io.artifacts.spi.ArtifactProviderContext;
/**
* This class holds the configuration of artifact manager.
+ * This class is not thread-safe.
*/
public class ArtifactManagerConfig implements ArtifactProviderContext {
/** The repository urls. */
- private volatile String[] repositoryUrls;
+ private String[] repositoryUrls;
/** The cache directory. */
- private volatile File cacheDirectory;
+ private File cacheDirectory;
/** Metrics for artifacts used from the cache. */
private final AtomicLong cachedArtifacts = new AtomicLong();
@@ -44,7 +45,7 @@ public class ArtifactManagerConfig implements
ArtifactProviderContext {
private final AtomicLong localArtifacts = new AtomicLong();
/** Whether locally mvn command can be used to download artifacts. */
- private volatile boolean useMvn = false;
+ private boolean useMvn = false;
/**
* The .m2 directory.
