Skip to content

Commit

Permalink
chore: fix javadoc warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
mjeanroy committed Nov 29, 2023
1 parent a09c3bf commit 67aedfe
Show file tree
Hide file tree
Showing 36 changed files with 239 additions and 35 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,12 @@
* The default implementation, that just returns the default configuration.
*/
class DefaultHttpClientConfigurationFactory implements HttpClientConfigurationFactory {
/**
* Create factory.
*/
public DefaultHttpClientConfigurationFactory() {
}

@Override
public HttpClientConfiguration build() {
return HttpClientConfiguration.defaultConfiguration();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@
import static com.github.mjeanroy.junit.servers.commons.lang.Strings.isNotBlank;

/**
* Jetty Embedded Server.mv
* Jetty Embedded Server.
*
* @param <CONTEXT> The jetty WebAppContext implementation.
* @param <CONFIGURATION> The jetty configuration implementation.
*/
public abstract class AbstractBaseEmbeddedJetty<
CONTEXT extends ContextHandler,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@
import java.net.URI;

/**
* Jetty Embedded Server.mv
* Jetty Embedded Server.
*
* @param <CONFIGURATION> The jetty configuration implementation.
*/
public abstract class AbstractEmbeddedJetty<
CONFIGURATION extends AbstractEmbeddedJettyConfiguration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ abstract class AbstractEmbeddedJettyConfiguration extends AbstractConfiguration
}

/**
* Get {@link #stopTimeout}.
* Get {@code stopTimeout}.
*
* @return {@link #stopTimeout}
*/
Expand All @@ -112,7 +112,7 @@ public int getStopTimeout() {
}

/**
* Get {@link #stopAtShutdown}.
* Get {@code stopAtShutdown}.
*
* @return {@link #stopAtShutdown}
*/
Expand All @@ -121,7 +121,7 @@ public boolean isStopAtShutdown() {
}

/**
* Get {@link #baseResource}.
* Get {@code baseResource}.
*
* @return {@link #baseResource}
*/
Expand All @@ -130,7 +130,7 @@ public Resource getBaseResource() {
}

/**
* Get {@link #containerJarPattern}
* Get {@code containerJarPattern}
*
* @return {@link #containerJarPattern}
*/
Expand All @@ -139,7 +139,7 @@ public String getContainerJarPattern() {
}

/**
* Get {@link #webInfJarPattern}
* Get {@code webInfJarPattern}
*
* @return {@link #webInfJarPattern}
*/
Expand All @@ -148,7 +148,7 @@ public String getWebInfJarPattern() {
}

/**
* Get {@link #dirAllowed}
* Get {@code dirAllowed}
*
* @return {@link #dirAllowed}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@
* Jetty configuration settings.
*/
abstract class AbstractEmbeddedJettyConfigurationBuilder<
SELF extends AbstractEmbeddedJettyConfigurationBuilder<SELF, CONFIG>,
CONFIG extends AbstractEmbeddedJettyConfiguration
SELF extends AbstractEmbeddedJettyConfigurationBuilder<SELF, CONFIG>,
CONFIG extends AbstractEmbeddedJettyConfiguration
> extends AbstractConfigurationBuilder<SELF, CONFIG> {

/**
Expand Down Expand Up @@ -90,7 +90,7 @@ protected AbstractEmbeddedJettyConfigurationBuilder() {
}

/**
* Get current {@link #stopTimeout} value.
* Get current {@code stopTimeout} value.
*
* @return {@link #stopTimeout}.
*/
Expand All @@ -99,7 +99,7 @@ public int getStopTimeout() {
}

/**
* Get current {@link #stopAtShutdown} value.
* Get current {@code stopAtShutdown} value.
*
* @return {@link #stopAtShutdown}.
*/
Expand All @@ -108,7 +108,7 @@ public boolean isStopAtShutdown() {
}

/**
* Get current {@link #baseResource} value.
* Get current {@code baseResource} value.
*
* @return {@link #baseResource}.
*/
Expand All @@ -117,7 +117,7 @@ public Resource getBaseResource() {
}

/**
* Get current {@link #containerJarPattern} value.
* Get current {@code containerJarPattern} value.
*
* @return {@link #containerJarPattern}
*/
Expand All @@ -126,7 +126,7 @@ public String getContainerJarPattern() {
}

/**
* Get current {@link #webInfJarPattern} value.
* Get current {@code webInfJarPattern} value.
*
* @return {@link #webInfJarPattern}
*/
Expand All @@ -135,7 +135,7 @@ public String getWebInfJarPattern() {
}

/**
* Get current {@link #dirAllowed} value.
* Get current {@code dirAllowed} value.
*
* @return {@link #dirAllowed}
*/
Expand All @@ -144,7 +144,7 @@ public boolean isDirAllowed() {
}

/**
* Update {@link #stopTimeout} value.
* Update {@code stopTimeout} value.
*
* @param stopTimeout New {@link #stopTimeout} value.
* @return this
Expand All @@ -156,23 +156,24 @@ public SELF withStopTimeout(int stopTimeout) {
}

/**
* Set {@link #stopAtShutdown} to {@code false}.
* Set {@code stopAtShutdown} to {@code false}.
*
* @return this
*/
public SELF disableStopAtShutdown() {
return toggleStopAtShutdown(false);
}

/**
* Set {@link #stopAtShutdown} to {@code true}.
* Set {@code stopAtShutdown} to {@code true}.
* @return this
*/
public SELF enableStopAtShutdown() {
return toggleStopAtShutdown(true);
}

/**
* Toggle {@link #stopAtShutdown}.
* Toggle {@code stopAtShutdown}.
*
* @param stopAtShutdown New {@link #stopAtShutdown} value.
* @return this
Expand All @@ -183,7 +184,7 @@ private SELF toggleStopAtShutdown(boolean stopAtShutdown) {
}

/**
* Change {@link #baseResource} value.
* Change {@code baseResource} value.
*
* @param resource New {@link #baseResource} value.
* @return this
Expand All @@ -194,7 +195,7 @@ public SELF withBaseResource(Resource resource) {
}

/**
* Change {@link #containerJarPattern} value.
* Change {@code containerJarPattern} value.
*
* @param containerJarPattern The container JAR pattern.
* @return this
Expand All @@ -205,7 +206,7 @@ public SELF withContainerJarPattern(String containerJarPattern) {
}

/**
* Change {@link #webInfJarPattern} value.
* Change {@code webInfJarPattern} value.
*
* @param webInfJarPattern The webinf JAR pattern.
* @return this
Expand All @@ -216,7 +217,7 @@ public SELF withWebInfJarPattern(String webInfJarPattern) {
}

/**
* Change {@link #dirAllowed} value.
* Change {@code dirAllowed} value.
*
* @param dirAllowed Directory listing flag.
* @return this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,24 @@
/**
* Static factories for {@link AbstractEmbeddedJetty} that can be used in JUnit 4 Runner implementation
* or JUnit Jupiter Extension.
*
* @param <EMBEDDED_JETTY> The embedded jetty implementation.
*/
public abstract class AbstractEmbeddedJettyFactory<
EMBEDDED_JETTY extends AbstractBaseEmbeddedJetty<?, EmbeddedJettyConfiguration>
EMBEDDED_JETTY extends AbstractBaseEmbeddedJetty<?, EmbeddedJettyConfiguration>
> {

/**
* Class Logger.
*/
private static final Logger log = LoggerFactory.getLogger(AbstractEmbeddedJettyFactory.class);

/**
* Create factory.
*/
public AbstractEmbeddedJettyFactory() {
}

/**
* Instantiate embedded jetty from given test class.
*
Expand Down Expand Up @@ -77,6 +85,7 @@ public final EMBEDDED_JETTY instantiateFrom(Class<?> testClass, EmbeddedJettyCon
/**
* Instantiate embedded Jetty using given configuration.
*
* @param config Jetty configuration.
* @return Embedded jetty.
*/
protected abstract EMBEDDED_JETTY instantiateFrom(EmbeddedJettyConfiguration config);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ public class IllegalJettyConfigurationException extends IllegalConfigurationExce

/**
* Create exception with default message.
*
* @param requiredClass The expected Jetty configuration class.
*/
public IllegalJettyConfigurationException(Class<?> requiredClass) {
super(createMessage(requiredClass));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@
*
* Subclasses should implement {@link #doStart()} and {@link #doStop()} methods and synchronization is already
* managed by this abstract implementation.
*
* @param <EMBEDDED_SERVER> The embedded server implementation.
* @param <CONFIGURATION> The embedded server configuration implementation.
*/
public abstract class AbstractEmbeddedServer<
EMBEDDED_SERVER,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@

/**
* Embedded server using tomcat as implementation.
*
* @param <CONFIGURATION> The tomcat configuration implementation.
*/
public abstract class AbstractEmbeddedTomcat<
CONFIGURATION extends AbstractEmbeddedTomcatConfiguration
Expand Down Expand Up @@ -270,6 +272,11 @@ protected int doGetPort() {
return getConnector().getLocalPort();
}

/**
* Get tomcat context.
*
* @return Tomcat context.
*/
protected Context getContext() {
return context;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ abstract class AbstractEmbeddedTomcatConfiguration extends AbstractConfiguration
}

/**
* Get {@link #baseDir}.
* Get {@code baseDir}.
*
* @return {@link #baseDir}
*/
Expand All @@ -102,7 +102,7 @@ public String getBaseDir() {
}

/**
* Get current {@link #keepBaseDir} value.
* Get current {@code keepBaseDir} value.
*
* @return {@link #keepBaseDir}
*/
Expand All @@ -111,7 +111,7 @@ public boolean isKeepBaseDir() {
}

/**
* Get {@link #enableNaming}.
* Get {@code enableNaming}.
*
* @return {@link #enableNaming}
*/
Expand All @@ -120,7 +120,7 @@ public boolean isEnableNaming() {
}

/**
* Get {@link #forceMetaInf}.
* Get {@code forceMetaInf}.
*
* @return {@link #forceMetaInf}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
import static com.github.mjeanroy.junit.servers.tomcat.AbstractEmbeddedTomcatConfiguration.DEFAULT_KEEP_BASE_DIR;

abstract class AbstractEmbeddedTomcatConfigurationBuilder<
SELF extends AbstractConfigurationBuilder<SELF, CONFIG>,
CONFIG extends AbstractEmbeddedTomcatConfiguration
SELF extends AbstractConfigurationBuilder<SELF, CONFIG>,
CONFIG extends AbstractEmbeddedTomcatConfiguration
> extends AbstractConfigurationBuilder<SELF, CONFIG> {

/**
Expand Down Expand Up @@ -80,7 +80,7 @@ abstract class AbstractEmbeddedTomcatConfigurationBuilder<
}

/**
* Get current {@link #baseDir} value.
* Get current {@code baseDir} value.
*
* @return {@link #baseDir}
*/
Expand All @@ -89,7 +89,7 @@ public String getBaseDir() {
}

/**
* Get current {@link #keepBaseDir} value.
* Get current {@code keepBaseDir} value.
*
* @return {@link #keepBaseDir}
*/
Expand All @@ -98,7 +98,7 @@ public boolean isKeepBaseDir() {
}

/**
* Get current {@link #enableNaming} value.
* Get current {@code enableNaming} value.
*
* @return {@link #enableNaming}
*/
Expand All @@ -107,7 +107,7 @@ public boolean isEnableNaming() {
}

/**
* Get current {@link #forceMetaInf} value.
* Get current {@code forceMetaInf} value.
*
* @return {@link #forceMetaInf}
*/
Expand Down
Loading

0 comments on commit 67aedfe

Please sign in to comment.