Make NetconfMessage methods final 64/106964/2
authorRobert Varga <robert.varga@pantheon.tech>
Fri, 21 Jul 2023 16:30:58 +0000 (18:30 +0200)
committerRobert Varga <nite@hq.sk>
Tue, 25 Jul 2023 15:42:13 +0000 (15:42 +0000)
The toString() and getDocument() methods should not be overridden, make
sure that is the case.

Change-Id: I44a1484ebec9475b4616407bc9975151d041873f
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
protocol/netconf-api/src/main/java/org/opendaylight/netconf/api/NetconfMessage.java

index 05ccac33e7e431b1d8409e41a7a9a47920237c3b..1e8cb5412b6b3a55c82d91ae5ff5996d9908c9f1 100644 (file)
@@ -21,8 +21,7 @@ import org.opendaylight.netconf.api.xml.XmlUtil;
 import org.w3c.dom.Document;
 
 /**
- * NetconfMessage represents a wrapper around org.w3c.dom.Document. Needed for
- * implementing ProtocolMessage interface.
+ * NetconfMessage represents a wrapper around {@link Document}.
  */
 public class NetconfMessage {
     private static final Transformer TRANSFORMER;
@@ -39,20 +38,20 @@ public class NetconfMessage {
         TRANSFORMER = t;
     }
 
-    private final @NonNull Document doc;
+    private final @NonNull Document document;
 
-    public NetconfMessage(final Document doc) {
-        this.doc = requireNonNull(doc);
+    public NetconfMessage(final Document document) {
+        this.document = requireNonNull(document);
     }
 
-    public @NonNull Document getDocument() {
-        return doc;
+    public final @NonNull Document getDocument() {
+        return document;
     }
 
     @Override
-    public String toString() {
+    public final String toString() {
         final var result = new StreamResult(new StringWriter());
-        final var source = new DOMSource(doc.getDocumentElement());
+        final var source = new DOMSource(document.getDocumentElement());
 
         try {
             // Slight critical section is a tradeoff. This should be reasonably fast.