Merge pull request #271 from eclipse/issues/GH-619-public-api

Public API clarifications for SHACL, native store and other storage modules

lucene-api/src/main/java/org/eclipse/rdf4j/sail/lucene/LuceneSailBuffer.java

@@ -12,6 +12,7 @@
 import java.util.Iterator;
 import java.util.List;
 
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;
 import org.eclipse.rdf4j.model.IRI;
 import org.eclipse.rdf4j.model.Resource;
 import org.eclipse.rdf4j.model.Statement;
@@ -23,7 +24,12 @@
  * 
  * @author sauermann
  * @author andriy.nikolov
+ * 
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
  */
+@Deprecated
+@InternalUseOnly
 public class LuceneSailBuffer {
 
 	private static class ContextAwareStatementImpl implements Statement {

lucene-api/src/main/java/org/eclipse/rdf4j/sail/lucene/util/IteratorCloseableIteration.java

@@ -10,9 +10,16 @@
 
 import java.util.Iterator;
 
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;
 import org.eclipse.rdf4j.common.iteration.CloseableIteration;
 import org.eclipse.rdf4j.common.iteration.IteratorIteration;
 
+/**
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+@Deprecated
+@InternalUseOnly
 public class IteratorCloseableIteration<E, X extends Exception> extends IteratorIteration<E, X>
 		implements CloseableIteration<E, X> {
 

lucene-api/src/main/java/org/eclipse/rdf4j/sail/lucene/util/MapOfListMaps.java

@@ -13,9 +13,16 @@
 import java.util.List;
 import java.util.Map;
 
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;
+
 /**
  * @author andriy.nikolov
+ * 
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
  */
+@Deprecated
+@InternalUseOnly
 public class MapOfListMaps<Index1Type, Index2Type, DataType> {
 
 	private final Map<Index1Type, Map<Index2Type, List<DataType>>> data;

memory/src/main/java/org/eclipse/rdf4j/sail/memory/model/package-info.java

@@ -0,0 +1,11 @@
+@Deprecated
+@InternalUseOnly
+/**
+ * MemoryStore-specific implementations of the core RDF model objects.
+ * 
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+package org.eclipse.rdf4j.sail.memory.model;
+
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;

nativerdf/src/main/java/org/eclipse/rdf4j/sail/nativerdf/SortedRecordCache.java

@@ -20,6 +20,7 @@
  * 
  * @author Arjohn Kampman
  */
+@SuppressWarnings("deprecation")
 final class SortedRecordCache extends RecordCache {
 
 	/*------------*

nativerdf/src/main/java/org/eclipse/rdf4j/sail/nativerdf/TripleStore.java

@@ -41,6 +41,7 @@
  * 
  * @author Arjohn Kampman
  */
+@SuppressWarnings("deprecation")
 class TripleStore implements Closeable {
 
 	/*-----------*
@@ -407,10 +408,6 @@ private void reindex(Set<String> currentIndexSpecs, Set<String> newIndexSpecs) t
 		}
 	}
 
-	private String getCurrentIndexSpecStr() {
-		return properties.getProperty(INDEXES_KEY);
-	}
-
 	@Override
 	public void close() throws IOException {
 		try {

nativerdf/src/main/java/org/eclipse/rdf4j/sail/nativerdf/ValueStore.java

@@ -13,6 +13,7 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Optional;
 
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;
 import org.eclipse.rdf4j.common.concurrent.locks.Lock;
 import org.eclipse.rdf4j.common.concurrent.locks.ReadWriteLockManager;
 import org.eclipse.rdf4j.common.concurrent.locks.WritePrefReadWriteLockManager;
@@ -38,7 +39,12 @@
  * File-based indexed storage and retrieval of RDF values. ValueStore maps RDF values to integer IDs and vice-versa.
  * 
  * @author Arjohn Kampman
+ * 
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
  */
+@InternalUseOnly
+@Deprecated
 public class ValueStore extends AbstractValueFactory {
 
 	/*-----------*

nativerdf/src/main/java/org/eclipse/rdf4j/sail/nativerdf/ValueStoreRevision.java

@@ -9,6 +9,7 @@
 
 import java.io.Serializable;
 
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;
 import org.eclipse.rdf4j.sail.nativerdf.model.NativeValue;
 
 /**
@@ -17,7 +18,12 @@
  * ValueStore's revision object is changed whenever values are removed from it or IDs are changed.
  * 
  * @author Arjohn Kampman
+ * 
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
  */
+@Deprecated
+@InternalUseOnly
 public class ValueStoreRevision implements Serializable {
 
 	/*-----------*

nativerdf/src/main/java/org/eclipse/rdf4j/sail/nativerdf/btree/package-info.java

@@ -0,0 +1,11 @@
+@Deprecated
+@InternalUseOnly
+/**
+ * B-Tree on disk implementation.
+ * 
+ * @deprecated since 3.0. This package is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+package org.eclipse.rdf4j.sail.nativerdf.btree;
+
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;

nativerdf/src/main/java/org/eclipse/rdf4j/sail/nativerdf/datastore/package-info.java

@@ -0,0 +1,11 @@
+@Deprecated
+@InternalUseOnly
+/**
+ * File and data storage functionality.
+ * 
+ * @deprecated Since 3.0. This package is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+package org.eclipse.rdf4j.sail.nativerdf.datastore;
+
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;

nativerdf/src/main/java/org/eclipse/rdf4j/sail/nativerdf/model/package-info.java

@@ -0,0 +1,11 @@
+@Deprecated
+@InternalUseOnly
+/**
+ * Native implementations of the RDF Model interfaces.
+ * 
+ * @deprecated since 3.0. This package is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+package org.eclipse.rdf4j.sail.nativerdf.model;
+
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;

repository-dataset/src/main/java/org/eclipse/rdf4j/repository/dataset/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * A repository wrapper which supports auto-loading of datasets specified in a query.
+ */
+package org.eclipse.rdf4j.repository.dataset;

sail-model/src/main/java/org/eclipse/rdf4j/sail/model/NonSerializables.java

@@ -20,6 +20,8 @@
  * entries to be garbage-collected when no longer used.
  * 
  * @author Mark
+ * @deprecated this feature is for internal use only: its existence, signature or behavior may change without warning
+ *             from one release to the next.
  */
 public class NonSerializables {
 

sail-model/src/main/java/org/eclipse/rdf4j/sail/model/SailModel.java

@@ -40,6 +40,9 @@
  * Not thread-safe.
  * 
  * @author Mark
+ * 
+ * @deprecated this feature is for internal use only: its existence, signature or behavior may change without warning
+ *             from one release to the next.
  */
 public class SailModel extends AbstractModel {
 

sail-model/src/main/java/org/eclipse/rdf4j/sail/model/package-info.java

@@ -0,0 +1,10 @@
+@Deprecated
+@InternalUseOnly
+/**
+ * 
+ * @deprecated since 3.0. This package is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+package org.eclipse.rdf4j.sail.model;
+
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;

shacl/src/main/java/org/eclipse/rdf4j/sail/shacl/AST/package-info.java

@@ -0,0 +1,9 @@
+@Deprecated
+@InternalUseOnly
+/**
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+package org.eclipse.rdf4j.sail.shacl.AST;
+
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;

shacl/src/main/java/org/eclipse/rdf4j/sail/shacl/CloseablePeakableIteration.java

@@ -1,7 +1,24 @@
+/*******************************************************************************
+ * Copyright (c) 2019 Eclipse RDF4J contributors.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Distribution License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/org/documents/edl-v10.php.
+ *******************************************************************************/
+
 package org.eclipse.rdf4j.sail.shacl;
 
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;
 import org.eclipse.rdf4j.common.iteration.CloseableIteration;
 
+/**
+ * 
+ *
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+@Deprecated
+@InternalUseOnly
 public class CloseablePeakableIteration<E, X extends Exception> implements CloseableIteration<E, X> {
 
 	CloseableIteration<E, X> parent;

shacl/src/main/java/org/eclipse/rdf4j/sail/shacl/ConnectionsGroup.java

@@ -8,16 +8,25 @@
 
 package org.eclipse.rdf4j.sail.shacl;
 
-import org.eclipse.rdf4j.sail.Sail;
-import org.eclipse.rdf4j.sail.SailConnection;
-import org.eclipse.rdf4j.sail.shacl.planNodes.BufferedSplitter;
-import org.eclipse.rdf4j.sail.shacl.planNodes.PlanNode;
-
 import java.io.Closeable;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.concurrent.ConcurrentLinkedQueue;
 
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;
+import org.eclipse.rdf4j.sail.Sail;
+import org.eclipse.rdf4j.sail.SailConnection;
+import org.eclipse.rdf4j.sail.shacl.planNodes.BufferedSplitter;
+import org.eclipse.rdf4j.sail.shacl.planNodes.PlanNode;
+
+/**
+ *
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ *
+ */
+@Deprecated
+@InternalUseOnly
 public class ConnectionsGroup implements Closeable {
 
 	private final ShaclSail sail;

shacl/src/main/java/org/eclipse/rdf4j/sail/shacl/GlobalValidationExecutionLogging.java

@@ -1,5 +1,21 @@
+/*******************************************************************************
+ * Copyright (c) 2019 Eclipse RDF4J contributors.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Distribution License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/org/documents/edl-v10.php.
+ *******************************************************************************/
+
 package org.eclipse.rdf4j.sail.shacl;
 
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;
+
+/**
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+@Deprecated
+@InternalUseOnly
 public class GlobalValidationExecutionLogging {
 
 	public static boolean loggingEnabled;

shacl/src/main/java/org/eclipse/rdf4j/sail/shacl/NoShapesLoadedException.java

@@ -10,6 +10,12 @@
 
 import org.eclipse.rdf4j.model.vocabulary.RDF4J;
 
+/**
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+@Deprecated
+// FIXME should extend SailException
 public class NoShapesLoadedException extends RuntimeException {
 
 	private static final long serialVersionUID = 1L;

shacl/src/main/java/org/eclipse/rdf4j/sail/shacl/RdfsSubClassOfReasoner.java

@@ -8,15 +8,6 @@
 
 package org.eclipse.rdf4j.sail.shacl;
 
-import org.eclipse.rdf4j.common.iteration.Iterations;
-import org.eclipse.rdf4j.model.Resource;
-import org.eclipse.rdf4j.model.Statement;
-import org.eclipse.rdf4j.model.impl.SimpleValueFactory;
-import org.eclipse.rdf4j.model.vocabulary.RDF;
-import org.eclipse.rdf4j.model.vocabulary.RDFS;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -27,6 +18,22 @@
 import java.util.Set;
 import java.util.stream.Stream;
 
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;
+import org.eclipse.rdf4j.common.iteration.Iterations;
+import org.eclipse.rdf4j.model.Resource;
+import org.eclipse.rdf4j.model.Statement;
+import org.eclipse.rdf4j.model.impl.SimpleValueFactory;
+import org.eclipse.rdf4j.model.vocabulary.RDF;
+import org.eclipse.rdf4j.model.vocabulary.RDFS;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+@Deprecated
+@InternalUseOnly
 public class RdfsSubClassOfReasoner {
 
 	private static final Logger logger = LoggerFactory.getLogger(RdfsSubClassOfReasoner.class);

shacl/src/main/java/org/eclipse/rdf4j/sail/shacl/Stats.java

@@ -8,8 +8,14 @@
 
 package org.eclipse.rdf4j.sail.shacl;
 
+import org.eclipse.rdf4j.common.annotation.InternalUseOnly;
 import org.eclipse.rdf4j.model.Statement;
 
+/**
+ * @deprecated since 3.0. This feature is for internal use only: its existence, signature or behavior may change without
+ *             warning from one release to the next.
+ */
+@InternalUseOnly
 public class Stats {
 
 	private boolean baseSailEmpty;