lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ans...@apache.org
Subject [lucene-solr] branch branch_8x updated: SOLR-13998: Add thread safety annotations to classes (#1053) (#1057)
Date Wed, 04 Dec 2019 06:39:33 GMT
This is an automated email from the ASF dual-hosted git repository.

anshum pushed a commit to branch branch_8x
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git


The following commit(s) were added to refs/heads/branch_8x by this push:
     new b4375cc  SOLR-13998: Add thread safety annotations to classes (#1053) (#1057)
b4375cc is described below

commit b4375cc235a7c9829a6ac243ae065ee589026b69
Author: Anshum Gupta <anshum@apache.org>
AuthorDate: Wed Dec 4 12:09:22 2019 +0530

    SOLR-13998: Add thread safety annotations to classes (#1053) (#1057)
---
 solr/CHANGES.txt                                   |  3 ++
 .../solr/common/annotation/SolrSingleThreaded.java | 34 +++++++++++++++++++++
 .../solr/common/annotation/SolrThreadSafe.java     | 35 ++++++++++++++++++++++
 3 files changed, 72 insertions(+)

diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index e181888..e113ca9 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -151,6 +151,9 @@ Other Changes
 
 * SOLR-13992: Code refactored to have collection name, slice name in Replica, Slice (noble)
 
+* SOLR-13998: Add thread safety annotations to Solr. This only introduces the annotations
and doesn't add these to
+  existing classes. (Anshum Gupta, Mark Miller)
+
 ==================  8.3.1 ==================
 
 Consult the LUCENE_CHANGES.txt file for additional, low level, changes in this release.
diff --git a/solr/solrj/src/java/org/apache/solr/common/annotation/SolrSingleThreaded.java
b/solr/solrj/src/java/org/apache/solr/common/annotation/SolrSingleThreaded.java
new file mode 100644
index 0000000..3845468
--- /dev/null
+++ b/solr/solrj/src/java/org/apache/solr/common/annotation/SolrSingleThreaded.java
@@ -0,0 +1,34 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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
+ *
+ *     http://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.apache.solr.common.annotation;
+
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.SOURCE;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Annotation for classes in Solr that are not thread safe. This provides a clear indication
of the thread safety of the class.
+ */
+@Documented
+@Retention(SOURCE)
+@Target(TYPE)
+public @interface SolrSingleThreaded {
+
+}
diff --git a/solr/solrj/src/java/org/apache/solr/common/annotation/SolrThreadSafe.java b/solr/solrj/src/java/org/apache/solr/common/annotation/SolrThreadSafe.java
new file mode 100644
index 0000000..8c2ef48
--- /dev/null
+++ b/solr/solrj/src/java/org/apache/solr/common/annotation/SolrThreadSafe.java
@@ -0,0 +1,35 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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
+ *
+ *     http://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.apache.solr.common.annotation;
+
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.SOURCE;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * This annotation is applied to a class that is thread safe. This means that the objects
of this class will never be
+ * in an inconsistent state, irrespective of interleaving accesses to the object.
+ */
+@Documented
+@Retention(SOURCE)
+@Target(TYPE)
+public @interface SolrThreadSafe {
+
+}


Mime
View raw message