From aac1631813c4f0a2cce9beaebb8bddcdb3f5771b Mon Sep 17 00:00:00 2001 From: Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com> Date: Sat, 13 Jun 2015 17:28:10 -0400 Subject: [PATCH] Added some additional comments to the project. --- .../maven/plugins/mongodb/StartMongoMojo.java | 24 +++++++++++++++++++ .../maven/plugins/mongodb/StopMongoMojo.java | 1 + 2 files changed, 25 insertions(+) diff --git a/src/main/java/com/syncleus/maven/plugins/mongodb/StartMongoMojo.java b/src/main/java/com/syncleus/maven/plugins/mongodb/StartMongoMojo.java index cc59a57..54510e1 100644 --- a/src/main/java/com/syncleus/maven/plugins/mongodb/StartMongoMojo.java +++ b/src/main/java/com/syncleus/maven/plugins/mongodb/StartMongoMojo.java @@ -258,23 +258,47 @@ public class StartMongoMojo extends AbstractMongoMojo { @Parameter private String[] features; + /** + * A list of imports to be performed. + * + * @since 1.0.0 + */ @Parameter private ImportDataConfig[] imports; + /** + * Default database to use when importing. + * + * @since 1.0.0 + */ @Parameter(property = "mongodb.defaultImportDatabase") private String defaultImportDatabase; + /** + * Specifies whether import operations should be forked in parallel or done sequentially. + * + * @since 1.0.0 + */ @Parameter(property = "mongodb.parallel", defaultValue = "false") private boolean parallelImport; + /** + * A collection of initialization scripts to be run across the databases. + * + * @since 1.0.0 + */ @Parameter private InitializerConfig[] initalizations; + /** + * Not a mojo configuration parameter, this is used internally. + */ private Integer setPort = null; public StartMongoMojo() { } + // this constructor is only used for unit testing purposes. StartMongoMojo(int port, boolean randomPort, String version, diff --git a/src/main/java/com/syncleus/maven/plugins/mongodb/StopMongoMojo.java b/src/main/java/com/syncleus/maven/plugins/mongodb/StopMongoMojo.java index a01d427..f6c1b48 100644 --- a/src/main/java/com/syncleus/maven/plugins/mongodb/StopMongoMojo.java +++ b/src/main/java/com/syncleus/maven/plugins/mongodb/StopMongoMojo.java @@ -44,6 +44,7 @@ public class StopMongoMojo extends AbstractMongoMojo { super(); } + //This constructor is only present for unit testing purposes. StopMongoMojo(boolean skip) { super(skip); } -- GitLab