Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yNiklas authored Jan 1, 2022
1 parent 5a19683 commit c7e2c66
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Mongirl💾- The Java-Object storing for MongoDB
Mongirl stores Java objects to MongoDBs.
Mongirl stores Java objects annotation-based to MongoDBs, so you never need to write codecs again.
> Take a look at this example:
```java
@Store(collection = "myMongoCollection")
Expand Down Expand Up @@ -117,6 +117,12 @@ Decodes all objects stored in the MongoDB from the collection named in the annot
Returns them in a `List`.

## Important notes
### Constructors
+ Every class from which objects should be stored **must** have a public constructor. It does not matter whether it's a default constructor or some with parameters. Without, Mongirl cannot instantiate this class objects on decode operations.

### Arrays
+ Currently, only one-dimensional Arrays are supported

### Interfaces implementations
+ ```addClasspath``` is an optional attribute for ```@Store``` for classes implementing an Interface or subclasses. It avoids issues on decoding to these classes.
+ By v1.12 - Mongirl will automatically annotate interface implementations and subclasses
Expand Down

0 comments on commit c7e2c66

Please sign in to comment.