aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@ericsson.com>2018-07-06 13:38:08 +0100
committerliamfallon <liam.fallon@ericsson.com>2018-07-06 13:38:16 +0100
commitaf869409b81ad399b4733a1b7b0d5c662fbfa73d (patch)
tree2c2d5b6eb29be79370554ff23a3a8da77d474d7a /plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src
parentf149399d9fed5949bf9afc3eeac1da9bf0b905fa (diff)
Fix Javadoc errors
Path changes and changes due to mitigation of security violations caused some links in the Javadoc not to work any more. This changes fixes the javadoc. Issue-ID: POLICY-954 Change-Id: Ic9db2627fb1ffad69c8acadc7b975bc40864caaf Signed-off-by: liamfallon <liam.fallon@ericsson.com>
Diffstat (limited to 'plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src')
-rw-r--r--plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java28
-rw-r--r--plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java2
-rw-r--r--plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java2
3 files changed, 16 insertions, 16 deletions
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java
index c2baff8e6..83aef4e9d 100644
--- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java
@@ -26,34 +26,34 @@ import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParame
* Event protocol parameters for JMS Object messages as an event protocol.
*
* <p>
- * On reception of an a JMS {@link javax.jms.ObjectMessage}, the JMS Object plugin unmarshals the message as follows:
+ * On reception of an a JMS {@code javax.jms.ObjectMessage}, the JMS Object plugin unmarshals the message as follows:
* <ol>
- * <li>It extracts the Java object from the {@link javax.jms.ObjectMessage} instance.
- * <li>It creates an {@link org.onap.policy.apex.service.engine.event.ApexEvent} instance to hold the java object.
+ * <li>It extracts the Java object from the {@code javax.jms.ObjectMessage} instance.</li>
+ * <li>It creates an {@link org.onap.policy.apex.service.engine.event.ApexEvent} instance to hold the java object.</li>
* <li>It sets the name of the Apex event to be the simple class name of the incoming Java object and appends the value
- * of the {@code incomingEventSuffix} parameter to it.
- * <li>It sets the version of the incoming event to the value of the {@code incomingEventVersion} parameter.
+ * of the {@code incomingEventSuffix} parameter to it.</li>
+ * <li>It sets the version of the incoming event to the value of the {@code incomingEventVersion} parameter.</li>
* <li>It sets the name space of the incoming event to be the value of the package of the class of the incoming Java
- * object.
- * <li>It sets the source of the incoming event to the value of the {@code incomingEventSource} parameter.
- * <li>It sets the target of the incoming event to the value of the {@code incomingEventTarget} parameter.
+ * object.</li>
+ * <li>It sets the source of the incoming event to the value of the {@code incomingEventSource} parameter.</li>
+ * <li>It sets the target of the incoming event to the value of the {@code incomingEventTarget} parameter.</li>
* <li>It puts a single entry into the Apex event map with the the simple class name of the incoming Java object being
- * the key of the entry and the actual incoming object as the value of the entry.
+ * the key of the entry and the actual incoming object as the value of the entry.</li>
* </ol>
* <p>
* When sending an object to JMS, the plugin expects to receive an Apex event with a single entry. The plugin marshals
- * the value of that entry to an object that can be sent by JMS as a {@link javax.jms.ObjectMessage} instance.
+ * the value of that entry to an object that can be sent by JMS as a {@code javax.jms.ObjectMessage} instance.
* <p>
* The parameters for this plugin are:
* <ol>
* <li>incomingEventSuffix: The suffix to append to the simple name of incoming Java class instances when they are
- * encapsulated in Apex events. The parameter defaults to the string value {@code IncomingEvent}.
+ * encapsulated in Apex events. The parameter defaults to the string value {@code IncomingEvent}.</li>
* <li>incomingEventVersion: The event version to use for incoming Java class instances when they are encapsulated in
- * Apex events. The parameter defaults to the string value {@code 1.0.0}.
+ * Apex events. The parameter defaults to the string value {@code 1.0.0}.</li>
* <li>incomingEventSource: The event source to use for incoming Java class instances when they are encapsulated in Apex
- * events. The parameter defaults to the string value {@code JMS}.
+ * events. The parameter defaults to the string value {@code JMS}.</li>
* <li>incomingEventTarget: The event target to use for incoming Java class instances when they are encapsulated in Apex
- * events. The parameter defaults to the string value {@code Apex}.
+ * events. The parameter defaults to the string value {@code Apex}.</li>
* </ol>
*
* @author Liam Fallon (liam.fallon@ericsson.com)
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java
index 8ddc64862..b3a9154ff 100644
--- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java
@@ -28,7 +28,7 @@ import org.onap.policy.apex.service.engine.event.impl.jsonprotocolplugin.JSONEve
* Text messages received and sent over JMS in ~Text format are assumed to be in a JSON format that Apex can understand.
* Therefore this plugin is a subclass of the built in JSON event protocol plugin.
* <p>
- * On reception of a JMS {@link javax.jms.TextMessage} message, the JMS Text plugin unmarshals the message the JMS text
+ * On reception of a JMS {@code javax.jms.TextMessage} message, the JMS Text plugin unmarshals the message the JMS text
* message and passes it to its JSON superclass unmarshaling for processing.
* <p>
* When sending an Apex event, the plugin uses its underlying JSON superclass to marshal the event to a JSON string and
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java
index 92d6d07d4..f7e236743 100644
--- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java
@@ -20,7 +20,7 @@
/**
* Contains implementations of Apex event protocol converter plugins for JMS event protocols that are implementations of
- * {@link javax.jms.Message}.
+ * {@code javax.jms.Message}.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/