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 --- .../context/schema/avro/AvroArrayObjectMapper.java | 7 +--- .../context/schema/avro/AvroBytesObjectMapper.java | 41 ++++++-------------- .../schema/avro/AvroDirectObjectMapper.java | 41 ++++++-------------- .../context/schema/avro/AvroEnumObjectMapper.java | 7 +--- .../context/schema/avro/AvroNullableMapper.java | 44 ++++++---------------- .../schema/avro/AvroRecordObjectMapper.java | 7 +--- .../schema/avro/AvroStringObjectMapper.java | 41 ++++++-------------- 7 files changed, 54 insertions(+), 134 deletions(-) (limited to 'plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro') diff --git a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroArrayObjectMapper.java b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroArrayObjectMapper.java index 56d84251f..69043b3bb 100644 --- a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroArrayObjectMapper.java +++ b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroArrayObjectMapper.java @@ -30,11 +30,8 @@ import org.apache.avro.generic.GenericData.Array; * @author Liam Fallon (liam.fallon@ericsson.com) */ public class AvroArrayObjectMapper extends AvroDirectObjectMapper { - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#createNewinstance(org. - * apache.avro.Schema) + /** + * {@inheritDoc}. */ @SuppressWarnings("rawtypes") @Override diff --git a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroBytesObjectMapper.java b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroBytesObjectMapper.java index bee2f5957..d8d0d8c19 100644 --- a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroBytesObjectMapper.java +++ b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroBytesObjectMapper.java @@ -45,22 +45,16 @@ public class AvroBytesObjectMapper implements AvroObjectMapper { // The Apex compatible class private static final Class schemaClass = Byte[].class; - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#getJavaClass() + /** + * {@inheritDoc}. */ @Override public Class getJavaClass() { return schemaClass; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#setAvroType(org.apache. - * avro. Schema.Type) + /** + * {@inheritDoc}. */ @Override public void init(final AxKey intUserKey, final Type initAvroType) { @@ -68,11 +62,8 @@ public class AvroBytesObjectMapper implements AvroObjectMapper { this.avroType = initAvroType; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#createNewinstance(org. - * apache. avro.Schema) + /** + * {@inheritDoc}. */ @Override public Object createNewInstance(final Schema avroSchema) { @@ -81,21 +72,16 @@ public class AvroBytesObjectMapper implements AvroObjectMapper { return null; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#getAvroType() + /** + * {@inheritDoc}. */ @Override public Type getAvroType() { return avroType; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#mapFromAvro(java.lang. - * Object) + /** + * {@inheritDoc}. */ @Override public Object mapFromAvro(final Object avroObject) { @@ -118,11 +104,8 @@ public class AvroBytesObjectMapper implements AvroObjectMapper { return byteArray; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#mapToAvro(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public Object mapToAvro(final Object object) { diff --git a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroDirectObjectMapper.java b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroDirectObjectMapper.java index ca771d957..f627651fa 100644 --- a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroDirectObjectMapper.java +++ b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroDirectObjectMapper.java @@ -69,22 +69,16 @@ public class AvroDirectObjectMapper implements AvroObjectMapper { // The Apex compatible class private Class schemaClass; - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#getJavaClass() + /** + * {@inheritDoc}. */ @Override public Class getJavaClass() { return schemaClass; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#setAvroType(org.apache. - * avro. Schema.Type) + /** + * {@inheritDoc}. */ @Override public void init(final AxKey initUserKey, final Type initAvroType) { @@ -93,11 +87,8 @@ public class AvroDirectObjectMapper implements AvroObjectMapper { schemaClass = AVRO_JAVA_TYPE_MAP.get(avroType); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#createNewinstance(org. - * apache. avro.Schema) + /** + * {@inheritDoc}. */ @Override public Object createNewInstance(final Schema avroSchema) { @@ -105,21 +96,16 @@ public class AvroDirectObjectMapper implements AvroObjectMapper { return null; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#getAvroType() + /** + * {@inheritDoc}. */ @Override public Type getAvroType() { return avroType; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#mapFromAvro(java.lang. - * Object) + /** + * {@inheritDoc}. */ @Override public Object mapFromAvro(final Object avroObject) { @@ -141,11 +127,8 @@ public class AvroDirectObjectMapper implements AvroObjectMapper { return avroObject; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#mapToAvro(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public Object mapToAvro(final Object object) { diff --git a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroEnumObjectMapper.java b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroEnumObjectMapper.java index ec84450d5..cfdd2ed76 100644 --- a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroEnumObjectMapper.java +++ b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroEnumObjectMapper.java @@ -32,11 +32,8 @@ import org.apache.avro.generic.GenericData.EnumSymbol; * @author Liam Fallon (liam.fallon@ericsson.com) */ public class AvroEnumObjectMapper extends AvroDirectObjectMapper { - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#createNewinstance(org. - * apache.avro.Schema) + /** + * {@inheritDoc}. */ @Override public Object createNewInstance(final Schema avroSchema) { diff --git a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroNullableMapper.java b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroNullableMapper.java index ff8806c86..1196cf6d9 100644 --- a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroNullableMapper.java +++ b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroNullableMapper.java @@ -44,56 +44,40 @@ public class AvroNullableMapper extends AvroDirectObjectMapper { this.wrappedMapper = wrappedMapper; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroDirectObjectMapper#getJavaClass() + /** + * {@inheritDoc}. */ @Override public Class getJavaClass() { return wrappedMapper.getJavaClass(); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.plugins.context.schema.avro.AvroDirectObjectMapper#init(org.onap.policy. - * apex. model.basicmodel.concepts.AxKey, org.apache.avro.Schema.Type) + /** + * {@inheritDoc}. */ @Override public void init(final AxKey userKey, final Type avroType) { wrappedMapper.init(userKey, avroType); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.plugins.context.schema.avro.AvroDirectObjectMapper#createNewInstance( - * org. apache.avro.Schema) + /** + * {@inheritDoc}. */ @Override public Object createNewInstance(final Schema avroSchema) { return wrappedMapper.createNewInstance(avroSchema); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroDirectObjectMapper#getAvroType() + /** + * {@inheritDoc}. */ @Override public Type getAvroType() { return Schema.Type.UNION; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.plugins.context.schema.avro.AvroDirectObjectMapper#mapFromAvro(java. - * lang. Object) + /** + * {@inheritDoc}. */ @Override public Object mapFromAvro(final Object avroObject) { @@ -104,12 +88,8 @@ public class AvroNullableMapper extends AvroDirectObjectMapper { } } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.plugins.context.schema.avro.AvroDirectObjectMapper#mapToAvro(java.lang. - * Object) + /** + * {@inheritDoc}. */ @Override public Object mapToAvro(final Object object) { diff --git a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroRecordObjectMapper.java b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroRecordObjectMapper.java index 9d24a9a86..9092dca36 100644 --- a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroRecordObjectMapper.java +++ b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroRecordObjectMapper.java @@ -30,11 +30,8 @@ import org.apache.avro.generic.GenericData.Record; * @author Liam Fallon (liam.fallon@ericsson.com) */ public class AvroRecordObjectMapper extends AvroDirectObjectMapper { - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#createNewinstance(org. - * apache. avro.Schema) + /** + * {@inheritDoc}. */ @Override public Object createNewInstance(final Schema avroSchema) { diff --git a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroStringObjectMapper.java b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroStringObjectMapper.java index a9acb1c12..46e6c43ef 100644 --- a/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroStringObjectMapper.java +++ b/plugins/plugins-context/plugins-context-schema/plugins-context-schema-avro/src/main/java/org/onap/policy/apex/plugins/context/schema/avro/AvroStringObjectMapper.java @@ -44,22 +44,16 @@ public class AvroStringObjectMapper implements AvroObjectMapper { // The Apex compatible class private static final Class schemaClass = String.class; - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#getJavaClass() + /** + * {@inheritDoc}. */ @Override public Class getJavaClass() { return schemaClass; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#setAvroType(org.apache. - * avro. Schema.Type) + /** + * {@inheritDoc}. */ @Override public void init(final AxKey initUserKey, final Type initAvroType) { @@ -67,11 +61,8 @@ public class AvroStringObjectMapper implements AvroObjectMapper { this.avroType = initAvroType; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#createNewinstance(org. - * apache. avro.Schema) + /** + * {@inheritDoc}. */ @Override public Object createNewInstance(final Schema avroSchema) { @@ -80,21 +71,16 @@ public class AvroStringObjectMapper implements AvroObjectMapper { return null; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#getAvroType() + /** + * {@inheritDoc}. */ @Override public Type getAvroType() { return avroType; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#mapFromAvro(java.lang. - * Object) + /** + * {@inheritDoc}. */ @Override public Object mapFromAvro(final Object avroObject) { @@ -110,11 +96,8 @@ public class AvroStringObjectMapper implements AvroObjectMapper { return avroObject.toString(); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.plugins.context.schema.avro.AvroObjectMapper#mapToAvro(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public Object mapToAvro(final Object object) { -- cgit 1.2.3-korg