Fix javadoc warnings

testcontainers · Jul 19, 2023 · 64ca9c8 · 64ca9c8
1 parent 4059d04
commit 64ca9c8
Show file tree

Hide file tree

Showing 27 changed files with 39 additions and 36 deletions.
diff --git a/core/src/main/java/org/testcontainers/containers/GenericContainer.java b/core/src/main/java/org/testcontainers/containers/GenericContainer.java
@@ -247,7 +247,7 @@ public GenericContainer(@NonNull final RemoteDockerImage image) {
     }
 
     /**
-     * @deprecated use {@link GenericContainer(DockerImageName)} instead
+     * @deprecated use {@link #GenericContainer(DockerImageName)} instead
      */
     @Deprecated
     public GenericContainer() {

diff --git a/modules/clickhouse/src/main/java/org/testcontainers/containers/ClickHouseContainer.java b/modules/clickhouse/src/main/java/org/testcontainers/containers/ClickHouseContainer.java
@@ -43,7 +43,7 @@ public class ClickHouseContainer extends JdbcDatabaseContainer<ClickHouseContain
     private boolean supportsNewDriver;
 
     /**
-     * @deprecated use {@link ClickHouseContainer(DockerImageName)} instead
+     * @deprecated use {@link #ClickHouseContainer(DockerImageName)} instead
      */
     @Deprecated
     public ClickHouseContainer() {

diff --git a/modules/cockroachdb/src/main/java/org/testcontainers/containers/CockroachContainer.java b/modules/cockroachdb/src/main/java/org/testcontainers/containers/CockroachContainer.java
@@ -41,7 +41,7 @@ public class CockroachContainer extends JdbcDatabaseContainer<CockroachContainer
     private boolean isVersionGreaterThanOrEqualTo221;
 
     /**
-     * @deprecated use {@link CockroachContainer(DockerImageName)} instead
+     * @deprecated use {@link #CockroachContainer(DockerImageName)} instead
      */
     @Deprecated
     public CockroachContainer() {

diff --git a/modules/couchbase/src/main/java/org/testcontainers/couchbase/CouchbaseContainer.java b/modules/couchbase/src/main/java/org/testcontainers/couchbase/CouchbaseContainer.java
@@ -118,7 +118,7 @@ public class CouchbaseContainer extends GenericContainer<CouchbaseContainer> {
 
     /**
      * Creates a new couchbase container with the default image and version.
-     * @deprecated use {@link CouchbaseContainer(DockerImageName)} instead
+     * @deprecated use {@link #CouchbaseContainer(DockerImageName)} instead
      */
     @Deprecated
     public CouchbaseContainer() {

diff --git a/modules/db2/src/main/java/org/testcontainers/containers/Db2Container.java b/modules/db2/src/main/java/org/testcontainers/containers/Db2Container.java
@@ -29,7 +29,7 @@ public class Db2Container extends JdbcDatabaseContainer<Db2Container> {
     private String password = "foobar1234";
 
     /**
-     * @deprecated use {@link Db2Container(DockerImageName)} instead
+     * @deprecated use {@link #Db2Container(DockerImageName)} instead
      */
     @Deprecated
     public Db2Container() {

diff --git a/modules/dynalite/src/main/java/org/testcontainers/dynamodb/DynaliteContainer.java b/modules/dynalite/src/main/java/org/testcontainers/dynamodb/DynaliteContainer.java
@@ -23,7 +23,7 @@ public class DynaliteContainer extends GenericContainer<DynaliteContainer> {
     private static final int MAPPED_PORT = 4567;
 
     /**
-     * @deprecated use {@link DynaliteContainer(DockerImageName)} instead
+     * @deprecated use {@link #DynaliteContainer(DockerImageName)} instead
      */
     @Deprecated
     public DynaliteContainer() {

diff --git a/.../elasticsearch/src/main/java/org/testcontainers/elasticsearch/ElasticsearchContainer.java b/.../elasticsearch/src/main/java/org/testcontainers/elasticsearch/ElasticsearchContainer.java
@@ -72,7 +72,7 @@ public class ElasticsearchContainer extends GenericContainer<ElasticsearchContai
     private String certPath = "/usr/share/elasticsearch/config/certs/http_ca.crt";
 
     /**
-     * @deprecated use {@link ElasticsearchContainer(DockerImageName)} instead
+     * @deprecated use {@link #ElasticsearchContainer(DockerImageName)} instead
      */
     @Deprecated
     public ElasticsearchContainer() {

diff --git a/modules/influxdb/src/main/java/org/testcontainers/containers/InfluxDBContainer.java b/modules/influxdb/src/main/java/org/testcontainers/containers/InfluxDBContainer.java
@@ -63,15 +63,15 @@ public class InfluxDBContainer<SELF extends InfluxDBContainer<SELF>> extends Gen
     private final boolean isAtLeastMajorVersion2;
 
     /**
-     * @deprecated use {@link InfluxDBContainer(DockerImageName)} instead
+     * @deprecated use {@link #InfluxDBContainer(DockerImageName)} instead
      */
     @Deprecated
     public InfluxDBContainer() {
         this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
     }
 
     /**
-     * @deprecated use {@link InfluxDBContainer(DockerImageName)} instead
+     * @deprecated use {@link #InfluxDBContainer(DockerImageName)} instead
      */
     @Deprecated
     public InfluxDBContainer(final String version) {

diff --git a/modules/jdbc/src/main/java/org/testcontainers/containers/JdbcDatabaseContainer.java b/modules/jdbc/src/main/java/org/testcontainers/containers/JdbcDatabaseContainer.java
@@ -47,7 +47,7 @@ public abstract class JdbcDatabaseContainer<SELF extends JdbcDatabaseContainer<S
     private static final String QUERY_PARAM_SEPARATOR = "&";
 
     /**
-     * @deprecated use {@link JdbcDatabaseContainer(DockerImageName)} instead
+     * @deprecated use {@link #JdbcDatabaseContainer(DockerImageName)} instead
      */
     public JdbcDatabaseContainer(@NonNull final String dockerImageName) {
         this(DockerImageName.parse(dockerImageName));

diff --git a/modules/junit-jupiter/src/main/java/org/testcontainers/junit/jupiter/Testcontainers.java b/modules/junit-jupiter/src/main/java/org/testcontainers/junit/jupiter/Testcontainers.java
@@ -12,7 +12,7 @@
  * {@code @Testcontainers} is a JUnit Jupiter extension to activate automatic
  * startup and stop of containers used in a test case.
  *
- * <p>The test containers extension finds all fields that are annotated with
+ * <p>The Testcontainers extension finds all fields that are annotated with
  * {@link Container} and calls their container lifecycle methods. Containers
  * declared as static fields will be shared between test methods. They will be
  * started only once before any test method is executed and stopped after the
@@ -60,12 +60,15 @@
 @Inherited
 public @interface Testcontainers {
     /**
-     * Whether tests should be disabled (rather than failing) when Docker is not available.
+     * Whether tests should be disabled (rather than failing) when Docker is not available. Defaults to
+     * {@code false}.
+     * @return if the tests should be disabled when Docker is not available
      */
     boolean disabledWithoutDocker() default false;
 
     /**
-     * Whether containers should start in parallel
+     * Whether containers should start in parallel. Defaults to {@code false}.
+     * @return if the containers should start in parallel
      */
     boolean parallel() default false;
 }
diff --git a/modules/kafka/src/main/java/org/testcontainers/containers/KafkaContainer.java b/modules/kafka/src/main/java/org/testcontainers/containers/KafkaContainer.java
@@ -37,15 +37,15 @@ public class KafkaContainer extends GenericContainer<KafkaContainer> {
     private String clusterId = DEFAULT_CLUSTER_ID;
 
     /**
-     * @deprecated use {@link KafkaContainer(DockerImageName)} instead
+     * @deprecated use {@link #KafkaContainer(DockerImageName)} instead
      */
     @Deprecated
     public KafkaContainer() {
         this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
     }
 
     /**
-     * @deprecated use {@link KafkaContainer(DockerImageName)} instead
+     * @deprecated use {@link #KafkaContainer(DockerImageName)} instead
      */
     @Deprecated
     public KafkaContainer(String confluentPlatformVersion) {

diff --git a/...ocalstack/src/main/java/org/testcontainers/containers/localstack/LocalStackContainer.java b/...ocalstack/src/main/java/org/testcontainers/containers/localstack/LocalStackContainer.java
@@ -72,15 +72,15 @@ public class LocalStackContainer extends GenericContainer<LocalStackContainer> {
     private final boolean isVersion2;
 
     /**
-     * @deprecated use {@link LocalStackContainer(DockerImageName)} instead
+     * @deprecated use {@link #LocalStackContainer(DockerImageName)} instead
      */
     @Deprecated
     public LocalStackContainer() {
         this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
     }
 
     /**
-     * @deprecated use {@link LocalStackContainer(DockerImageName)} instead
+     * @deprecated use {@link #LocalStackContainer(DockerImageName)} instead
      */
     @Deprecated
     public LocalStackContainer(String version) {
@@ -97,7 +97,7 @@ public LocalStackContainer(final DockerImageName dockerImageName) {
     /**
      * @param dockerImageName    image name to use for Localstack
      * @param useLegacyMode      if true, each AWS service is exposed on a different port
-     * @deprecated use {@link LocalStackContainer(DockerImageName)} instead
+     * @deprecated use {@link #LocalStackContainer(DockerImageName)} instead
      */
     @Deprecated
     public LocalStackContainer(final DockerImageName dockerImageName, boolean useLegacyMode) {

diff --git a/modules/mariadb/src/main/java/org/testcontainers/containers/MariaDBContainer.java b/modules/mariadb/src/main/java/org/testcontainers/containers/MariaDBContainer.java
@@ -38,7 +38,7 @@ public class MariaDBContainer<SELF extends MariaDBContainer<SELF>> extends JdbcD
     private static final String MY_CNF_CONFIG_OVERRIDE_PARAM_NAME = "TC_MY_CNF";
 
     /**
-     * @deprecated use {@link MariaDBContainer(DockerImageName)} instead
+     * @deprecated use {@link #MariaDBContainer(DockerImageName)} instead
      */
     @Deprecated
     public MariaDBContainer() {

diff --git a/modules/mockserver/src/main/java/org/testcontainers/containers/MockServerContainer.java b/modules/mockserver/src/main/java/org/testcontainers/containers/MockServerContainer.java
@@ -17,15 +17,15 @@ public class MockServerContainer extends GenericContainer<MockServerContainer> {
     public static final int PORT = 1080;
 
     /**
-     * @deprecated use {@link MockServerContainer(DockerImageName)} instead
+     * @deprecated use {@link #MockServerContainer(DockerImageName)} instead
      */
     @Deprecated
     public MockServerContainer() {
         this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
     }
 
     /**
-     * @deprecated use {@link MockServerContainer(DockerImageName)} instead
+     * @deprecated use {@link #MockServerContainer(DockerImageName)} instead
      */
     @Deprecated
     public MockServerContainer(String version) {

diff --git a/modules/mongodb/src/main/java/org/testcontainers/containers/MongoDBContainer.java b/modules/mongodb/src/main/java/org/testcontainers/containers/MongoDBContainer.java
@@ -35,7 +35,7 @@ public class MongoDBContainer extends GenericContainer<MongoDBContainer> {
     private boolean shardingEnabled;
 
     /**
-     * @deprecated use {@link MongoDBContainer(DockerImageName)} instead
+     * @deprecated use {@link #MongoDBContainer(DockerImageName)} instead
      */
     @Deprecated
     public MongoDBContainer() {

diff --git a/modules/mssqlserver/src/main/java/org/testcontainers/containers/MSSQLServerContainer.java b/modules/mssqlserver/src/main/java/org/testcontainers/containers/MSSQLServerContainer.java
@@ -38,7 +38,7 @@ public class MSSQLServerContainer<SELF extends MSSQLServerContainer<SELF>> exten
     };
 
     /**
-     * @deprecated use {@link MSSQLServerContainer(DockerImageName)} instead
+     * @deprecated use {@link #MSSQLServerContainer(DockerImageName)} instead
      */
     @Deprecated
     public MSSQLServerContainer() {

diff --git a/modules/mysql/src/main/java/org/testcontainers/containers/MySQLContainer.java b/modules/mysql/src/main/java/org/testcontainers/containers/MySQLContainer.java
@@ -35,7 +35,7 @@ public class MySQLContainer<SELF extends MySQLContainer<SELF>> extends JdbcDatab
     private static final String MYSQL_ROOT_USER = "root";
 
     /**
-     * @deprecated use {@link MySQLContainer(DockerImageName)} instead
+     * @deprecated use {@link #MySQLContainer(DockerImageName)} instead
      */
     @Deprecated
     public MySQLContainer() {

diff --git a/modules/neo4j/src/main/java/org/testcontainers/containers/Neo4jContainer.java b/modules/neo4j/src/main/java/org/testcontainers/containers/Neo4jContainer.java
@@ -78,7 +78,7 @@ public class Neo4jContainer<S extends Neo4jContainer<S>> extends GenericContaine
 
     /**
      * Creates a Neo4jContainer using the official Neo4j docker image.
-     * @deprecated use {@link Neo4jContainer(DockerImageName)} instead
+     * @deprecated use {@link #Neo4jContainer(DockerImageName)} instead
      */
     @Deprecated
     public Neo4jContainer() {

diff --git a/modules/nginx/src/main/java/org/testcontainers/containers/NginxContainer.java b/modules/nginx/src/main/java/org/testcontainers/containers/NginxContainer.java
@@ -19,7 +19,7 @@ public class NginxContainer<SELF extends NginxContainer<SELF>>
     private static final String DEFAULT_TAG = "1.9.4";
 
     /**
-     * @deprecated use {@link NginxContainer(DockerImageName)} instead
+     * @deprecated use {@link #NginxContainer(DockerImageName)} instead
      */
     @Deprecated
     public NginxContainer() {

diff --git a/modules/oracle-xe/src/main/java/org/testcontainers/containers/OracleContainer.java b/modules/oracle-xe/src/main/java/org/testcontainers/containers/OracleContainer.java
@@ -57,7 +57,7 @@ public class OracleContainer extends JdbcDatabaseContainer<OracleContainer> {
     private boolean usingSid = false;
 
     /**
-     * @deprecated use {@link OracleContainer(DockerImageName)} instead
+     * @deprecated use {@link #OracleContainer(DockerImageName)} instead
      */
     @Deprecated
     public OracleContainer() {

diff --git a/modules/orientdb/src/main/java/org/testcontainers/containers/OrientDBContainer.java b/modules/orientdb/src/main/java/org/testcontainers/containers/OrientDBContainer.java
@@ -50,7 +50,7 @@ public class OrientDBContainer extends GenericContainer<OrientDBContainer> {
     private ODatabaseSession session;
 
     /**
-     * @deprecated use {@link OrientDBContainer(DockerImageName)} instead
+     * @deprecated use {@link #OrientDBContainer(DockerImageName)} instead
      */
     @Deprecated
     public OrientDBContainer() {

diff --git a/modules/presto/src/main/java/org/testcontainers/containers/PrestoContainer.java b/modules/presto/src/main/java/org/testcontainers/containers/PrestoContainer.java
@@ -32,7 +32,7 @@ public class PrestoContainer<SELF extends PrestoContainer<SELF>> extends JdbcDat
     private String catalog = null;
 
     /**
-     * @deprecated use {@link PrestoContainer(DockerImageName)} instead
+     * @deprecated use {@link #PrestoContainer(DockerImageName)} instead
      */
     @Deprecated
     public PrestoContainer() {

diff --git a/modules/pulsar/src/main/java/org/testcontainers/containers/PulsarContainer.java b/modules/pulsar/src/main/java/org/testcontainers/containers/PulsarContainer.java
@@ -39,15 +39,15 @@ public class PulsarContainer extends GenericContainer<PulsarContainer> {
     private boolean transactionsEnabled = false;
 
     /**
-     * @deprecated use {@link PulsarContainer(DockerImageName)} instead
+     * @deprecated use {@link #PulsarContainer(DockerImageName)} instead
      */
     @Deprecated
     public PulsarContainer() {
         this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
     }
 
     /**
-     * @deprecated use {@link PulsarContainer(DockerImageName)} instead
+     * @deprecated use {@link #PulsarContainer(DockerImageName)} instead
      */
     @Deprecated
     public PulsarContainer(String pulsarVersion) {

diff --git a/modules/rabbitmq/src/main/java/org/testcontainers/containers/RabbitMQContainer.java b/modules/rabbitmq/src/main/java/org/testcontainers/containers/RabbitMQContainer.java
@@ -44,7 +44,7 @@ public class RabbitMQContainer extends GenericContainer<RabbitMQContainer> {
 
     /**
      * Creates a RabbitMQ container using the official RabbitMQ docker image.
-     * @deprecated use {@link RabbitMQContainer(DockerImageName)} instead
+     * @deprecated use {@link #RabbitMQContainer(DockerImageName)} instead
      */
     @Deprecated
     public RabbitMQContainer() {

diff --git a/modules/solr/src/main/java/org/testcontainers/containers/SolrContainer.java b/modules/solr/src/main/java/org/testcontainers/containers/SolrContainer.java
@@ -32,15 +32,15 @@ public class SolrContainer extends GenericContainer<SolrContainer> {
     private SolrContainerConfiguration configuration;
 
     /**
-     * @deprecated use {@link SolrContainer(DockerImageName)} instead
+     * @deprecated use {@link #SolrContainer(DockerImageName)} instead
      */
     @Deprecated
     public SolrContainer() {
         this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
     }
 
     /**
-     * @deprecated use {@link SolrContainer(DockerImageName)} instead
+     * @deprecated use {@link #SolrContainer(DockerImageName)} instead
      */
     public SolrContainer(final String dockerImageName) {
         this(DockerImageName.parse(dockerImageName));

diff --git a/modules/toxiproxy/src/main/java/org/testcontainers/containers/ToxiproxyContainer.java b/modules/toxiproxy/src/main/java/org/testcontainers/containers/ToxiproxyContainer.java
@@ -40,7 +40,7 @@ public class ToxiproxyContainer extends GenericContainer<ToxiproxyContainer> {
     private final AtomicInteger nextPort = new AtomicInteger(FIRST_PROXIED_PORT);
 
     /**
-     * @deprecated use {@link ToxiproxyContainer(DockerImageName)} instead
+     * @deprecated use {@link #ToxiproxyContainer(DockerImageName)} instead
      */
     @Deprecated
     public ToxiproxyContainer() {

diff --git a/modules/vault/src/main/java/org/testcontainers/vault/VaultContainer.java b/modules/vault/src/main/java/org/testcontainers/vault/VaultContainer.java
@@ -39,7 +39,7 @@ public class VaultContainer<SELF extends VaultContainer<SELF>> extends GenericCo
     private int port = VAULT_PORT;
 
     /**
-     * @deprecated use {@link VaultContainer(DockerImageName)} instead
+     * @deprecated use {@link #VaultContainer(DockerImageName)} instead
      */
     @Deprecated
     public VaultContainer() {