Create org.jspecify.nullness, and move the contents of org.jspecify.a…

…nnotations there. Closes #160 Also relevant to #1 Plus, renames relevant to #181: - Rename the JPMS module from org.jspecify.annotations to org.jspecify. - Rename the Maven artifact from org.jspecify:annotations to org.jspecify:jspecify.
jspecify · Mar 12, 2021 · df06583 · df06583
1 parent d1cd6b2
commit df06583
Show file tree

Hide file tree

Showing 192 changed files with 503 additions and 503 deletions.
diff --git a/...e/devtools/javatools/typeannotationrefactoring/CheckerFrameworkToJspecifyRefactoring.java b/...e/devtools/javatools/typeannotationrefactoring/CheckerFrameworkToJspecifyRefactoring.java
@@ -147,11 +147,11 @@ public Void visitClass(ClassTree node, Void aVoid) {
       public Void visitImport(ImportTree node, Void aVoid) {
         if (!addedImports) {
           addedImports = true;
-          definiteReplacements.put(atStart(node), "import org.jspecify.annotations.Nullable;\n");
+          definiteReplacements.put(atStart(node), "import org.jspecify.nullness.Nullable;\n");
           possibleReplacements.put(
               atStart(node),
-              "import org.jspecify.annotations.DefaultNonNull;\n"
-                  + "import org.jspecify.annotations.Nullable;\n");
+              "import org.jspecify.nullness.DefaultNonNull;\n"
+                  + "import org.jspecify.nullness.Nullable;\n");
         }
         if (node.getQualifiedIdentifier().toString().startsWith("org.checkerframework.")) {
           definiteReplacements.put(inPlaceOfNodeAndTrailingNewline(node, unit), "");

diff --git a/docs/tsttcpw.rst b/docs/tsttcpw.rst
@@ -120,7 +120,7 @@ Null-aware context
 
 To determine whether a type usage appears in a null-aware context:
 
-Look for an ``@org.jspecify.annotations.NullAware`` annotation on any of
+Look for an ``@org.jspecify.nullness.NullAware`` annotation on any of
 the enclosing scopes surrounding the type usage.
 
 Class members are enclosed by classes, which may be enclosed by other
@@ -135,9 +135,9 @@ packages, which may be enclosed by modules.
    Java compiler
    API <https://docs.oracle.com/en/java/javase/14/docs/api/java.compiler/javax/lang/model/element/Element.html#getEnclosingElement()>`__.
 
-If an ``@org.jspecify.annotations.NullAware`` annotation exists on one
-of these scopes, then the type usage is in a null-aware context.
-Otherwise, it is not.
+If an ``@org.jspecify.nullness.NullAware`` annotation exists on one of
+these scopes, then the type usage is in a null-aware context. Otherwise,
+it is not.
 
 .. _augmented-type-of-usage:
 
@@ -159,7 +159,7 @@ To determine the nullness operator, apply the following rules in order.
 Once one condition is met, skip the remaining conditions.
 
 -  If the type usage is annotated with
-   ``@org.jspecify.annotations.Nullable``, its nullness operator is
+   ``@org.jspecify.nullness.Nullable``, its nullness operator is
    ``UNION_NULL``.
 -  If the type usage appears in a `null-aware
    context <#null-aware-context>`__, its nullness operator is

diff --git a/gradle/publish.gradle b/gradle/publish.gradle
@@ -5,7 +5,7 @@ publishing {
         mavenJava(MavenPublication) {
             pom {
                 groupId = 'org.jspecify'
-                artifactId = 'annotations'
+                artifactId = 'jspecify'
                 name = 'JSpecify annotations'
                 description = 'An artifact of well-named and well-specified annotations to power static analysis checks'
                 url = 'https://jspecify.org/'

diff --git a/samples/AnnotatedInnerOfNonParameterized.java b/samples/AnnotatedInnerOfNonParameterized.java
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
 
 @DefaultNonNull
 abstract class AnnotatedInnerOfNonParameterized {

diff --git a/samples/AnnotatedInnerOfParameterized.java b/samples/AnnotatedInnerOfParameterized.java
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
 
 @DefaultNonNull
 abstract class AnnotatedInnerOfParameterized<T> {

diff --git a/samples/AnnotatedReceiver.java b/samples/AnnotatedReceiver.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 interface AnnotatedReceiver {

diff --git a/samples/AnnotatedTypeParameter.java b/samples/AnnotatedTypeParameter.java
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
 
 @DefaultNonNull
 class AnnotatedTypeParameter {

diff --git a/samples/AnnotatedTypeParameterUnspec.java b/samples/AnnotatedTypeParameterUnspec.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 class AnnotatedTypeParameterUnspec {

diff --git a/samples/AnnotatedWildcard.java b/samples/AnnotatedWildcard.java
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
 
 @DefaultNonNull
 class AnnotatedWildcard {

diff --git a/samples/AnnotatedWildcardUnspec.java b/samples/AnnotatedWildcardUnspec.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 class AnnotatedWildcardUnspec {

diff --git a/samples/AssignmentAsExpression.java b/samples/AssignmentAsExpression.java
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
 
 @DefaultNonNull
 class AssignmentAsExpression {

diff --git a/samples/AugmentedInferenceAgreesWithBaseInference.java b/samples/AugmentedInferenceAgreesWithBaseInference.java
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
 
 @DefaultNonNull
 abstract class AugmentedInferenceAgreesWithBaseInference {

diff --git a/samples/BoundedTypeVariableReturn.java b/samples/BoundedTypeVariableReturn.java
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
 
 @DefaultNonNull
 class BoundedTypeVariableReturn {

diff --git a/samples/CaptureConversionForSubtyping.java b/samples/CaptureConversionForSubtyping.java
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
 
 @DefaultNonNull
 class CaptureConversionForSubtyping {

diff --git a/samples/CaptureConvertedToObject.java b/samples/CaptureConvertedToObject.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 class CaptureConvertedToObject {

diff --git a/samples/CaptureConvertedToObjectUnionNull.java b/samples/CaptureConvertedToObjectUnionNull.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 class CaptureConvertedToObjectUnionNull {

diff --git a/samples/CaptureConvertedToObjectUnspec.java b/samples/CaptureConvertedToObjectUnspec.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 class CaptureConvertedToObjectUnspec {

diff --git a/samples/CaptureConvertedToOther.java b/samples/CaptureConvertedToOther.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 class CaptureConvertedToOther {

diff --git a/samples/CaptureConvertedToOtherUnionNull.java b/samples/CaptureConvertedToOtherUnionNull.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 class CaptureConvertedToOtherUnionNull {

diff --git a/samples/CaptureConvertedToOtherUnspec.java b/samples/CaptureConvertedToOtherUnspec.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 class CaptureConvertedToOtherUnspec {

diff --git a/samples/CaptureConvertedUnionNullToObject.java b/samples/CaptureConvertedUnionNullToObject.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 abstract class CaptureConvertedUnionNullToObject {

diff --git a/samples/CaptureConvertedUnionNullToObjectUnionNull.java b/samples/CaptureConvertedUnionNullToObjectUnionNull.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 abstract class CaptureConvertedUnionNullToObjectUnionNull {

diff --git a/samples/CaptureConvertedUnionNullToObjectUnspec.java b/samples/CaptureConvertedUnionNullToObjectUnspec.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 abstract class CaptureConvertedUnionNullToObjectUnspec {

diff --git a/samples/CaptureConvertedUnionNullToOther.java b/samples/CaptureConvertedUnionNullToOther.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 abstract class CaptureConvertedUnionNullToOther {

diff --git a/samples/CaptureConvertedUnionNullToOtherUnionNull.java b/samples/CaptureConvertedUnionNullToOtherUnionNull.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 abstract class CaptureConvertedUnionNullToOtherUnionNull {

diff --git a/samples/CaptureConvertedUnionNullToOtherUnspec.java b/samples/CaptureConvertedUnionNullToOtherUnspec.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 abstract class CaptureConvertedUnionNullToOtherUnspec {

diff --git a/samples/CaptureConvertedUnspecToObject.java b/samples/CaptureConvertedUnspecToObject.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 abstract class CaptureConvertedUnspecToObject {

diff --git a/samples/CaptureConvertedUnspecToObjectUnionNull.java b/samples/CaptureConvertedUnspecToObjectUnionNull.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 abstract class CaptureConvertedUnspecToObjectUnionNull {

diff --git a/samples/CaptureConvertedUnspecToObjectUnspec.java b/samples/CaptureConvertedUnspecToObjectUnspec.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 abstract class CaptureConvertedUnspecToObjectUnspec {

diff --git a/samples/CaptureConvertedUnspecToOther.java b/samples/CaptureConvertedUnspecToOther.java
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import org.jspecify.annotations.DefaultNonNull;
-import org.jspecify.annotations.Nullable;
-import org.jspecify.annotations.NullnessUnspecified;
+import org.jspecify.nullness.DefaultNonNull;
+import org.jspecify.nullness.Nullable;
+import org.jspecify.nullness.NullnessUnspecified;
 
 @DefaultNonNull
 abstract class CaptureConvertedUnspecToOther {