Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
  • Loading branch information
otaviojava committed Oct 30, 2022
1 parent 855b01b commit 4e5f9c2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@


/**
* The Jakarta NoSQL communication configuration to create a {@link ColumnFamilyManagerFactory}
* The Jakarta NoSQL configuration to create a {@link ColumnFamilyManagerFactory}
*/
public interface ColumnConfiguration {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ public interface ColumnDeleteQuery {

/**
* getter the condition
* If empty, {@link Optional#empty()} is true, the implementation might either return an unsupported exception or delete same elements in the database.
* If empty, {@link Optional#empty()} is true, the implementation might either return
* an unsupported exception or delete same elements in the database.
*
* @return the condition
*/
Expand All @@ -58,15 +59,16 @@ public interface ColumnDeleteQuery {
/**
* It starts the first step of {@link ColumnDelete} API using a fluent-API way.
* This first step will inform the fields to delete in the query instead of the whole record.
* This behavior might be different for each NoSQL database provider; therefore, it might be ignored for some implementations.
* This behavior might be different for each NoSQL database provider; therefore,
* it might be ignored for some implementations.
*
* @param columns the column fields to delete query
* @return a new {@link ColumnDelete} instance
* @throws NullPointerException when there is a null element
*/
static ColumnDelete delete(String... columns) {
return ServiceLoaderProvider.get(ColumnDeleteProvider.class,
()-> ServiceLoader.load(ColumnDeleteProvider.class))
() -> ServiceLoader.load(ColumnDeleteProvider.class))
.apply(columns);
}

Expand All @@ -78,7 +80,7 @@ static ColumnDelete delete(String... columns) {
*/
static ColumnDelete delete() {
return ServiceLoaderProvider.get(ColumnDeleteProvider.class,
()-> ServiceLoader.load(ColumnDeleteProvider.class))
() -> ServiceLoader.load(ColumnDeleteProvider.class))
.get();
}

Expand All @@ -94,7 +96,7 @@ static ColumnDelete delete() {
*/
static ColumnDeleteQueryBuilder builder(String... documents) {
return ServiceLoaderProvider.get(ColumnDeleteQueryBuilderProvider.class,
()-> ServiceLoader.load(ColumnDeleteQueryBuilderProvider.class))
() -> ServiceLoader.load(ColumnDeleteQueryBuilderProvider.class))
.apply(documents);
}

Expand All @@ -106,7 +108,7 @@ static ColumnDeleteQueryBuilder builder(String... documents) {
*/
static ColumnDeleteQueryBuilder builder() {
return ServiceLoaderProvider.get(ColumnDeleteQueryBuilderProvider.class,
()-> ServiceLoader.load(ColumnDeleteQueryBuilderProvider.class))
() -> ServiceLoader.load(ColumnDeleteQueryBuilderProvider.class))
.get();
}

Expand Down Expand Up @@ -371,7 +373,7 @@ interface ColumnDeleteQueryBuilder {
* executes the {@link ColumnFamilyManager#delete(ColumnDeleteQuery)}
*
* @param manager the entity manager
* @throws NullPointerException when manager is null
* @throws NullPointerException when manager is null
* @throws IllegalStateException It returns a state exception when an element is not valid or not fill-up,
* such as the {@link ColumnDeleteQueryBuilder#from(String)} method was not called.
*/
Expand Down

0 comments on commit 4e5f9c2

Please sign in to comment.