Added type parameter for Resource base interface.

rickbw · rickbw · commit b3f925964b86 · 2015-06-15T14:15:52.000-07:00
Allows ResourceSet base interface to be type-safe, and captures parallelism between ReadableResource and WritableResource.

Also renamed a corresponding ResourceSet.Id property for consistency.
diff --git a/src/main/java/crud/core/ReadableResource.java b/src/main/java/crud/core/ReadableResource.java
@@ -32,7 +32,7 @@
  *
  * @author Rick Warren
  */
-public interface ReadableResource<RSRC> extends Resource {
+public interface ReadableResource<RSRC> extends Resource<RSRC> {
 
     /**
      * Request the value(s) of this resource. Zero or more values will be
diff --git a/src/main/java/crud/core/ReadableResourceSet.java b/src/main/java/crud/core/ReadableResourceSet.java
@@ -63,7 +63,7 @@ public String toString() {
             return ReadableResourceSet.class.getSimpleName()
                     + '.' + getClass().getSimpleName() + "(\""
                     + getName() + "\", "
-                    + getKeyType().getName() + " -> " + getElementType().getName()
+                    + getKeyType().getName() + " -> " + getResourceType().getName()
                     + ')';
         }
     }
diff --git a/src/main/java/crud/core/Resource.java b/src/main/java/crud/core/Resource.java
@@ -35,8 +35,10 @@
  * or "unknown because of error", may further be expressed with by the
  * declaration idiom {@code Observable<Void>}.
  *
+ * @param <RSRC>    The type of the resource's value(s).
+ *
  * @author Rick Warren
  */
-public interface Resource extends AsyncCloseable {
+public interface Resource<RSRC> extends AsyncCloseable {
     // empty
 }
diff --git a/src/main/java/crud/core/ResourceSet.java b/src/main/java/crud/core/ResourceSet.java
@@ -50,7 +50,7 @@ public interface ResourceSet<KEY, RSRC> {
      *              obtained from a {@link DataBus} compatible with this
      *              {@link WritableResourceSet}.
      */
-    public abstract @Nonnull Resource get(@Nonnull KEY key, @Nonnull Session session);
+    public abstract @Nonnull Resource<RSRC> get(@Nonnull KEY key, @Nonnull Session session);
 
 
     /**
@@ -65,15 +65,15 @@ public interface ResourceSet<KEY, RSRC> {
     public static abstract class Id<KEY, RSRC> {
         private @Nonnull final String name;
         private @Nonnull final Class<KEY> keyType;
-        private @Nonnull final Class<RSRC> elementType;
+        private @Nonnull final Class<RSRC> resourceType;
 
         protected Id(
                 @Nonnull final String name,
                 @Nonnull final Class<KEY> keyType,
-                @Nonnull final Class<RSRC> type) {
+                @Nonnull final Class<RSRC> resourceType) {
             this.name = Objects.requireNonNull(name);
             this.keyType = Objects.requireNonNull(keyType);
-            this.elementType = Objects.requireNonNull(type);
+            this.resourceType = Objects.requireNonNull(resourceType);
         }
 
         public final @Nonnull String getName() {
@@ -84,8 +84,8 @@ protected Id(
             return this.keyType;
         }
 
-        public final @Nonnull Class<RSRC> getElementType() {
-            return this.elementType;
+        public final @Nonnull Class<RSRC> getResourceType() {
+            return this.resourceType;
         }
 
         @Override
@@ -106,7 +106,7 @@ public boolean equals(final Object obj) {
             if (this.keyType != other.keyType) {
                 return false;
             }
-            if (this.elementType != other.elementType) {
+            if (this.resourceType != other.resourceType) {
                 return false;
             }
             return true;
@@ -118,7 +118,7 @@ public int hashCode() {
             int result = 1;
             result = prime * result + this.name.hashCode();
             result = prime * result + this.keyType.hashCode();
-            result = prime * result + this.elementType.hashCode();
+            result = prime * result + this.resourceType.hashCode();
             return result;
         }
     }
diff --git a/src/main/java/crud/core/WritableResource.java b/src/main/java/crud/core/WritableResource.java
@@ -31,7 +31,7 @@
  *
  * @author Rick Warren
  */
-public interface WritableResource<RSRC, RESPONSE> extends Resource {
+public interface WritableResource<RSRC, RESPONSE> extends Resource<RSRC> {
 
     /**
      * Replace or update the value of the resource with the given value. It is
diff --git a/src/main/java/crud/core/WritableResourceSet.java b/src/main/java/crud/core/WritableResourceSet.java
@@ -80,7 +80,7 @@ public String toString() {
             return WritableResourceSet.class.getSimpleName()
                     + '.' + getClass().getSimpleName() + "(\""
                     + getName() + "\", "
-                    + getKeyType().getName() + " -> " + getElementType().getName()
+                    + getKeyType().getName() + " -> " + getResourceType().getName()
                     + " -> " + this.writeResultType.getName()
                     + ')';
         }
diff --git a/src/main/java/crud/file/FileSystem.java b/src/main/java/crud/file/FileSystem.java
@@ -51,7 +51,7 @@ protected Session doStartOrderedSession() throws Exception {
     @Override
     protected boolean isResourceSetAvailable(final ReadableResourceSet.Id<?, ?> id) {
         return File.class == id.getKeyType()
-            && String.class == id.getElementType();
+            && String.class == id.getResourceType();
     }
 
     @SuppressWarnings({ "rawtypes", "unchecked" }) // checked by isResourceSetAvailable()
@@ -63,7 +63,7 @@ protected ReadableResourceSet resolveResourceSet(final ReadableResourceSet.Id id
     @Override
     protected boolean isResourceSetAvailable(final WritableResourceSet.Id<?, ?, ?> id) {
         return WriteRequest.class == id.getKeyType()
-            && String.class == id.getElementType()
+            && String.class == id.getResourceType()
             && Void.class == id.getWriteResultType();
     }
 
diff --git a/src/main/java/crud/implementer/AbstractReadableResource.java b/src/main/java/crud/implementer/AbstractReadableResource.java
@@ -23,7 +23,7 @@
 
 
 public abstract class AbstractReadableResource<RSRC>
-extends AbstractSessionParticipant
+extends AbstractResource<RSRC>
 implements ReadableResource<RSRC> {
 
     @Override
diff --git a/src/main/java/crud/implementer/AbstractResource.java b/src/main/java/crud/implementer/AbstractResource.java
@@ -18,9 +18,9 @@
 
 import javax.annotation.Nonnull;
 
-import crud.core.AsyncCloseable;
-import crud.core.WritableResource;
 import crud.core.ReadableResource;
+import crud.core.Resource;
+import crud.core.WritableResource;
 import rx.Observable;
 import rx.Observer;
 import rx.Subscriber;
@@ -31,7 +31,7 @@
  *
  * @author Rick Warren
  */
-public abstract class AbstractSessionParticipant implements AsyncCloseable {
+public abstract class AbstractResource<RSRC> implements Resource<RSRC> {
 
     private @Nonnull final SessionWorker worker;
 
@@ -50,7 +50,7 @@ public void call(final Subscriber<? super Void> sub) throws Exception {
         });
     }
 
-    protected AbstractSessionParticipant(@Nonnull final SessionWorker worker) {
+    protected AbstractResource(@Nonnull final SessionWorker worker) {
         this.worker = Objects.requireNonNull(worker);
     }
 
diff --git a/src/main/java/crud/implementer/AbstractWritableResource.java b/src/main/java/crud/implementer/AbstractWritableResource.java
@@ -23,7 +23,7 @@
 
 
 public abstract class AbstractWritableResource<RSRC, RESPONSE>
-extends AbstractSessionParticipant
+extends AbstractResource<RSRC>
 implements WritableResource<RSRC, RESPONSE> {
 
     /**
diff --git a/src/main/java/crud/jdbc/JdbcDataBus.java b/src/main/java/crud/jdbc/JdbcDataBus.java
@@ -99,8 +99,8 @@ protected boolean isResourceSetAvailable(final ReadableResourceSet.Id<?, ?> id)
             log.warn("JDBC ResourceSets have key type StatementTemplate, not {}", id.getKeyType().getName());
             return false;
         }
-        if (ResultSetRow.class != id.getElementType()) {
-            log.warn("JDBC readable ResourceSets have element type ResultSetRow, not {}", id.getElementType().getName());
+        if (ResultSetRow.class != id.getResourceType()) {
+            log.warn("JDBC readable ResourceSets have element type ResultSetRow, not {}", id.getResourceType().getName());
             return false;
         }
         return true;
@@ -119,8 +119,8 @@ protected boolean isResourceSetAvailable(final WritableResourceSet.Id<?, ?, ?> i
             log.warn("JDBC ResourceSets have key type StatementTemplate, not {}", id.getKeyType().getName());
             return false;
         }
-        if (StatementParameters.class != id.getElementType()) {
-            log.warn("JDBC writable ResourceSets have element type StatementParameters, not {}", id.getElementType().getName());
+        if (StatementParameters.class != id.getResourceType()) {
+            log.warn("JDBC writable ResourceSets have element type StatementParameters, not {}", id.getResourceType().getName());
             return false;
         }
         if (Integer.class != id.getWriteResultType()) {
diff --git a/src/main/java/crud/jdbc/QueryResource.java b/src/main/java/crud/jdbc/QueryResource.java
@@ -27,7 +27,9 @@
 import rx.Subscriber;
 
 
-/*package*/ final class QueryResource extends StatementProvider implements ReadableResource<ResultSetRow> {
+/*package*/ final class QueryResource
+extends StatementProvider<ResultSetRow>
+implements ReadableResource<ResultSetRow> {
 
     public QueryResource(
             @Nonnull final Connection connection,
diff --git a/src/main/java/crud/jdbc/StatementProvider.java b/src/main/java/crud/jdbc/StatementProvider.java
@@ -22,11 +22,11 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
-import crud.implementer.AbstractSessionParticipant;
+import crud.implementer.AbstractResource;
 import crud.implementer.SessionWorker;
 
 
-/*package*/ class StatementProvider extends AbstractSessionParticipant {
+/*package*/ class StatementProvider<RSRC> extends AbstractResource<RSRC> {
 
     private @Nonnull final Connection connection;
     private @Nonnull final StatementTemplate statementTemplate;
diff --git a/src/main/java/crud/jdbc/UpdateResource.java b/src/main/java/crud/jdbc/UpdateResource.java
@@ -27,7 +27,7 @@
 
 
 /*package*/ final class UpdateResource
-extends StatementProvider
+extends StatementProvider<StatementParameters>
 implements WritableResource<StatementParameters, Integer> {
 
     public UpdateResource(
diff --git a/src/main/java/crud/jms/JmsDataBus.java b/src/main/java/crud/jms/JmsDataBus.java
@@ -197,8 +197,8 @@ private static boolean keyAndElementTypesAcceptable(final ResourceSet.Id<?, ?> i
             log.warn("JMS ResourceSets have key type String, not {}", id.getKeyType().getName());
             return false;
         }
-        if (!Message.class.isAssignableFrom(id.getElementType())) {
-            log.warn("JMS ResourceSets have element type Message, not {}", id.getElementType().getName());
+        if (!Message.class.isAssignableFrom(id.getResourceType())) {
+            log.warn("JMS ResourceSets have element type Message, not {}", id.getResourceType().getName());
             return false;
         }
         return true;
diff --git a/src/main/java/crud/jms/MessageConsumingResourceSet.java b/src/main/java/crud/jms/MessageConsumingResourceSet.java
@@ -50,7 +50,7 @@ public ReadableResource<M> get(final String key, final Session session) {
             final MessageConsumer messageConsumer = key.isEmpty()
                     ? realSession.createConsumer(this.destination)
                     : realSession.createConsumer(this.destination, key);
-            return new MessageConsumerResource<>(sessionImpl.getWorker(), messageConsumer, this.id.getElementType());
+            return new MessageConsumerResource<>(sessionImpl.getWorker(), messageConsumer, this.id.getResourceType());
         } catch (final JMSException jx) {
             throw new MiddlewareException(jx.getMessage(), jx);
         }
diff --git a/src/main/java/crud/sync/SyncReadableResource.java b/src/main/java/crud/sync/SyncReadableResource.java
@@ -24,7 +24,7 @@
  *
  * @author Rick Warren
  */
-public class SyncReadableResource<RSRC> extends SyncResource<ReadableResource<RSRC>> {
+public class SyncReadableResource<RSRC> extends SyncResource<RSRC, ReadableResource<RSRC>> {
 
     public SyncReadableResource(@Nonnull final ReadableResource<RSRC> delegate) {
         super(delegate);
diff --git a/src/main/java/crud/sync/SyncResource.java b/src/main/java/crud/sync/SyncResource.java
@@ -18,7 +18,7 @@
 import crud.implementer.AsyncResults;
 
 
-public abstract class SyncResource<D extends Resource>
+public abstract class SyncResource<RSRC, D extends Resource<RSRC>>
 extends SyncDelegateHolder<D>
 implements AutoCloseable {
 
diff --git a/src/main/java/crud/sync/SyncResourceSet.java b/src/main/java/crud/sync/SyncResourceSet.java
@@ -29,7 +29,7 @@ public abstract class SyncResourceSet<KEY, RSRC, D extends ResourceSet<KEY, RSRC
     /**
      * @see ResourceSet#get(Object, Session)
      */
-    public abstract @Nonnull SyncResource<?> get(
+    public abstract @Nonnull SyncResource<RSRC, ?> get(
             @Nonnull final KEY key,
             @Nonnull final SyncSession session);
 
diff --git a/src/main/java/crud/sync/SyncWritableResource.java b/src/main/java/crud/sync/SyncWritableResource.java
@@ -25,7 +25,7 @@
  * @author Rick Warren
  */
 public class SyncWritableResource<RSRC, RESPONSE>
-extends SyncResource<WritableResource<RSRC, RESPONSE>> {
+extends SyncResource<RSRC, WritableResource<RSRC, RESPONSE>> {
 
     public SyncWritableResource(@Nonnull final WritableResource<RSRC, RESPONSE> delegate) {
         super(delegate);
diff --git a/src/main/java/crud/transform/TransformedResourceStateMixin.java b/src/main/java/crud/transform/TransformedResourceStateMixin.java
@@ -24,7 +24,7 @@
  * Maintains state on behalf of the {@code Transformed*Resource} classes in this
  * package, in order to minimize repeated boilerplate code.
  */
-/*package*/ final class TransformedResourceStateMixin<R extends Resource, T> {
+/*package*/ final class TransformedResourceStateMixin<R extends Resource<?>, T> {
 
     private final R delegate;
     private final T auxiliaryState;
diff --git a/src/test/java/crud/core/example/ExampleDataBus.java b/src/test/java/crud/core/example/ExampleDataBus.java
@@ -41,7 +41,7 @@ protected Session doStartOrderedSession() {
 
     @Override
     protected boolean isResourceSetAvailable(final ReadableResourceSet.Id<?, ?> id) {
-        return id.getKeyType() == id.getElementType();
+        return id.getKeyType() == id.getResourceType();
     }
 
     @Override
@@ -55,7 +55,7 @@ protected boolean isResourceSetAvailable(final ReadableResourceSet.Id<?, ?> id)
     @Override
     protected boolean isResourceSetAvailable(final WritableResourceSet.Id<?, ?, ?> id) {
         return Writer.class.isAssignableFrom(id.getKeyType())
-            && String.class.isAssignableFrom(id.getElementType())
+            && String.class.isAssignableFrom(id.getResourceType())
             && id.getWriteResultType().isAssignableFrom(Integer.class);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`*`
`33`	`33`	`* @author Rick Warren`
`34`	`34`	`*/`
`35`		`-public interface ReadableResource<RSRC> extends Resource {`
	`35`	`+public interface ReadableResource<RSRC> extends Resource<RSRC> {`
`36`	`36`
`37`	`37`	`/**`
`38`	`38`	`* Request the value(s) of this resource. Zero or more values will be`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public String toString() {`
`63`	`63`	`return ReadableResourceSet.class.getSimpleName()`
`64`	`64`	`+ '.' + getClass().getSimpleName() + "(\""`
`65`	`65`	`+ getName() + "\", "`
`66`		`- + getKeyType().getName() + " -> " + getElementType().getName()`
	`66`	`+ + getKeyType().getName() + " -> " + getResourceType().getName()`
`67`	`67`	`+ ')';`
`68`	`68`	`}`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,10 @@`
`35`	`35`	`* or "unknown because of error", may further be expressed with by the`
`36`	`36`	`* declaration idiom {@code Observable<Void>}.`
`37`	`37`	`*`
	`38`	`+ * @param <RSRC> The type of the resource's value(s).`
	`39`	`+ *`
`38`	`40`	`* @author Rick Warren`
`39`	`41`	`*/`
`40`		`-public interface Resource extends AsyncCloseable {`
	`42`	`+public interface Resource<RSRC> extends AsyncCloseable {`
`41`	`43`	`// empty`
`42`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`*`
`32`	`32`	`* @author Rick Warren`
`33`	`33`	`*/`
`34`		`-public interface WritableResource<RSRC, RESPONSE> extends Resource {`
	`34`	`+public interface WritableResource<RSRC, RESPONSE> extends Resource<RSRC> {`
`35`	`35`
`36`	`36`	`/**`
`37`	`37`	`* Replace or update the value of the resource with the given value. It is`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ public String toString() {`
`80`	`80`	`return WritableResourceSet.class.getSimpleName()`
`81`	`81`	`+ '.' + getClass().getSimpleName() + "(\""`
`82`	`82`	`+ getName() + "\", "`
`83`		`- + getKeyType().getName() + " -> " + getElementType().getName()`
	`83`	`+ + getKeyType().getName() + " -> " + getResourceType().getName()`
`84`	`84`	`+ " -> " + this.writeResultType.getName()`
`85`	`85`	`+ ')';`
`86`	`86`	`}`