100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
Fix all JavaDoc errors and a few warnings (#1468)
Wouter Bornd4e98bf1dbad
diff --git a/agent/src/main/java/org/openremote/agent/protocol/bluetooth/mesh/BaseMeshNetwork.java b/agent/src/main/java/org/openremote/agent/protocol/bluetooth/mesh/BaseMeshNetwork.javaindex ded8a8c74..35d9fe452 100644--- a/agent/src/main/java/org/openremote/agent/protocol/bluetooth/mesh/BaseMeshNetwork.java+++ b/agent/src/main/java/org/openremote/agent/protocol/bluetooth/mesh/BaseMeshNetwork.java@@ -913,7 +913,6 @@ abstract public class BaseMeshNetwork {* <p>* Please note that this is not persisted within the node since the filter is reinitialized to a whitelist filter upon connecting to a proxy node.* Therefore after setting a proxy filter and disconnecting users will have to manually- * <p/>*/public synchronized void setProxyFilter(final ProxyFilter proxyFilter) {this.proxyFilter = proxyFilter;diff --git a/agent/src/main/java/org/openremote/agent/protocol/http/AbstractHTTPServerProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/http/AbstractHTTPServerProtocol.javaindex 7cc8a84ff..e8c66396d 100644--- a/agent/src/main/java/org/openremote/agent/protocol/http/AbstractHTTPServerProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/http/AbstractHTTPServerProtocol.java@@ -221,7 +221,7 @@ public abstract class AbstractHTTPServerProtocol<T extends AbstractHTTPServerPro/*** Deployment path will always be prefixed with {@link #getDeploymentPathPrefix()}; default implementation combines- * the prefix with the value of {@link AbstractHTTPServerAgent# META_PROTOCOL_DEPLOYMENT_PATH}, for example:+ * the prefix with the value of {@link AbstractHTTPServerAgent#DEPLOYMENT_PATH}, for example:* <ul>* <li>getDeploymentPathPrefix() = {@value #DEFAULT_DEPLOYMENT_PATH_PREFIX}</li>* <li>{@link AbstractHTTPServerAgent#DEPLOYMENT_PATH} = "complaints"</li>diff --git a/agent/src/main/java/org/openremote/agent/protocol/http/HTTPProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/http/HTTPProtocol.javaindex 4fb4ee2e7..7e74cbf13 100644--- a/agent/src/main/java/org/openremote/agent/protocol/http/HTTPProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/http/HTTPProtocol.java@@ -76,7 +76,7 @@ import static org.openremote.model.syslog.SyslogCategory.PROTOCOL;* This is a HTTP client protocol for communicating with HTTP servers; it uses the {@link WebTargetBuilder} factory to* generate JAX-RS {@link jakarta.ws.rs.client.WebTarget}s that can be used to make arbitrary calls to endpoints on a HTTP* server but it can also be extended and used as a JAX-RS client proxy.- * <h1>Response filtering</h1>+ * <h2>Response filtering</h2>* <p>* Any {@link Attribute} whose value is to be set by the HTTP server response (i.e. it has an {@link* HTTPAgentLink#getPollingMillis()} value can use the standard {@link AgentLink#getValueFilters()} in order to filter@@ -84,13 +84,13 @@ import static org.openremote.model.syslog.SyslogCategory.PROTOCOL;* <p>* <b>NOTE: if an exception is thrown during the request that means no response is returned then this is treated as if* a 500 response has been received</b>- * <h1>Dynamic placeholder injection</h1>+ * <h2>Dynamic placeholder injection</h2>* This allows the path, query params, headers and/or {@link AgentLink#getWriteValue()} to contain the linked* {@link Attribute} value when sending requests.- * <h2>Path example</h2>+ * <h3>Path example</h3>* {@link HTTPAgentLink#getPath()} = "volume/set/%VALUE%" and request received to set attribute value to 100. Actual* path used for the request = "volume/set/100"- * <h2>Query parameter example</h2>+ * <h3>Query parameter example</h3>* {@link HTTPAgentLink#getQueryParameters()} =* <blockquote><pre>* {@code@@ -102,9 +102,9 @@ import static org.openremote.model.syslog.SyslogCategory.PROTOCOL;* }* </pre></blockquote>* Request received to set attribute value to true. Actual query parameters injected into the request =- * "param1=val1¶m1=val2¶m2=12232¶m3=true"- * <h2>Body examples</h2>- * {@link AgentLink#getWriteValue()} = '<?xml version="1.0" encoding="UTF-8"?>%VALUE%</xml>' and request received to+ * "param1=val1&param1=val2&param2=12232&param3=true"+ * <h3>Body examples</h3>+ * {@link AgentLink#getWriteValue()} = <?xml version="1.0" encoding="UTF-8"?>%VALUE%</xml> and request received to* set attribute value to 100. Actual body used for the request = "{volume: 100}"* <p>* {@link AgentLink#getWriteValue()} = '{myObject: "%VALUE%"}' and request received to set attribute value to:diff --git a/agent/src/main/java/org/openremote/agent/protocol/io/NettyIOClient.java b/agent/src/main/java/org/openremote/agent/protocol/io/NettyIOClient.javaindex c432fb412..7a67978e4 100644--- a/agent/src/main/java/org/openremote/agent/protocol/io/NettyIOClient.java+++ b/agent/src/main/java/org/openremote/agent/protocol/io/NettyIOClient.java@@ -25,7 +25,7 @@ import java.util.function.Supplier;/*** This is for IO clients that use Netty and are based on {@link io.netty.channel.ChannelHandler}s for- * encoding/decoding messages of type <T>.+ * encoding/decoding messages of type <T>.** @param <T> Defines the message type that the instance will encode/decode*/diff --git a/agent/src/main/java/org/openremote/agent/protocol/serial/AbstractSerialProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/serial/AbstractSerialProtocol.javaindex e6270bd60..baea37d74 100644--- a/agent/src/main/java/org/openremote/agent/protocol/serial/AbstractSerialProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/serial/AbstractSerialProtocol.java@@ -26,7 +26,7 @@ import org.openremote.model.asset.agent.AgentLink;/*** This is an abstract TCP client protocol for communicating with TCP servers; concrete implementations must provide- * an {@link IOClient <T> for handling over the wire communication}.+ * an {@link IOClient<T>} for handling over the wire communication.*/public abstract class AbstractSerialProtocol<T extends AbstractNettyIOClientProtocol<T, U, W, X, V>, U extends IOAgent<U, T, V>, V extends AgentLink<?>, W, X extends SerialIOClient<W>> extends AbstractNettyIOClientProtocol<T, U, W, X, V> {diff --git a/agent/src/main/java/org/openremote/agent/protocol/serial/SerialIOClient.java b/agent/src/main/java/org/openremote/agent/protocol/serial/SerialIOClient.javaindex 53ba30272..8a97194f2 100644--- a/agent/src/main/java/org/openremote/agent/protocol/serial/SerialIOClient.java+++ b/agent/src/main/java/org/openremote/agent/protocol/serial/SerialIOClient.java@@ -37,7 +37,7 @@ import static org.openremote.agent.protocol.serial.JSerialCommChannelOption.*;* Users of this {@link IOClient} are responsible for adding encoders for converting messages of type <T> to* {@link io.netty.buffer.ByteBuf} (see {@link MessageToByteEncoder}) and adding decoders to convert from* {@link io.netty.buffer.ByteBuf} to messages of type <T> and ensuring these decoded messages are passed back- * to this client via {@link AbstractNettyIOClient#onMessageReceived} (see {@link ByteToMessageDecoder and+ * to this client via {@link AbstractNettyIOClient#onMessageReceived} (see {@link ByteToMessageDecoder} and* {@link MessageToMessageDecoder}).*/public class SerialIOClient<T> extends AbstractNettyIOClient<T, JSerialCommDeviceAddress> {diff --git a/agent/src/main/java/org/openremote/agent/protocol/tcp/AbstractTCPClientProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/tcp/AbstractTCPClientProtocol.javaindex 655e60f9f..b55ce6ae7 100644--- a/agent/src/main/java/org/openremote/agent/protocol/tcp/AbstractTCPClientProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/tcp/AbstractTCPClientProtocol.java@@ -27,7 +27,7 @@ import org.openremote.model.asset.agent.AgentLink;/*** This is an abstract TCP client protocol for communicating with TCP servers; concrete implementations must provide- * an {@link IOClient <T> for handling over the wire communication}.+ * an {@link IOClient<T>} for handling over the wire communication.*/public abstract class AbstractTCPClientProtocol<T extends AbstractNettyIOClientProtocol<T, U, W, X, V>, U extends IOAgent<U, T, V>, V extends AgentLink<?>, W, X extends TCPIOClient<W>> extends AbstractNettyIOClientProtocol<T, U, W, X, V> {diff --git a/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPIOClient.java b/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPIOClient.javaindex 2f84e6c06..23168f38f 100644--- a/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPIOClient.java+++ b/agent/src/main/java/org/openremote/agent/protocol/tcp/TCPIOClient.java@@ -35,7 +35,7 @@ import java.util.concurrent.Future;* Users of this {@link IOClient} are responsible for adding encoders for converting messages of type <T> to* {@link io.netty.buffer.ByteBuf} (see {@link MessageToByteEncoder}) and adding decoders to convert from* {@link io.netty.buffer.ByteBuf} to messages of type <T> and ensuring these decoded messages are passed back- * to this client via {@link AbstractNettyIOClient#onMessageReceived} (see {@link ByteToMessageDecoder and+ * to this client via {@link AbstractNettyIOClient#onMessageReceived} (see {@link ByteToMessageDecoder} and* {@link MessageToMessageDecoder}).*/public class TCPIOClient<T> extends AbstractNettyIOClient<T, InetSocketAddress> {diff --git a/agent/src/main/java/org/openremote/agent/protocol/tradfri/device/LightProperties.java b/agent/src/main/java/org/openremote/agent/protocol/tradfri/device/LightProperties.javaindex c49179347..6f8812355 100644--- a/agent/src/main/java/org/openremote/agent/protocol/tradfri/device/LightProperties.java+++ b/agent/src/main/java/org/openremote/agent/protocol/tradfri/device/LightProperties.java@@ -165,11 +165,6 @@ public class LightProperties extends DeviceProperties {/*** Set the colour of the light to a predefined hexadecimal colour within the LightProperties class<br>* <i>Note: This does not change the actual light</i>- * Available colours:<br>- * <ul>- * <li>RGB: {@link org.openremote.agent.protocol.tradfri.util.ColourHex}</li>- * <li>Colour temperatures: {@link org.openremote.agent.protocol.tradfri.util.ColourTemperatureHex}</li>- * </ul>* @param colourHex The new colour for the light*/public void setColourHex(String colourHex) {diff --git a/agent/src/main/java/org/openremote/agent/protocol/udp/UDPIOClient.java b/agent/src/main/java/org/openremote/agent/protocol/udp/UDPIOClient.javaindex 0d9947b66..e858492de 100644--- a/agent/src/main/java/org/openremote/agent/protocol/udp/UDPIOClient.java+++ b/agent/src/main/java/org/openremote/agent/protocol/udp/UDPIOClient.java@@ -42,7 +42,7 @@ import static org.openremote.model.syslog.SyslogCategory.PROTOCOL;* Users of this {@link IOClient} are responsible for adding encoders for converting messages of type <T> to* {@link io.netty.buffer.ByteBuf} (see {@link MessageToByteEncoder}) and adding decoders to convert from* {@link io.netty.buffer.ByteBuf} to messages of type <T> and ensuring these decoded messages are passed back- * to this client via {@link AbstractNettyIOClient#onMessageReceived} (see {@link ByteToMessageDecoder and+ * to this client via {@link AbstractNettyIOClient#onMessageReceived} (see {@link ByteToMessageDecoder} and* {@link MessageToMessageDecoder}).*/public class UDPIOClient<T> extends AbstractNettyIOClient<T, InetSocketAddress> {diff --git a/agent/src/main/java/org/openremote/agent/protocol/velbus/device/OLEDProcessor.java b/agent/src/main/java/org/openremote/agent/protocol/velbus/device/OLEDProcessor.javaindex a72aae3ee..6b5b8922c 100644--- a/agent/src/main/java/org/openremote/agent/protocol/velbus/device/OLEDProcessor.java+++ b/agent/src/main/java/org/openremote/agent/protocol/velbus/device/OLEDProcessor.java@@ -33,7 +33,7 @@ import static org.openremote.agent.protocol.velbus.AbstractVelbusProtocol.LOG;/*** Covers OLED specific features:- * <p>+ ** <ul>* <li> Memo Text* </ul>diff --git a/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.javaindex b131c8887..8a5d9c781 100644--- a/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.java+++ b/agent/src/main/java/org/openremote/agent/protocol/websocket/WebsocketAgentProtocol.java@@ -60,7 +60,7 @@ import static org.openremote.model.syslog.SyslogCategory.PROTOCOL;/*** This is a generic {@link org.openremote.model.asset.agent.Protocol} for communicating with a Websocket server* using {@link String} based messages.- * <p>+ ** <h2>Protocol Specifics</h2>* When the websocket connection is established it is possible to subscribe to events by specifying the* {@link WebsocketAgent#CONNECT_SUBSCRIPTIONS} on the {@link WebsocketAgent} ordiff --git a/container/src/main/java/org/keycloak/adapters/spi/SessionIdMapperUpdater.java b/container/src/main/java/org/keycloak/adapters/spi/SessionIdMapperUpdater.javaindex f7e6b1e3c..637156ccf 100644--- a/container/src/main/java/org/keycloak/adapters/spi/SessionIdMapperUpdater.java+++ b/container/src/main/java/org/keycloak/adapters/spi/SessionIdMapperUpdater.java@@ -81,7 +81,7 @@ public interface SessionIdMapperUpdater {* Refreshes the mapping in the {@code idMapper} from the internal source of this mapped updater* and maps it via {@link SessionIdMapper#map} method.* @param idMapper Mapper- * @param session HTTP session ID.+ * @param httpSessionId HTTP session ID.* @return {@code true} if the mapping existed in the internal source of this mapped updater* and has been refreshed, {@code false} otherwise*/diff --git a/container/src/main/java/org/openremote/container/web/WebServiceExceptions.java b/container/src/main/java/org/openremote/container/web/WebServiceExceptions.javaindex 60671d658..17c7f3fae 100644--- a/container/src/main/java/org/openremote/container/web/WebServiceExceptions.java+++ b/container/src/main/java/org/openremote/container/web/WebServiceExceptions.java@@ -43,7 +43,7 @@ import static jakarta.ws.rs.core.MediaType.TEXT_PLAIN_TYPE;* <p>* This is naturally quite messy, our goal is to disable all the other default exception* handling and do it here in a "simple" way.- * <p/>+ * <p>* In production we want to be INFOrmed of exceptions but only log a stacktrace if FINE* debug logging is enabled. We never want to send a stacktrace or some crappy HTML to a* client in production.diff --git a/container/src/main/java/org/openremote/container/web/file/AbstractFileServlet.java b/container/src/main/java/org/openremote/container/web/file/AbstractFileServlet.javaindex b88c05a81..976948a48 100644--- a/container/src/main/java/org/openremote/container/web/file/AbstractFileServlet.java+++ b/container/src/main/java/org/openremote/container/web/file/AbstractFileServlet.java@@ -54,7 +54,7 @@ import jakarta.servlet.http.HttpServletResponse;* download, and by download accelerators to be able to request smaller parts simultaneously. This servlet is ideal when* you have large files like media files placed outside the web application and you can't use the default servlet.*- * <h3>Usage</h3>+ * <h2>Usage</h2>* <p>* Just extend this class and override the {@link #getFile(HttpServletRequest)} method to return the desired file. If* you want to trigger a HTTP 400 "Bad Request" error, simply throw {@link IllegalArgumentException}. If you want todiff --git a/container/src/main/java/org/openremote/container/web/file/GzipResponseFilter.java b/container/src/main/java/org/openremote/container/web/file/GzipResponseFilter.javaindex dfd491e33..7c028fde3 100644--- a/container/src/main/java/org/openremote/container/web/file/GzipResponseFilter.java+++ b/container/src/main/java/org/openremote/container/web/file/GzipResponseFilter.java@@ -37,7 +37,7 @@ import static java.util.Collections.unmodifiableSet;* servlet container independent way of configuring GZIP compression and also allows enabling GZIP compression anyway* on 3rd party hosts where you have no control over servlet container configuration.*- * <h3>Installation</h3>+ * <h2>Installation</h2>* <p>* To get it to run, map this filter on the desired <code><url-pattern></code> or maybe even on the* <code><servlet-name></code> of the <code>FacesServlet</code>. A <code>Filter</code> is by default dispatcheddiff --git a/container/src/main/java/org/openremote/container/web/file/HttpFilter.java b/container/src/main/java/org/openremote/container/web/file/HttpFilter.javaindex c316cd335..0c017a428 100644--- a/container/src/main/java/org/openremote/container/web/file/HttpFilter.java+++ b/container/src/main/java/org/openremote/container/web/file/HttpFilter.java@@ -39,7 +39,7 @@ import jakarta.servlet.http.HttpSession;* It's a bit the idea of using the convenient {@link HttpServlet} abstract servlet class instead of the barebones* {@link Servlet} interface.*- * <h3>Usage</h3>+ * <h2>Usage</h2>* <p>* To use it, just let your custom filter extend from {@link HttpFilter} instead of implement {@link Filter}.* For example:diff --git a/container/src/main/java/org/openremote/container/web/file/HttpServletResponseOutputWrapper.java b/container/src/main/java/org/openremote/container/web/file/HttpServletResponseOutputWrapper.javaindex 3571d8323..47bcf2a26 100644--- a/container/src/main/java/org/openremote/container/web/file/HttpServletResponseOutputWrapper.java+++ b/container/src/main/java/org/openremote/container/web/file/HttpServletResponseOutputWrapper.java@@ -31,7 +31,6 @@ import jakarta.servlet.http.HttpServletResponseWrapper;* <p>* The boolean property <code>passThrough</code>, which defaults to <code>false</code> also enables the developer to* control whether to pass through to the wrapped {@link ServletOutputStream} or not.- * <p>** @author Bauke Scholtz* @since 1.1diff --git a/container/src/main/java/org/openremote/container/xml/ParserException.java b/container/src/main/java/org/openremote/container/xml/ParserException.javaindex 351b478b5..82b6efb45 100644--- a/container/src/main/java/org/openremote/container/xml/ParserException.java+++ b/container/src/main/java/org/openremote/container/xml/ParserException.java@@ -22,7 +22,7 @@ package org.openremote.container.xml;import org.xml.sax.SAXParseException;/**- * Unified exception thrown by the <tt>DOMParser</tt> and <tt>SAXParser</tt>.+ * Unified exception thrown by the {@code DOMParser} and {@code SAXParser}.*/public class ParserException extends Exception {