Skip to content

Commit 4faf993

Browse files
committed
feat: enhance documentation
Signed-off-by: Otavio Santana <[email protected]>
1 parent ff0f883 commit 4faf993

File tree

6 files changed

+34
-6
lines changed

6 files changed

+34
-6
lines changed

jnosql-neo4j/src/main/java/org/eclipse/jnosql/databases/neo4j/communication/DefaultNeo4JDatabaseManager.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,10 @@
3535
import java.util.logging.Logger;
3636
import java.util.stream.Stream;
3737

38-
public class DefaultNeo4JDatabaseManager implements Neo4JDatabaseManager {
38+
class DefaultNeo4JDatabaseManager implements Neo4JDatabaseManager {
3939

4040
private static final Logger LOGGER = Logger.getLogger(DefaultNeo4JDatabaseManager.class.getName());
4141
public static final String ID = "_id";
42-
public static final String NEO4J_NATIVE_ID = "nodeId";
4342

4443
private final Session session;
4544
private final String database;

jnosql-neo4j/src/main/java/org/eclipse/jnosql/databases/neo4j/communication/EdgeCommunicationException.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,21 @@
2929
*/
3030
public class EdgeCommunicationException extends Neo4JCommunicationException{
3131

32+
/**
33+
* Constructs a new exception with the specified detail message.
34+
*
35+
* @param message the detail message
36+
*/
3237
public EdgeCommunicationException(String message) {
3338
super(message);
3439
}
3540

41+
/**
42+
* Constructs a new exception with the specified detail message and cause.
43+
*
44+
* @param message the detail message
45+
* @param exception the cause
46+
*/
3647
public EdgeCommunicationException(String message, Throwable exception) {
3748
super(message, exception);
3849
}

jnosql-neo4j/src/main/java/org/eclipse/jnosql/databases/neo4j/communication/Neo4JCommunicationException.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,21 @@
3232
*/
3333
public class Neo4JCommunicationException extends CommunicationException {
3434

35+
/**
36+
* Constructs a new exception with the specified detail message.
37+
*
38+
* @param message the detail message
39+
*/
3540
public Neo4JCommunicationException(String message) {
3641
super(message);
3742
}
3843

44+
/**
45+
* Constructs a new exception with the specified detail message and cause.
46+
*
47+
* @param message the detail message
48+
* @param exception the cause
49+
*/
3950
public Neo4JCommunicationException(String message, Throwable exception) {
4051
super(message, exception);
4152
}

jnosql-neo4j/src/main/java/org/eclipse/jnosql/databases/neo4j/communication/Neo4JConfiguration.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,12 @@ public final class Neo4JConfiguration implements DatabaseConfiguration {
5353

5454
private static final String DEFAULT_BOLT = "bolt://localhost:7687";
5555

56+
/**
57+
* Applies the provided settings to the Neo4j database configuration.
58+
*
59+
* @param settings the settings to apply
60+
* @return a new {@link Neo4JDatabaseManagerFactory} instance
61+
*/
5662
@Override
5763
public Neo4JDatabaseManagerFactory apply(Settings settings) {
5864
var uri = settings.getOrDefault(Neo4JConfigurations.URI, DEFAULT_BOLT);

jnosql-neo4j/src/main/java/org/eclipse/jnosql/databases/neo4j/communication/Neo4JQueryBuilder.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,14 @@
2828
import java.util.List;
2929
import java.util.Map;
3030
import java.util.stream.Collectors;
31-
public enum Neo4JQueryBuilder {
31+
32+
enum Neo4JQueryBuilder {
3233

3334
INSTANCE;
3435

3536
private static final String INTERNAL_ID = "_id";
3637

37-
public String buildQuery(DeleteQuery query, Map<String, Object> parameters) {
38+
String buildQuery(DeleteQuery query, Map<String, Object> parameters) {
3839
StringBuilder cypher = new StringBuilder("MATCH (e:");
3940
cypher.append(query.name()).append(")");
4041

@@ -57,7 +58,7 @@ public String buildQuery(DeleteQuery query, Map<String, Object> parameters) {
5758
return cypher.toString();
5859
}
5960

60-
public String buildQuery(SelectQuery query, Map<String, Object> parameters) {
61+
String buildQuery(SelectQuery query, Map<String, Object> parameters) {
6162
StringBuilder cypher = new StringBuilder("MATCH (e:");
6263
cypher.append(query.name()).append(")");
6364

jnosql-neo4j/src/main/java/org/eclipse/jnosql/databases/neo4j/mapping/DefaultNeo4JTemplate.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
@ApplicationScoped
3838
@Typed(Neo4JTemplate.class)
39-
public class DefaultNeo4JTemplate extends AbstractSemiStructuredTemplate implements Neo4JTemplate {
39+
class DefaultNeo4JTemplate extends AbstractSemiStructuredTemplate implements Neo4JTemplate {
4040

4141
private static final Logger LOGGER = Logger.getLogger(DefaultNeo4JTemplate.class.getName());
4242

0 commit comments

Comments
 (0)