From: Robert Varga Date: Sat, 28 Mar 2015 17:15:06 +0000 (+0100) Subject: Fix Java 8 javadoc compatibility X-Git-Tag: release/lithium~41 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=c0b0278f0a4e8b784131f9aac9faf9335223848b;p=openflowjava.git Fix Java 8 javadoc compatibility Java 8 is more picky about javadocs -- make sure we can pass compilation. Change-Id: I816b25cc439cc7eadd8e073205611cb15ab95e9b Signed-off-by: Robert Varga --- diff --git a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerExtensionProvider.java b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerExtensionProvider.java index abd85ba5..b38b5cfa 100644 --- a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerExtensionProvider.java +++ b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerExtensionProvider.java @@ -24,7 +24,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731 * In case of handling multiple multiple structures of same type (actions, * instructions, match entries, ... ) which are differentiated by * vendor / experimenter subtype, vendor has to switch / choose between - * these subtypes.
+ * these subtypes.
* * This has to be done in this way because of experimenter headers, which * provide only vendor / experimenter ID. Subtype position may be different @@ -113,4 +113,4 @@ public interface DeserializerExtensionProvider { */ void registerQueuePropertyDeserializer(ExperimenterIdDeserializerKey key, OFDeserializer deserializer); -} \ No newline at end of file +} diff --git a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerRegistry.java b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerRegistry.java index 04291b8f..6970a1dc 100644 --- a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerRegistry.java +++ b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/DeserializerRegistry.java @@ -45,7 +45,6 @@ public interface DeserializerRegistry { /** * Unregisters deserializer * @param key used for deserializer lookup - * @param deserializer deserializer instance * @return true if deserializer was removed, * false if no deserializer was found under specified key */ diff --git a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/SerializerExtensionProvider.java b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/SerializerExtensionProvider.java index 9e73e951..7d83cd82 100644 --- a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/SerializerExtensionProvider.java +++ b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/SerializerExtensionProvider.java @@ -26,7 +26,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731 * In case of handling multiple structures of same type (actions, * instructions, match entries, ... ) which are differentiated by * vendor / experimenter subtype, vendor has to switch / choose between - * these subtypes.
+ * these subtypes.
* * This has to be done in this way because of unknown augmentations * - that's why vendor has to handle it in his own implementations. @@ -97,4 +97,4 @@ public interface SerializerExtensionProvider { */ void registerMeterBandSerializer(ExperimenterIdSerializerKey key, OFSerializer serializer); -} \ No newline at end of file +} diff --git a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/SerializerRegistry.java b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/SerializerRegistry.java index 716281c4..7fb39bbd 100644 --- a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/SerializerRegistry.java +++ b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/SerializerRegistry.java @@ -9,22 +9,18 @@ package org.opendaylight.openflowjava.protocol.api.extensibility; import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey; - - - /** - * Stores and handles serializers
- * K - {@link MessageTypeKey} parameter type,
+ * Stores and handles serializers
+ * K - {@link MessageTypeKey} parameter type,
* S - returned serializer type * @author michal.polkorab - * */ public interface SerializerRegistry { /** * Serializer registry provisioning */ - public void init(); + void init(); /** * @param msgTypeKey lookup key @@ -49,7 +45,6 @@ public interface SerializerRegistry { /** * Unregisters serializer * @param key used for serializer lookup - * @param serializer serializer implementation * @return true if serializer was removed, * false if no serializer was found under specified key */ diff --git a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/InstructionSerializerKey.java b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/InstructionSerializerKey.java index 89f5cbfe..213b22db 100644 --- a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/InstructionSerializerKey.java +++ b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/InstructionSerializerKey.java @@ -23,7 +23,6 @@ public class InstructionSerializerKey /** * @param msgVersion protocol wire version - * @param objectType class of serialized object (Instruction.class) * @param instructionType type of instruction * @param experimenterId experimenter / vendor ID */ @@ -77,4 +76,4 @@ public class InstructionSerializerKey return super.toString() + " instructionType type: " + instructionType.getName() + " vendorID: " + experimenterId; } -} \ No newline at end of file +} diff --git a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/MatchEntrySerializerKey.java b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/MatchEntrySerializerKey.java index a0867ceb..75fcd3e6 100644 --- a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/MatchEntrySerializerKey.java +++ b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/MatchEntrySerializerKey.java @@ -26,7 +26,6 @@ public final class MatchEntrySerializerKey - * C - {@link MatchEntrySerializerKey} parameter representing oxm_class (see specification)
+ * Exposed class for server handling
+ * C - {@link MatchEntrySerializerKey} parameter representing oxm_class (see specification)
* F - {@link MatchEntrySerializerKey} parameter representing oxm_field (see specification) * @author mirehak * @author michal.polkorab diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/serialization/SerializerRegistryImpl.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/serialization/SerializerRegistryImpl.java index 26cdda1a..9a4c2085 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/serialization/SerializerRegistryImpl.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/serialization/SerializerRegistryImpl.java @@ -24,8 +24,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Stores and handles serializers
- * K - {@link MessageTypeKey} type
+ * Stores and handles serializers
+ * K - {@link MessageTypeKey} type
* S - returned serializer type * @author michal.polkorab * @author timotej.kubas diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/AbstractCodeKeyMaker.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/AbstractCodeKeyMaker.java index 45f521e1..7aff0aa7 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/AbstractCodeKeyMaker.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/AbstractCodeKeyMaker.java @@ -5,13 +5,10 @@ * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ - package org.opendaylight.openflowjava.protocol.impl.util; - /** * @author michal.polkorab - * @param type the key maker is based on */ public abstract class AbstractCodeKeyMaker implements CodeKeyMaker { diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionConstants.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionConstants.java index d05b8cd8..41791780 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionConstants.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionConstants.java @@ -14,7 +14,7 @@ package org.opendaylight.openflowjava.protocol.impl.util; */ public final class ActionConstants { - /** Openflow v1.0 & v1.3 OFPAT_OUTPUT code */ + /** Openflow v1.0 and v1.3 OFPAT_OUTPUT code */ public static final byte OUTPUT_CODE = 0; /** Openflow v1.0 OFPAT_SET_VLAN_VID code */ public static final byte SET_VLAN_VID_CODE = 1; @@ -96,7 +96,7 @@ public final class ActionConstants { /** Most common action length */ public static final byte GENERAL_ACTION_LENGTH = 8; /** Action larger than GENERAL_ACTION_LENGTH - currently - * only 16 bytes long actions for both OF v1.0 & v1.3*/ + * only 16 bytes long actions for both OF v1.0 and v1.3*/ public static final byte LARGER_ACTION_LENGTH = 16; /** Action header size */ public static final byte ACTION_IDS_LENGTH = 4; diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionDeserializerRegistryHelper.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionDeserializerRegistryHelper.java index 2f48763a..49c1b6fc 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionDeserializerRegistryHelper.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionDeserializerRegistryHelper.java @@ -32,8 +32,6 @@ public class ActionDeserializerRegistryHelper { /** * @param code code / value to distinguish between deserializers * @param deserializer deserializer instance - * @param deserializedObjectClass class of object that will be deserialized - * by given deserializer */ public void registerDeserializer(int code, OFGeneralDeserializer deserializer) { registry.registerDeserializer(new ActionDeserializerKey(version, code, diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionSerializerRegistryHelper.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionSerializerRegistryHelper.java index 32b6ac0e..b622dd17 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionSerializerRegistryHelper.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ActionSerializerRegistryHelper.java @@ -22,7 +22,6 @@ public class ActionSerializerRegistryHelper { /** * @param version Openflow wire version - * @param objectType * @param serializerRegistry */ public ActionSerializerRegistryHelper(short version, SerializerRegistry serializerRegistry) { @@ -40,4 +39,4 @@ public class ActionSerializerRegistryHelper { serializerRegistry.registerSerializer(new ActionSerializerKey<>(version, actionType, null), serializer); } -} \ No newline at end of file +} diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/InstructionDeserializerRegistryHelper.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/InstructionDeserializerRegistryHelper.java index 44a6a884..19149e10 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/InstructionDeserializerRegistryHelper.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/InstructionDeserializerRegistryHelper.java @@ -32,8 +32,6 @@ public class InstructionDeserializerRegistryHelper { /** * @param code code / value to distinguish between deserializers * @param deserializer deserializer instance - * @param deserializedObjectClass class of object that will be deserialized - * by given deserializer */ public void registerDeserializer(int code, OFGeneralDeserializer deserializer) { registry.registerDeserializer(new InstructionDeserializerKey(version, code, diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ListSerializer.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ListSerializer.java index 7925281b..7392be76 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ListSerializer.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ListSerializer.java @@ -20,7 +20,6 @@ import org.opendaylight.yangtools.yang.binding.DataObject; /** * Serializes list items and their headers * @author michal.polkorab - * @param */ public abstract class ListSerializer { diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/TypeToClassInitHelper.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/TypeToClassInitHelper.java index 672cdea6..339edd18 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/TypeToClassInitHelper.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/TypeToClassInitHelper.java @@ -32,7 +32,7 @@ public class TypeToClassInitHelper { /** * Registers Class int the type to class mapping * @param type code value for message type / class - * @param clazz corresponding code -> class + * @param clazz class corresponding to the code */ public void registerTypeToClass(short type, Class clazz) { messageClassMap.put(new TypeToClassKey(version, type), clazz); diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/statistics/StatisticsCounters.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/statistics/StatisticsCounters.java index 89eeff92..f3566a09 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/statistics/StatisticsCounters.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/statistics/StatisticsCounters.java @@ -186,8 +186,8 @@ public final class StatisticsCounters implements StatisticsHandler { /** * Get counter by CounterEventType * @param counterEventKey key to identify counter (can not be null) - * @return - Counter object or null if counter has not been enabled - * @exception - IllegalArgumentException if counterEventKey is null + * @return Counter object or null if counter has not been enabled + * @throws IllegalArgumentException if counterEventKey is null */ public Counter getCounter(CounterEventTypes counterEventKey) { if (counterEventKey == null) { @@ -245,4 +245,4 @@ public final class StatisticsCounters implements StatisticsHandler { } } } -} \ No newline at end of file +} diff --git a/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ListeningSimpleClient.java b/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ListeningSimpleClient.java index 0288745f..559c2279 100644 --- a/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ListeningSimpleClient.java +++ b/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ListeningSimpleClient.java @@ -1,3 +1,10 @@ +/* + * Copyright (c) 2015 Pantheon Technologies s.r.o. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ package org.opendaylight.openflowjava.protocol.impl.clients; import io.netty.bootstrap.ServerBootstrap; @@ -33,7 +40,6 @@ public class ListeningSimpleClient implements OFClient { /** * Constructor of the class * - * @param host address of host * @param port host listening port */ public ListeningSimpleClient(int port) { @@ -121,4 +127,4 @@ public class ListeningSimpleClient implements OFClient { public int getPort() { return this.port; } -} \ No newline at end of file +} diff --git a/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ScenarioFactory.java b/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ScenarioFactory.java index f0e5b9cf..5b4e669a 100644 --- a/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ScenarioFactory.java +++ b/simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/ScenarioFactory.java @@ -25,8 +25,8 @@ public final class ScenarioFactory { } /** - * Creates stack with handshake needed messages. - *
    XID of messages: + * Creates stack with handshake needed messages. XID of messages: + *
      *
    1. hello sent - 00000001 *
    2. hello waiting - 00000002 *
    3. featuresrequest waiting - 00000003 @@ -45,8 +45,8 @@ public final class ScenarioFactory { } /** - * Creates stack with handshake needed messages. - *
        XID of messages: + * Creates stack with handshake needed messages. XID of messages: + *
          *
        1. hello sent - 00000001 *
        2. hello waiting - 00000002 *
        3. featuresrequest waiting - 00000003 diff --git a/util/src/main/java/org/opendaylight/openflowjava/util/ByteBufUtils.java b/util/src/main/java/org/opendaylight/openflowjava/util/ByteBufUtils.java index 43ced124..61344291 100644 --- a/util/src/main/java/org/opendaylight/openflowjava/util/ByteBufUtils.java +++ b/util/src/main/java/org/opendaylight/openflowjava/util/ByteBufUtils.java @@ -224,10 +224,11 @@ public abstract class ByteBufUtils { } /** - * Converts macAddress to byte array + * Converts macAddress to byte array. + * See also {@link org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress}. + * * @param macAddress * @return byte representation of mac address - * @see {@link org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress} */ public static byte[] macAddressToBytes(final String macAddress) { final byte[] result = new byte[EncodeConstants.MAC_ADDRESS_LENGTH]; @@ -279,10 +280,11 @@ public abstract class ByteBufUtils { } /** - * Converts a MAC address represented in bytes to String + * Converts a MAC address represented in bytes to String. + * See also {@link org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress}. + * * @param address * @return String representation of a MAC address - * @see {@link MacAddress} */ public static String macAddressToString(final byte[] address) { Preconditions.checkArgument(address.length == EncodeConstants.MAC_ADDRESS_LENGTH);