From b7c27191c36f162c3958dc4de383d50122348dff Mon Sep 17 00:00:00 2001 From: Robert Merget Date: Thu, 19 Jun 2025 10:22:36 +0000 Subject: [PATCH 1/2] Add Javadoc to RabbitMqDelegate public methods Document all getters and setters with appropriate Javadoc comments including method descriptions, parameters, and return values. --- .../config/delegate/RabbitMqDelegate.java | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/src/main/java/de/rub/nds/crawler/config/delegate/RabbitMqDelegate.java b/src/main/java/de/rub/nds/crawler/config/delegate/RabbitMqDelegate.java index 9d89180..39cf21d 100644 --- a/src/main/java/de/rub/nds/crawler/config/delegate/RabbitMqDelegate.java +++ b/src/main/java/de/rub/nds/crawler/config/delegate/RabbitMqDelegate.java @@ -30,50 +30,110 @@ public class RabbitMqDelegate { @Parameter(names = "-rabbitMqTLS") private boolean rabbitMqTLS; + /** + * Returns the RabbitMQ host. + * + * @return the RabbitMQ host + */ public String getRabbitMqHost() { return rabbitMqHost; } + /** + * Returns the RabbitMQ port. + * + * @return the RabbitMQ port + */ public int getRabbitMqPort() { return rabbitMqPort; } + /** + * Returns the RabbitMQ user. + * + * @return the RabbitMQ user + */ public String getRabbitMqUser() { return rabbitMqUser; } + /** + * Returns the RabbitMQ password. + * + * @return the RabbitMQ password + */ public String getRabbitMqPass() { return rabbitMqPass; } + /** + * Returns the RabbitMQ password file path. + * + * @return the RabbitMQ password file path + */ public String getRabbitMqPassFile() { return rabbitMqPassFile; } + /** + * Returns whether RabbitMQ TLS is enabled. + * + * @return true if RabbitMQ TLS is enabled, false otherwise + */ public boolean isRabbitMqTLS() { return rabbitMqTLS; } + /** + * Sets the RabbitMQ host. + * + * @param rabbitMqHost the RabbitMQ host to set + */ public void setRabbitMqHost(String rabbitMqHost) { this.rabbitMqHost = rabbitMqHost; } + /** + * Sets the RabbitMQ port. + * + * @param rabbitMqPort the RabbitMQ port to set + */ public void setRabbitMqPort(int rabbitMqPort) { this.rabbitMqPort = rabbitMqPort; } + /** + * Sets the RabbitMQ user. + * + * @param rabbitMqUser the RabbitMQ user to set + */ public void setRabbitMqUser(String rabbitMqUser) { this.rabbitMqUser = rabbitMqUser; } + /** + * Sets the RabbitMQ password. + * + * @param rabbitMqPass the RabbitMQ password to set + */ public void setRabbitMqPass(String rabbitMqPass) { this.rabbitMqPass = rabbitMqPass; } + /** + * Sets the RabbitMQ password file path. + * + * @param rabbitMqPassFile the RabbitMQ password file path to set + */ public void setRabbitMqPassFile(String rabbitMqPassFile) { this.rabbitMqPassFile = rabbitMqPassFile; } + /** + * Sets whether RabbitMQ TLS is enabled. + * + * @param rabbitMqTLS true to enable RabbitMQ TLS, false otherwise + */ public void setRabbitMqTLS(boolean rabbitMqTLS) { this.rabbitMqTLS = rabbitMqTLS; } From ce8011bd7f2e79145c40572777576e5c8314b8c1 Mon Sep 17 00:00:00 2001 From: Robert Merget Date: Thu, 19 Jun 2025 10:23:28 +0000 Subject: [PATCH 2/2] Add Javadoc to MongoDbDelegate public methods Document all getters and setters with appropriate Javadoc comments including method descriptions, parameters, and return values. --- .../config/delegate/MongoDbDelegate.java | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/src/main/java/de/rub/nds/crawler/config/delegate/MongoDbDelegate.java b/src/main/java/de/rub/nds/crawler/config/delegate/MongoDbDelegate.java index 3cfd571..47acd3a 100644 --- a/src/main/java/de/rub/nds/crawler/config/delegate/MongoDbDelegate.java +++ b/src/main/java/de/rub/nds/crawler/config/delegate/MongoDbDelegate.java @@ -42,50 +42,110 @@ public class MongoDbDelegate { description = "The DB within the MongoDB instance, in which the user:pass is defined.") private String mongoDbAuthSource; + /** + * Returns the MongoDB host. + * + * @return the MongoDB host + */ public String getMongoDbHost() { return mongoDbHost; } + /** + * Returns the MongoDB port. + * + * @return the MongoDB port + */ public int getMongoDbPort() { return mongoDbPort; } + /** + * Returns the MongoDB user. + * + * @return the MongoDB user + */ public String getMongoDbUser() { return mongoDbUser; } + /** + * Returns the MongoDB password. + * + * @return the MongoDB password + */ public String getMongoDbPass() { return mongoDbPass; } + /** + * Returns the MongoDB password file path. + * + * @return the MongoDB password file path + */ public String getMongoDbPassFile() { return mongoDbPassFile; } + /** + * Returns the MongoDB authentication source database. + * + * @return the MongoDB authentication source database + */ public String getMongoDbAuthSource() { return mongoDbAuthSource; } + /** + * Sets the MongoDB host. + * + * @param mongoDbHost the MongoDB host to set + */ public void setMongoDbHost(String mongoDbHost) { this.mongoDbHost = mongoDbHost; } + /** + * Sets the MongoDB port. + * + * @param mongoDbPort the MongoDB port to set + */ public void setMongoDbPort(int mongoDbPort) { this.mongoDbPort = mongoDbPort; } + /** + * Sets the MongoDB user. + * + * @param mongoDbUser the MongoDB user to set + */ public void setMongoDbUser(String mongoDbUser) { this.mongoDbUser = mongoDbUser; } + /** + * Sets the MongoDB password. + * + * @param mongoDbPass the MongoDB password to set + */ public void setMongoDbPass(String mongoDbPass) { this.mongoDbPass = mongoDbPass; } + /** + * Sets the MongoDB password file path. + * + * @param mongoDbPassFile the MongoDB password file path to set + */ public void setMongoDbPassFile(String mongoDbPassFile) { this.mongoDbPassFile = mongoDbPassFile; } + /** + * Sets the MongoDB authentication source database. + * + * @param mongoDbAuthSource the MongoDB authentication source database to set + */ public void setMongoDbAuthSource(String mongoDbAuthSource) { this.mongoDbAuthSource = mongoDbAuthSource; }