From 423e98641ca7fe79a1b1bb897aa8a4b17ba5ee4d Mon Sep 17 00:00:00 2001 From: liamfallon Date: Fri, 28 Jun 2019 10:42:34 +0000 Subject: Replace non-Javadoc comments with inheritDocs Copyright headers not changed as this review only amends comments. Issue-ID: POLICY-1791 Change-Id: Icbeb2c6e591b3b160ae102bb67aef2d407924a4d Signed-off-by: liamfallon --- .../apex/model/eventmodel/concepts/AxEvent.java | 58 +++++--------- .../model/eventmodel/concepts/AxEventModel.java | 60 +++++---------- .../apex/model/eventmodel/concepts/AxEvents.java | 89 +++++++--------------- .../apex/model/eventmodel/concepts/AxField.java | 52 ++++--------- 4 files changed, 80 insertions(+), 179 deletions(-) (limited to 'model/event-model/src/main') diff --git a/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEvent.java b/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEvent.java index c83b7b86a..74ba1f958 100644 --- a/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEvent.java +++ b/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEvent.java @@ -208,20 +208,16 @@ public class AxEvent extends AxConcept { } } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKey() + /** + * {@inheritDoc}. */ @Override public AxArtifactKey getKey() { return key; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKeys() + /** + * {@inheritDoc}. */ @Override public List getKeys() { @@ -332,12 +328,8 @@ public class AxEvent extends AxConcept { this.parameterMap = parameterMap; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxConcept#validate(org.onap.policy.apex.model.basicmodel.concepts. - * AxValidationResult) + /** + * {@inheritDoc}. */ @Override public AxValidationResult validate(final AxValidationResult resultIn) { @@ -405,10 +397,8 @@ public class AxEvent extends AxConcept { return eventParameterEntry.getValue().validate(result); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#clean() + /** + * {@inheritDoc}. */ @Override public void clean() { @@ -418,10 +408,8 @@ public class AxEvent extends AxConcept { target = target.trim(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { @@ -442,12 +430,8 @@ public class AxEvent extends AxConcept { return builder.toString(); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxConcept#copyTo(org.onap.policy.apex.model.basicmodel.concepts. - * AxConcept) + /** + * {@inheritDoc}. */ @Override public AxConcept copyTo(final AxConcept targetObject) { @@ -472,10 +456,8 @@ public class AxEvent extends AxConcept { return copy; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -489,10 +471,8 @@ public class AxEvent extends AxConcept { return result; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(final Object obj) { @@ -523,10 +503,8 @@ public class AxEvent extends AxConcept { return parameterMap.equals(other.parameterMap); } - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(final AxConcept otherObj) { diff --git a/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEventModel.java b/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEventModel.java index 69ae01acf..6c8ce15f1 100644 --- a/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEventModel.java +++ b/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEventModel.java @@ -124,10 +124,8 @@ public class AxEventModel extends AxModel { this.events = events; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxModel#register() + /** + * {@inheritDoc}. */ @Override public void register() { @@ -136,10 +134,8 @@ public class AxEventModel extends AxModel { ModelService.registerModel(AxEvents.class, getEvents()); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxModel#getKeys() + /** + * {@inheritDoc}. */ @Override public List getKeys() { @@ -189,12 +185,8 @@ public class AxEventModel extends AxModel { this.events = events; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxModel#validate(org.onap.policy.apex.model.basicmodel.concepts. - * AxValidationResult) + /** + * {@inheritDoc}. */ @Override public AxValidationResult validate(final AxValidationResult resultIn) { @@ -205,10 +197,8 @@ public class AxEventModel extends AxModel { return events.validate(result); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxModel#clean() + /** + * {@inheritDoc}. */ @Override public void clean() { @@ -217,10 +207,8 @@ public class AxEventModel extends AxModel { events.clean(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxModel#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { @@ -236,12 +224,8 @@ public class AxEventModel extends AxModel { return builder.toString(); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxConcept#copyTo(org.onap.policy.apex.model.basicmodel.concepts. - * AxConcept) + /** + * {@inheritDoc}. */ @Override public AxConcept copyTo(final AxConcept targetObject) { @@ -258,10 +242,8 @@ public class AxEventModel extends AxModel { return copy; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxModel#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -273,10 +255,8 @@ public class AxEventModel extends AxModel { return result; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxModel#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(final Object obj) { @@ -301,12 +281,8 @@ public class AxEventModel extends AxModel { return events.equals(other.events); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxModel#compareTo(org.onap.policy.apex.model.basicmodel.concepts. - * AxConcept) + /** + * {@inheritDoc}. */ @Override public int compareTo(final AxConcept otherObj) { diff --git a/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEvents.java b/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEvents.java index 4ec3af3b3..3d0d9b7f2 100644 --- a/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEvents.java +++ b/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxEvents.java @@ -143,20 +143,16 @@ public class AxEvents extends AxConcept implements AxConceptGetter { eventMap = navigableEventMap; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKey() + /** + * {@inheritDoc}. */ @Override public AxArtifactKey getKey() { return key; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKeys() + /** + * {@inheritDoc}. */ @Override public List getKeys() { @@ -199,12 +195,8 @@ public class AxEvents extends AxConcept implements AxConceptGetter { this.eventMap.putAll(eventMap); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxConcept#validate(org.onap.policy.apex.model.basicmodel.concepts. - * AxValidationResult) + /** + * {@inheritDoc}. */ @Override public AxValidationResult validate(final AxValidationResult resultIn) { @@ -245,10 +237,8 @@ public class AxEvents extends AxConcept implements AxConceptGetter { return result; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#clean() + /** + * {@inheritDoc}. */ @Override public void clean() { @@ -259,10 +249,8 @@ public class AxEvents extends AxConcept implements AxConceptGetter { } } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { @@ -277,12 +265,8 @@ public class AxEvents extends AxConcept implements AxConceptGetter { return builder.toString(); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxConcept#copyTo(org.onap.policy.apex.model.basicmodel.concepts. - * AxConcept) + /** + * {@inheritDoc}. */ @Override public AxConcept copyTo(final AxConcept targetObject) { @@ -302,10 +286,8 @@ public class AxEvents extends AxConcept implements AxConceptGetter { return copy; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -316,10 +298,8 @@ public class AxEvents extends AxConcept implements AxConceptGetter { return result; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(final Object obj) { @@ -341,10 +321,8 @@ public class AxEvents extends AxConcept implements AxConceptGetter { return eventMap.equals(other.eventMap); } - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(final AxConcept otherObj) { @@ -369,31 +347,24 @@ public class AxEvents extends AxConcept implements AxConceptGetter { return 0; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConceptGetter#get(org.onap.policy.apex.model.basicmodel. - * concepts. AxArtifactKey) + /** + * {@inheritDoc}. */ @Override public AxEvent get(final AxArtifactKey conceptKey) { return new AxConceptGetterImpl<>((NavigableMap) eventMap).get(conceptKey); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConceptGetter#get(java.lang.String) + /** + * {@inheritDoc}. */ @Override public AxEvent get(final String conceptKeyName) { return new AxConceptGetterImpl<>((NavigableMap) eventMap).get(conceptKeyName); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConceptGetter#get(java.lang.String, java.lang.String) + /** + * {@inheritDoc}. */ @Override public AxEvent get(final String conceptKeyName, final String conceptKeyVersion) { @@ -401,20 +372,16 @@ public class AxEvents extends AxConcept implements AxConceptGetter { conceptKeyVersion); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConceptGetter#getAll(java.lang.String) + /** + * {@inheritDoc}. */ @Override public Set getAll(final String conceptKeyName) { return new AxConceptGetterImpl<>((NavigableMap) eventMap).getAll(conceptKeyName); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConceptGetter#getAll(java.lang.String, java.lang.String) + /** + * {@inheritDoc}. */ @Override public Set getAll(final String conceptKeyName, final String conceptKeyVersion) { diff --git a/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxField.java b/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxField.java index 300f6beb5..c3f9d3329 100644 --- a/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxField.java +++ b/model/event-model/src/main/java/org/onap/policy/apex/model/eventmodel/concepts/AxField.java @@ -189,20 +189,16 @@ public class AxField extends AxConcept { this.optional = optional; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKey() + /** + * {@inheritDoc}. */ @Override public AxReferenceKey getKey() { return key; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKeys() + /** + * {@inheritDoc}. */ @Override public List getKeys() { @@ -258,12 +254,8 @@ public class AxField extends AxConcept { this.optional = optional; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxConcept#validate(org.onap.policy.apex.model.basicmodel.concepts. - * AxValidationResult) + /** + * {@inheritDoc}. */ @Override public AxValidationResult validate(final AxValidationResult resultIn) { @@ -283,10 +275,8 @@ public class AxField extends AxConcept { return fieldSchemaKey.validate(result); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#clean() + /** + * {@inheritDoc}. */ @Override public void clean() { @@ -294,10 +284,8 @@ public class AxField extends AxConcept { fieldSchemaKey.clean(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { @@ -314,12 +302,8 @@ public class AxField extends AxConcept { return builder.toString(); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxConcept#copyTo(org.onap.policy.apex.model.basicmodel.concepts. - * AxConcept) + /** + * {@inheritDoc}. */ @Override public AxConcept copyTo(final AxConcept targetObject) { @@ -335,10 +319,8 @@ public class AxField extends AxConcept { return copy; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -378,10 +360,8 @@ public class AxField extends AxConcept { return fieldSchemaKey.equals(other.fieldSchemaKey); } - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(final AxConcept otherObj) { -- cgit 1.2.3-korg