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 --- .../contextmodel/concepts/AxContextAlbum.java | 56 +++++--------- .../contextmodel/concepts/AxContextAlbums.java | 87 +++++++--------------- .../contextmodel/concepts/AxContextModel.java | 57 +++++--------- .../contextmodel/concepts/AxContextSchema.java | 56 +++++--------- .../contextmodel/concepts/AxContextSchemas.java | 87 +++++++--------------- 5 files changed, 110 insertions(+), 233 deletions(-) (limited to 'model/context-model/src/main/java') diff --git a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbum.java b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbum.java index 7dddc4099..7e15003a0 100644 --- a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbum.java +++ b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbum.java @@ -163,20 +163,16 @@ public class AxContextAlbum extends AxConcept { this.itemSchema = itemSchema; } - /* - * (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() { @@ -252,11 +248,8 @@ public class AxContextAlbum extends AxConcept { this.itemSchema = itemSchema; } - /* - * (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) { @@ -288,10 +281,8 @@ public class AxContextAlbum extends AxConcept { return result; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#clean() + /** + * {@inheritDoc}. */ @Override public void clean() { @@ -300,10 +291,8 @@ public class AxContextAlbum extends AxConcept { itemSchema.clean(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { @@ -322,11 +311,8 @@ public class AxContextAlbum 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 target) { @@ -344,10 +330,8 @@ public class AxContextAlbum extends AxConcept { return copy; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -360,10 +344,8 @@ public class AxContextAlbum 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) { @@ -391,10 +373,8 @@ public class AxContextAlbum extends AxConcept { return itemSchema.equals(other.itemSchema); } - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(final AxConcept otherObj) { diff --git a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbums.java b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbums.java index ddf363ed3..cbd923b6c 100644 --- a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbums.java +++ b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbums.java @@ -146,20 +146,16 @@ public final class AxContextAlbums extends AxConcept implements AxConceptGetter< albums = navigableAlbums; } - /* - * (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() { @@ -202,10 +198,8 @@ public final class AxContextAlbums extends AxConcept implements AxConceptGetter< this.albums.putAll(albumsMap); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#clean() + /** + * {@inheritDoc}. */ @Override public void clean() { @@ -216,10 +210,8 @@ public final class AxContextAlbums extends AxConcept implements AxConceptGetter< } } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { @@ -236,11 +228,8 @@ public final class AxContextAlbums extends AxConcept implements AxConceptGetter< return builder.toString(); } - /* - * (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) { @@ -286,11 +275,8 @@ public final class AxContextAlbums extends AxConcept implements AxConceptGetter< } } - /* - * (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 target) { @@ -311,10 +297,8 @@ public final class AxContextAlbums extends AxConcept implements AxConceptGetter< return copy; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -325,10 +309,8 @@ public final class AxContextAlbums 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) { @@ -350,10 +332,8 @@ public final class AxContextAlbums extends AxConcept implements AxConceptGetter< return albums.equals(other.albums); } - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(final AxConcept otherObj) { @@ -378,31 +358,24 @@ public final class AxContextAlbums 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 AxContextAlbum get(final AxArtifactKey conceptKey) { return new AxConceptGetterImpl<>((NavigableMap) albums).get(conceptKey); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConceptGetter#get(java.lang.String) + /** + * {@inheritDoc}. */ @Override public AxContextAlbum get(final String conceptKeyName) { return new AxConceptGetterImpl<>((NavigableMap) albums).get(conceptKeyName); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConceptGetter#get(java.lang.String, java.lang.String) + /** + * {@inheritDoc}. */ @Override public AxContextAlbum get(final String conceptKeyName, final String conceptKeyVersion) { @@ -410,20 +383,16 @@ public final class AxContextAlbums 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) albums).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/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextModel.java b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextModel.java index 17980ed65..da04aad83 100644 --- a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextModel.java +++ b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextModel.java @@ -140,10 +140,8 @@ public class AxContextModel extends AxModel { this.albums = albums; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxModel#register() + /** + * {@inheritDoc}. */ @Override public void register() { @@ -152,10 +150,8 @@ public class AxContextModel extends AxModel { ModelService.registerModel(AxContextAlbums.class, getAlbums()); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxModel#getKeys() + /** + * {@inheritDoc}. */ @Override public List getKeys() { @@ -205,11 +201,8 @@ public class AxContextModel extends AxModel { this.albums = albums; } - /* - * (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) { @@ -220,10 +213,8 @@ public class AxContextModel extends AxModel { return albums.validate(result); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxModel#clean() + /** + * {@inheritDoc}. */ @Override public void clean() { @@ -232,10 +223,8 @@ public class AxContextModel extends AxModel { albums.clean(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxModel#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { @@ -251,11 +240,8 @@ public class AxContextModel 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 target) { @@ -272,10 +258,8 @@ public class AxContextModel extends AxModel { return copy; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxModel#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -287,10 +271,8 @@ public class AxContextModel 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) { @@ -315,11 +297,8 @@ public class AxContextModel extends AxModel { return albums.equals(other.albums); } - /* - * (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/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchema.java b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchema.java index f2e3dc3cf..17629605e 100644 --- a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchema.java +++ b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchema.java @@ -145,20 +145,16 @@ public class AxContextSchema extends AxConcept { this.schemaDefinition = schemaDefinition.replaceAll(WHITESPACE_REGEXP, ""); } - /* - * (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() { @@ -212,11 +208,8 @@ public class AxContextSchema extends AxConcept { this.schemaDefinition = schema.replaceAll(WHITESPACE_REGEXP, ""); } - /* - * (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) { @@ -250,10 +243,8 @@ public class AxContextSchema extends AxConcept { return result; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#clean() + /** + * {@inheritDoc}. */ @Override public void clean() { @@ -262,10 +253,8 @@ public class AxContextSchema extends AxConcept { schemaDefinition = schemaDefinition.replaceAll(WHITESPACE_REGEXP, ""); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { @@ -282,11 +271,8 @@ public class AxContextSchema 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 target) { @@ -303,10 +289,8 @@ public class AxContextSchema extends AxConcept { return copy; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -318,10 +302,8 @@ public class AxContextSchema 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) { @@ -349,10 +331,8 @@ public class AxContextSchema extends AxConcept { return thisSchema.equals(otherSchema); } - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(final AxConcept otherObj) { diff --git a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchemas.java b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchemas.java index b2456bfbf..5bd0c1f5e 100644 --- a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchemas.java +++ b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchemas.java @@ -145,20 +145,16 @@ public class AxContextSchemas extends AxConcept implements AxConceptGetter getKeys() { @@ -199,11 +195,8 @@ public class AxContextSchemas extends AxConcept implements AxConceptGetter((NavigableMap) schemas).get(conceptKey); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.basicmodel.concepts.AxConceptGetter#get(java.lang.String) + /** + * {@inheritDoc}. */ @Override public AxContextSchema get(final String conceptKeyName) { return new AxConceptGetterImpl<>((NavigableMap) schemas).get(conceptKeyName); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.basicmodel.concepts.AxConceptGetter#get(java.lang.String, java.lang.String) + /** + * {@inheritDoc}. */ @Override public AxContextSchema get(final String conceptKeyName, final String conceptKeyVersion) { @@ -401,20 +374,16 @@ public class AxContextSchemas extends AxConcept implements AxConceptGetter getAll(final String conceptKeyName) { return new AxConceptGetterImpl<>((NavigableMap) schemas).getAll(conceptKeyName); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.basicmodel.concepts.AxConceptGetter#getAll(java.lang.String, java.lang.String) + /** + * {@inheritDoc}. */ @Override public Set getAll(final String conceptKeyName, final String conceptKeyVersion) { -- cgit 1.2.3-korg