Reorganize the org.scijava.io classes

ctrueden · ctrueden · commit ac6a54ae9a00 · 2017-07-07T16:35:48.000-05:00
This moves Location stuff to org.scijava.io.location,
and DataHandle stuff to org.scijava.io.handle.

It breaks backwards compatibility, but the Location API was not being
used by any SJC-based systems yet. We make the change now to minimize
future damage.
diff --git a/src/main/java/org/scijava/io/IOService.java b/src/main/java/org/scijava/io/IOService.java
@@ -40,8 +40,6 @@
  * Interface for high-level data I/O: opening and saving data.
  * 
  * @author Curtis Rueden
- * @see DataHandleService
- * @see Location
  */
 public interface IOService extends HandlerService<String, IOPlugin<?>>,
 	SciJavaService
diff --git a/src/main/java/org/scijava/io/handle/AbstractDataHandle.java b/src/main/java/org/scijava/io/handle/AbstractDataHandle.java
@@ -29,10 +29,11 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.handle;
 
 import java.nio.ByteOrder;
 
+import org.scijava.io.location.Location;
 import org.scijava.plugin.AbstractWrapperPlugin;
 
 /**
diff --git a/src/main/java/org/scijava/io/handle/DataHandle.java b/src/main/java/org/scijava/io/handle/DataHandle.java
@@ -29,7 +29,7 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.handle;
 
 import java.io.Closeable;
 import java.io.DataInput;
@@ -39,6 +39,7 @@
 import java.nio.ByteBuffer;
 import java.nio.ByteOrder;
 
+import org.scijava.io.location.Location;
 import org.scijava.plugin.WrapperPlugin;
 
 /**
diff --git a/src/main/java/org/scijava/io/handle/DataHandleInputStream.java b/src/main/java/org/scijava/io/handle/DataHandleInputStream.java
@@ -29,11 +29,13 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.handle;
 
 import java.io.IOException;
 import java.io.InputStream;
 
+import org.scijava.io.location.Location;
+
 /**
  * {@link InputStream} backed by a {@link DataHandle}.
  * 
diff --git a/src/main/java/org/scijava/io/handle/DataHandleOutputStream.java b/src/main/java/org/scijava/io/handle/DataHandleOutputStream.java
@@ -29,11 +29,13 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.handle;
 
 import java.io.IOException;
 import java.io.OutputStream;
 
+import org.scijava.io.location.Location;
+
 /**
  * {@link OutputStream} backed by a {@link DataHandle}.
  * 
diff --git a/src/main/java/org/scijava/io/handle/DataHandleService.java b/src/main/java/org/scijava/io/handle/DataHandleService.java
@@ -29,8 +29,10 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.handle;
 
+import org.scijava.io.IOService;
+import org.scijava.io.location.Location;
 import org.scijava.plugin.WrapperService;
 import org.scijava.service.SciJavaService;
 
diff --git a/src/main/java/org/scijava/io/handle/DefaultDataHandleService.java b/src/main/java/org/scijava/io/handle/DefaultDataHandleService.java
@@ -29,8 +29,9 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.handle;
 
+import org.scijava.io.location.Location;
 import org.scijava.plugin.AbstractWrapperService;
 import org.scijava.plugin.Plugin;
 import org.scijava.service.Service;
diff --git a/src/main/java/org/scijava/io/handle/FileHandle.java b/src/main/java/org/scijava/io/handle/FileHandle.java
@@ -29,11 +29,12 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.handle;
 
 import java.io.IOException;
 import java.io.RandomAccessFile;
 
+import org.scijava.io.location.FileLocation;
 import org.scijava.plugin.Plugin;
 
 /**
diff --git a/src/main/java/org/scijava/io/location/AbstractLocation.java b/src/main/java/org/scijava/io/location/AbstractLocation.java
@@ -29,7 +29,7 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.location;
 
 /**
  * Abstract base class for {@link Location} implementations.
diff --git a/src/main/java/org/scijava/io/location/BytesLocation.java b/src/main/java/org/scijava/io/location/BytesLocation.java
@@ -29,7 +29,7 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.location;
 
 import java.nio.ByteBuffer;
 
diff --git a/src/main/java/org/scijava/io/location/FileLocation.java b/src/main/java/org/scijava/io/location/FileLocation.java
@@ -29,7 +29,7 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.location;
 
 import java.io.File;
 import java.net.URI;
diff --git a/src/main/java/org/scijava/io/location/Location.java b/src/main/java/org/scijava/io/location/Location.java
@@ -29,10 +29,12 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.location;
 
 import java.net.URI;
 
+import org.scijava.io.handle.DataHandle;
+
 /**
  * A <em>location</em> is a data descriptor, such as a file on disk, a remote
  * URL, or a database connection.
diff --git a/src/main/java/org/scijava/io/location/URILocation.java b/src/main/java/org/scijava/io/location/URILocation.java
@@ -29,7 +29,7 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.location;
 
 import java.io.UnsupportedEncodingException;
 import java.net.URI;
diff --git a/src/main/java/org/scijava/io/location/URLLocation.java b/src/main/java/org/scijava/io/location/URLLocation.java
@@ -29,7 +29,7 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.location;
 
 import java.net.URI;
 import java.net.URISyntaxException;
diff --git a/src/test/java/org/scijava/ContextCreationTest.java b/src/test/java/org/scijava/ContextCreationTest.java
@@ -95,9 +95,9 @@ public void testFull() {
 				org.scijava.display.DefaultDisplayService.class,
 				org.scijava.event.DefaultEventHistory.class,
 				org.scijava.input.DefaultInputService.class,
-				org.scijava.io.DefaultDataHandleService.class,
 				org.scijava.io.DefaultIOService.class,
 				org.scijava.io.DefaultRecentFileService.class,
+				org.scijava.io.handle.DefaultDataHandleService.class,
 				org.scijava.io.nio.DefaultNIOService.class,
 				org.scijava.main.DefaultMainService.class,
 				org.scijava.menu.DefaultMenuService.class,
diff --git a/src/test/java/org/scijava/io/handle/DataHandleTest.java b/src/test/java/org/scijava/io/handle/DataHandleTest.java
@@ -29,7 +29,7 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.handle;
 
 import static org.junit.Assert.assertEquals;
 
@@ -41,6 +41,9 @@
 
 import org.junit.Test;
 import org.scijava.Context;
+import org.scijava.io.handle.DataHandle;
+import org.scijava.io.handle.DataHandleService;
+import org.scijava.io.location.Location;
 import org.scijava.util.Bytes;
 
 /**
diff --git a/src/test/java/org/scijava/io/handle/FileHandleTest.java b/src/test/java/org/scijava/io/handle/FileHandleTest.java
@@ -29,12 +29,17 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.handle;
 
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
 
+import org.scijava.io.handle.DataHandle;
+import org.scijava.io.handle.FileHandle;
+import org.scijava.io.location.FileLocation;
+import org.scijava.io.location.Location;
+
 /**
  * Tests {@link FileHandle}.
  *
diff --git a/src/test/java/org/scijava/io/location/BytesLocationTest.java b/src/test/java/org/scijava/io/location/BytesLocationTest.java
@@ -29,12 +29,13 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.location;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertSame;
 
 import org.junit.Test;
+import org.scijava.io.location.BytesLocation;
 
 /**
  * Tests {@link BytesLocation}.
diff --git a/src/test/java/org/scijava/io/location/FileLocationTest.java b/src/test/java/org/scijava/io/location/FileLocationTest.java
@@ -29,13 +29,14 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.location;
 
 import static org.junit.Assert.assertEquals;
 
 import java.io.File;
 
 import org.junit.Test;
+import org.scijava.io.location.FileLocation;
 
 /**
  * Tests {@link FileLocation}.
diff --git a/src/test/java/org/scijava/io/location/URILocationTest.java b/src/test/java/org/scijava/io/location/URILocationTest.java
@@ -29,7 +29,7 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.location;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertSame;
@@ -39,6 +39,7 @@
 import java.util.Map;
 
 import org.junit.Test;
+import org.scijava.io.location.URILocation;
 
 /**
  * Tests {@link URILocation}.
diff --git a/src/test/java/org/scijava/io/location/URLLocationTest.java b/src/test/java/org/scijava/io/location/URLLocationTest.java
@@ -29,14 +29,15 @@
  * #L%
  */
 
-package org.scijava.io;
+package org.scijava.io.location;
 
 import static org.junit.Assert.assertSame;
 
 import java.net.MalformedURLException;
 import java.net.URL;
 
 import org.junit.Test;
+import org.scijava.io.location.URLLocation;
 
 /**
  * Tests {@link URLLocation}.

Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,6 @@`
`40`	`40`	`* Interface for high-level data I/O: opening and saving data.`
`41`	`41`	`*`
`42`	`42`	`* @author Curtis Rueden`
`43`		`- * @see DataHandleService`
`44`		`- * @see Location`
`45`	`43`	`*/`
`46`	`44`	`public interface IOService extends HandlerService<String, IOPlugin<?>>,`
`47`	`45`	`SciJavaService`