5151public interface Neo4JDatabaseManager extends DatabaseManager {
5252
5353 /**
54- * A specialized {@link DatabaseManager
5554 * Executes a custom Cypher query with parameters and returns a stream of {@link CommunicationEntity}.
55+ *
5656 * @param cypher the Cypher query to execute.
5757 * @param parameters the parameters to bind to the query.
58- * @return a stream of {@link CommunicationEntity} matching the query result.
58+ * @return a stream of {@link CommunicationEntity} representing the query result.
59+ * @throws NullPointerException if {@code cypher} or {@code parameters} is null.
5960 */
6061 Stream <CommunicationEntity > executeQuery (String cypher , Map <String , Object > parameters );
6162
@@ -66,18 +67,18 @@ public interface Neo4JDatabaseManager extends DatabaseManager {
6667 * @param relationship the type of relationship to traverse.
6768 * @param depth the traversal depth limit.
6869 * @return a stream of {@link CommunicationEntity} representing related nodes.
69- * @throws NullPointerException if any of the arguments are null.
70+ * @throws NullPointerException if {@code startNodeId}, {@code relationship}, or {@code depth} is null.
7071 */
7172 Stream <CommunicationEntity > traverse (String startNodeId , String relationship , int depth );
7273
7374 /**
74- * Creates a relationship between two {@link CommunicationEntity} nodes.
75+ * Creates a relationship (edge) between two {@link CommunicationEntity} nodes.
7576 *
7677 * @param source the source entity.
7778 * @param target the target entity.
7879 * @param relationshipType the type of relationship to create.
7980 * @throws EdgeCommunicationException if either the source or target entity does not exist in the database.
80- * @throws NullPointerException if any of the arguments are null.
81+ * @throws NullPointerException if {@code source}, {@code target}, or {@code relationshipType} is null.
8182 */
8283 void edge (CommunicationEntity source , String relationshipType , CommunicationEntity target );
8384
@@ -88,7 +89,7 @@ public interface Neo4JDatabaseManager extends DatabaseManager {
8889 * @param target the target entity, which must already exist in the database.
8990 * @param relationshipType the type of relationship to remove.
9091 * @throws EdgeCommunicationException if either the source or target entity does not exist in the database.
91- * @throws NullPointerException if any of the arguments are null.
92+ * @throws NullPointerException if {@code source}, {@code target}, or {@code relationshipType} is null.
9293 */
9394 void remove (CommunicationEntity source , String relationshipType , CommunicationEntity target );
9495}
0 commit comments