Skip to content

Commit 065a603

Browse files
committed
MERGE PREP: Renamed "crud" base package to "crud.core".
1 parent 843df68 commit 065a603

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+119
-122
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ This project takes its name from the acronym Create/Read/Update/Delete. It provi
66
The Crud API supports data-oriented interactions based on generic _Resources_, which encapsulate state and build upon the [Observable](https://github.com/Netflix/RxJava/blob/master/rxjava-core/src/main/java/rx/Observable.java) abstraction from [RxJava](https://github.com/Netflix/RxJava/). The design emphasizes generality, safety and concurrency.
77

88
* _Generality_: The available interactions consist of the conventional “CRUD”: Create, Read, Update, and Delete. These have an HTTP-like flare—set (i.e. PUT), get, update (i.e. POST), delete—though the types in this package do _not_ depend on HTTP as an implementation technology. These operations should also be familiar to anyone who has worked with other data-oriented APIs, such as SQL/JDBC.
9-
* _Safety_: The types of resources are statically type-safe, configured by means of generic type parameters. And because not all resources support all operations, the operations are composable, defined in separate interfaces designed to work together. For example, a resource that supports reading and writing, but not deletion, would implement [ReadableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/ReadableResource.java) and [WritableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/WritableResource.java) but not [DeletableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/DeletableResource.java).
9+
* _Safety_: The types of resources are statically type-safe, configured by means of generic type parameters. And because not all resources support all operations, the operations are composable, defined in separate interfaces designed to work together. For example, a resource that supports reading and writing, but not deletion, would implement [ReadableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/ReadableResource.java) and [WritableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/WritableResource.java) but not [DeletableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/DeletableResource.java).
1010
* _Concurrency_: The API encourages asynchronous implementations. It encapsulates asynchrony using RxJava’s `Observable` class. This encapsulation means that applications can work with asynchronous implementations just as easily as synchronous ones, and cross-cutting behaviors like retries can be transparently composed as needed.
1111

1212

1313
API Overview
1414
------------
15-
There are two primary abstractions in the API: `Resources` and `ResourceProviders`. The former encapsulate the I/O operations on state, and hence uses a reactive style. There are four interfaces derived from [Resource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/Resource.java), one for each CRUD operation:
16-
* [ReadableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/ReadableResource.java)
17-
* [WritableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/WritableResource.java)
18-
* [UpdatableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/UpdatableResource.java)
19-
* [DeletableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/DeletableResource.java)
20-
21-
The latter abstraction, `ResourceProvider`, provides local (i.e. assumed-cheap) navigation among `Resources`. This navigation uses a key-value lookup idiom, where keys are generic and may be simple—e.g. a URL—or arbitrarily complex—e.g. a database query—depending on the underlying data-access technology. There are four derived [ResourceProvider](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/ResourceProvider.java) interfaces:
22-
* [ReadableResourceProvider](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/ReadableResourceProvider.java)
23-
* [WritableResourceProvider](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/WritableResourceProvider.java)
24-
* [UpdatableResourceProvider](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/UpdatableResourceProvider.java)
25-
* [DeletableResourceProvider](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/DeletableResourceProvider.java)
15+
There are two primary abstractions in the API: `Resources` and `ResourceProviders`. The former encapsulate the I/O operations on state, and hence uses a reactive style. There are four interfaces derived from [Resource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/Resource.java), one for each CRUD operation:
16+
* [ReadableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/ReadableResource.java)
17+
* [WritableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/WritableResource.java)
18+
* [UpdatableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/UpdatableResource.java)
19+
* [DeletableResource](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/DeletableResource.java)
20+
21+
The latter abstraction, `ResourceProvider`, provides local (i.e. assumed-cheap) navigation among `Resources`. This navigation uses a key-value lookup idiom, where keys are generic and may be simple—e.g. a URL—or arbitrarily complex—e.g. a database query—depending on the underlying data-access technology. There are four derived [ResourceProvider](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/ResourceProvider.java) interfaces:
22+
* [ReadableResourceProvider](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/ReadableResourceProvider.java)
23+
* [WritableResourceProvider](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/WritableResourceProvider.java)
24+
* [UpdatableResourceProvider](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/UpdatableResourceProvider.java)
25+
* [DeletableResourceProvider](https://github.com/rickbw/crud-api/blob/master/src/main/java/rickbw/crud/core/DeletableResourceProvider.java)
2626

2727
In addition to these core abstractions, this library provides a number of
2828
utilities of two kinds in corresponding packages:

src/main/java/crud/DeletableResource.java renamed to src/main/java/crud/core/DeletableResource.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
* License for the specific language governing permissions and limitations under
1313
* the License.
1414
*/
15-
16-
package crud;
15+
package crud.core;
1716

1817
import rx.Observable;
1918

src/main/java/crud/DeletableResourceProvider.java renamed to src/main/java/crud/core/DeletableResourceProvider.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
* License for the specific language governing permissions and limitations under
1313
* the License.
1414
*/
15-
16-
package crud;
15+
package crud.core;
1716

1817

1918
/**

src/main/java/crud/ReadableResource.java renamed to src/main/java/crud/core/ReadableResource.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
* License for the specific language governing permissions and limitations under
1313
* the License.
1414
*/
15-
16-
package crud;
15+
package crud.core;
1716

1817
import rx.Observable;
1918

src/main/java/crud/ReadableResourceProvider.java renamed to src/main/java/crud/core/ReadableResourceProvider.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
* License for the specific language governing permissions and limitations under
1313
* the License.
1414
*/
15-
16-
package crud;
15+
package crud.core;
1716

1817

1918
/**

src/main/java/crud/Resource.java renamed to src/main/java/crud/core/Resource.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
* License for the specific language governing permissions and limitations under
1313
* the License.
1414
*/
15-
16-
package crud;
15+
package crud.core;
1716

1817
import rx.Observable;
1918
import rx.Observer;

src/main/java/crud/ResourceProvider.java renamed to src/main/java/crud/core/ResourceProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* License for the specific language governing permissions and limitations under
1313
* the License.
1414
*/
15-
package crud;
15+
package crud.core;
1616

1717

1818
/**

src/main/java/crud/UpdatableResource.java renamed to src/main/java/crud/core/UpdatableResource.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
* License for the specific language governing permissions and limitations under
1313
* the License.
1414
*/
15-
16-
package crud;
15+
package crud.core;
1716

1817
import rx.Observable;
1918

src/main/java/crud/UpdatableResourceProvider.java renamed to src/main/java/crud/core/UpdatableResourceProvider.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
* License for the specific language governing permissions and limitations under
1313
* the License.
1414
*/
15-
16-
package crud;
15+
package crud.core;
1716

1817

1918
/**

src/main/java/crud/WritableResource.java renamed to src/main/java/crud/core/WritableResource.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
* License for the specific language governing permissions and limitations under
1313
* the License.
1414
*/
15-
16-
package crud;
15+
package crud.core;
1716

1817
import rx.Observable;
1918

0 commit comments

Comments
 (0)