From dab5b6e45ed8f2a8630cdfc47fdbff622d081bb0 Mon Sep 17 00:00:00 2001 From: Martin Uhlir Date: Fri, 23 Jan 2015 13:54:24 +0100 Subject: [PATCH] Bug 2245 - Changed type parameters to comply with naming conventions Change-Id: I0593538542f6e4ee295b12b19b60058a666a8b04 Signed-off-by: Martin Uhlir --- .../api/extensibility/DeserializerRegistry.java | 4 ++-- .../api/extensibility/HeaderSerializer.java | 6 +++--- .../protocol/api/extensibility/OFSerializer.java | 6 +++--- .../SerializerExtensionProvider.java | 4 ++-- .../api/extensibility/SerializerRegistry.java | 11 ++++++----- .../protocol/api/keys/ActionSerializerKey.java | 8 ++++---- .../api/keys/InstructionSerializerKey.java | 8 ++++---- .../api/keys/MatchEntrySerializerKey.java | 14 +++++++------- .../ExperimenterIdSerializerKey.java | 6 +++--- .../impl/core/ProtocolChannelInitializer.java | 6 +++--- .../impl/core/SwitchConnectionProviderImpl.java | 6 ++++-- .../DeserializerRegistryImpl.java | 4 ++-- .../serialization/SerializerRegistryImpl.java | 16 +++++++++------- .../util/ActionSerializerRegistryHelper.java | 2 +- .../InstructionSerializerRegistryHelper.java | 2 +- .../util/MatchEntrySerializerRegistryHelper.java | 12 ++++++------ 16 files changed, 60 insertions(+), 55 deletions(-) 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 aa92ea08..8b1b0aec 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 @@ -23,8 +23,8 @@ public interface DeserializerRegistry { * @param key used for deserializer lookup * @return deserializer found */ - - SERIALIZERTYPE getDeserializer(MessageCodeKey key); + + T getDeserializer(MessageCodeKey key); /** * Registers deserializer. diff --git a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/HeaderSerializer.java b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/HeaderSerializer.java index d1966fb1..1e047c09 100644 --- a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/HeaderSerializer.java +++ b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/HeaderSerializer.java @@ -14,14 +14,14 @@ import io.netty.buffer.ByteBuf; /** * Does only-header serialization (such as oxm_ids, action_ids, instruction_ids) * @author michal.polkorab - * @param + * @param */ -public interface HeaderSerializer extends OFGeneralSerializer { +public interface HeaderSerializer extends OFGeneralSerializer { /** * Serializes object headers (e.g. for Multipart message - Table Features) * @param input object whose headers should be serialized * @param outBuffer output buffer */ - void serializeHeader(SERIALIZER_TYPE input, ByteBuf outBuffer); + void serializeHeader(T input, ByteBuf outBuffer); } diff --git a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/OFSerializer.java b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/OFSerializer.java index ad463f45..6b2ef473 100644 --- a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/OFSerializer.java +++ b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/extensibility/OFSerializer.java @@ -16,15 +16,15 @@ import io.netty.buffer.ByteBuf; * Uniform interface for serializers * @author michal.polkorab * @author timotej.kubas - * @param message type + * @param message type */ -public interface OFSerializer extends OFGeneralSerializer { +public interface OFSerializer extends OFGeneralSerializer { /** * Transforms POJO/DTO into byte message (ByteBuf). * @param input object to be serialized * @param outBuffer output buffer */ - void serialize(SERIALIZER_TYPE input, ByteBuf outBuffer); + void serialize(T input, ByteBuf outBuffer); } 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 f4325cff..face97bc 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 @@ -63,8 +63,8 @@ public interface SerializerExtensionProvider { * @param key used for serializer lookup * @param serializer serializer implementation */ - void registerMatchEntrySerializer( - MatchEntrySerializerKey key,OFGeneralSerializer serializer); + void registerMatchEntrySerializer( + MatchEntrySerializerKey key,OFGeneralSerializer serializer); /** * Registers experimenter (vendor) message serializer 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 eaa52c3d..75ba9f29 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 @@ -11,7 +11,9 @@ package org.opendaylight.openflowjava.protocol.api.extensibility; /** - * Stores and handles serializers + * Stores and handles serializers
+ * K - {@link MessageTypeKey} parameter type,
+ * S - returned serializer type * @author michal.polkorab * */ @@ -26,8 +28,7 @@ public interface SerializerRegistry { * @param msgTypeKey lookup key * @return serializer or NullPointerException if no serializer was found */ - SERIALIZERTYPE - getSerializer(MessageTypeKey msgTypeKey); + S getSerializer(MessageTypeKey msgTypeKey); /** * Registers serializer @@ -40,7 +41,7 @@ public interface SerializerRegistry { * @param key used for serializer lookup * @param serializer serializer implementation */ - void registerSerializer(MessageTypeKey key, + void registerSerializer(MessageTypeKey key, OFGeneralSerializer serializer); /** @@ -50,5 +51,5 @@ public interface SerializerRegistry { * @return true if serializer was removed, * false if no serializer was found under specified key */ - boolean unregisterSerializer(MessageTypeKey key); + boolean unregisterSerializer(MessageTypeKey key); } diff --git a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/ActionSerializerKey.java b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/ActionSerializerKey.java index d1120467..52f0155b 100644 --- a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/ActionSerializerKey.java +++ b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/ActionSerializerKey.java @@ -14,11 +14,11 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev13 /** * @author michal.polkorab - * @param action type + * @param action type */ -public class ActionSerializerKey extends MessageTypeKey { +public class ActionSerializerKey extends MessageTypeKey { - private Class actionType; + private Class actionType; private Long experimenterId; /** @@ -26,7 +26,7 @@ public class ActionSerializerKey extends MessageTypeKey * @param actionType type of action * @param experimenterId experimenter / vendor ID */ - public ActionSerializerKey(short msgVersion, Class actionType, + public ActionSerializerKey(short msgVersion, Class actionType, Long experimenterId) { super(msgVersion, Action.class); this.actionType = actionType; 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 73d0f153..4da4489e 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 @@ -14,12 +14,12 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev13 /** * @author michal.polkorab - * @param action type + * @param instruction type */ -public class InstructionSerializerKey +public class InstructionSerializerKey extends MessageTypeKey{ - private Class instructionType; + private Class instructionType; private Long experimenterId; /** @@ -28,7 +28,7 @@ public class InstructionSerializerKey * @param instructionType type of instruction * @param experimenterId experimenter / vendor ID */ - public InstructionSerializerKey(short msgVersion, Class instructionType, + public InstructionSerializerKey(short msgVersion, Class instructionType, Long experimenterId) { super(msgVersion, Instruction.class); this.instructionType = instructionType; 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 fddc35c6..ec06f47a 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 @@ -16,14 +16,14 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.oxm. /** * @author michal.polkorab - * @param oxm_class (see specification) - * @param oxm_field (see specification) + * @param oxm_class (see specification) + * @param oxm_field (see specification) */ -public final class MatchEntrySerializerKey +public final class MatchEntrySerializerKey extends MessageTypeKey implements ExperimenterSerializerKey { - private Class oxmClass; - private Class oxmField; + private Class oxmClass; + private Class oxmField; private Long experimenterId; /** @@ -32,8 +32,8 @@ public final class MatchEntrySerializerKey oxmClass, - Class oxmField) { + public MatchEntrySerializerKey(short msgVersion, Class oxmClass, + Class oxmField) { super(msgVersion, MatchEntries.class); this.oxmClass = oxmClass; this.oxmField = oxmField; diff --git a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/experimenter/ExperimenterIdSerializerKey.java b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/experimenter/ExperimenterIdSerializerKey.java index 1718246c..d667a423 100644 --- a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/experimenter/ExperimenterIdSerializerKey.java +++ b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/keys/experimenter/ExperimenterIdSerializerKey.java @@ -13,9 +13,9 @@ import org.opendaylight.yangtools.yang.binding.DataObject; /** * @author michal.polkorab - * @param class of object to be serialized + * @param class of object to be serialized */ -public class ExperimenterIdSerializerKey extends MessageTypeKey +public class ExperimenterIdSerializerKey extends MessageTypeKey implements ExperimenterSerializerKey { private Long experimenterId; @@ -26,7 +26,7 @@ public class ExperimenterIdSerializerKey extends Messag * @param objectClass class of object to be serialized */ public ExperimenterIdSerializerKey(short msgVersion, - Long experimenterId, Class objectClass) { + Long experimenterId, Class objectClass) { super(msgVersion, objectClass); this.experimenterId = experimenterId; } diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/core/ProtocolChannelInitializer.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/core/ProtocolChannelInitializer.java index 2c1d7899..f450c064 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/core/ProtocolChannelInitializer.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/core/ProtocolChannelInitializer.java @@ -17,11 +17,11 @@ import org.opendaylight.openflowjava.protocol.impl.deserialization.Deserializati import org.opendaylight.openflowjava.protocol.impl.serialization.SerializationFactory; /** - * @param Channel type + * @param Channel type * @author michal.polkorab */ -public abstract class ProtocolChannelInitializer - extends ChannelInitializer { +public abstract class ProtocolChannelInitializer + extends ChannelInitializer { private SwitchConnectionHandler switchConnectionHandler; private long switchIdleTimeout; diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/core/SwitchConnectionProviderImpl.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/core/SwitchConnectionProviderImpl.java index c016aee3..f750d4d1 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/core/SwitchConnectionProviderImpl.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/core/SwitchConnectionProviderImpl.java @@ -52,7 +52,9 @@ import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.SettableFuture; /** - * Exposed class for server handling + * 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 */ @@ -193,7 +195,7 @@ public class SwitchConnectionProviderImpl implements SwitchConnectionProvider { } @Override - public void registerMatchEntrySerializer(MatchEntrySerializerKey key, + public void registerMatchEntrySerializer(MatchEntrySerializerKey key, OFGeneralSerializer serializer) { serializerRegistry.registerSerializer(key, serializer); } diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/DeserializerRegistryImpl.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/DeserializerRegistryImpl.java index 5c7ad39c..9000e988 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/DeserializerRegistryImpl.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/DeserializerRegistryImpl.java @@ -57,14 +57,14 @@ public class DeserializerRegistryImpl implements DeserializerRegistry { @Override @SuppressWarnings("unchecked") - public DESERIALIZER_TYPE getDeserializer( + public T getDeserializer( MessageCodeKey key) { OFGeneralDeserializer deserializer = registry.get(key); if (deserializer == null) { throw new IllegalStateException("Deserializer for key: " + key + " was not found - please verify that all needed deserializers ale loaded correctly"); } - return (DESERIALIZER_TYPE) deserializer; + return (T) deserializer; } @Override 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 06019394..4d91deca 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,7 +24,9 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Stores and handles serializers + * Stores and handles serializers
+ * K - {@link MessageTypeKey} type
+ * S - returned serializer type * @author michal.polkorab * @author timotej.kubas */ @@ -60,20 +62,20 @@ public class SerializerRegistryImpl implements SerializerRegistry { */ @Override @SuppressWarnings("unchecked") - public SERIALIZER_TYPE getSerializer( - MessageTypeKey msgTypeKey) { + public S getSerializer( + MessageTypeKey msgTypeKey) { OFGeneralSerializer serializer = registry.get(msgTypeKey); if (serializer == null) { throw new IllegalStateException("Serializer for key: " + msgTypeKey + " was not found - please verify that you are using correct message" + " combination (e.g. OF v1.0 message to OF v1.0 device)"); } - return (SERIALIZER_TYPE) serializer; + return (S) serializer; } @Override - public void registerSerializer( - MessageTypeKey msgTypeKey, OFGeneralSerializer serializer) { + public void registerSerializer( + MessageTypeKey msgTypeKey, OFGeneralSerializer serializer) { if ((msgTypeKey == null) || (serializer == null)) { throw new IllegalArgumentException("MessageTypeKey or Serializer is null"); } @@ -89,7 +91,7 @@ public class SerializerRegistryImpl implements SerializerRegistry { } @Override - public boolean unregisterSerializer(MessageTypeKey msgTypeKey) { + public boolean unregisterSerializer(MessageTypeKey msgTypeKey) { if (msgTypeKey == null) { throw new IllegalArgumentException("MessageTypeKey is null"); } 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 912ec8b7..ffe274b3 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 @@ -35,7 +35,7 @@ public class ActionSerializerRegistryHelper { * @param actionType * @param serializer */ - public void registerSerializer(Class actionType, + public void registerSerializer(Class actionType, OFGeneralSerializer serializer) { serializerRegistry.registerSerializer(new ActionSerializerKey<>(version, actionType, null), serializer); diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/InstructionSerializerRegistryHelper.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/InstructionSerializerRegistryHelper.java index 62e019ad..d85fbbdd 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/InstructionSerializerRegistryHelper.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/InstructionSerializerRegistryHelper.java @@ -34,7 +34,7 @@ public class InstructionSerializerRegistryHelper { * @param instructionType * @param serializer */ - public void registerSerializer(Class instructionType, + public void registerSerializer(Class instructionType, OFGeneralSerializer serializer) { serializerRegistry.registerSerializer(new InstructionSerializerKey<>(version, instructionType, null), serializer); diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchEntrySerializerRegistryHelper.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchEntrySerializerRegistryHelper.java index e722a93e..76f1f2ec 100644 --- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchEntrySerializerRegistryHelper.java +++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchEntrySerializerRegistryHelper.java @@ -15,12 +15,12 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.OxmC /** * @author michal.polkorab - * @param OXM class + * @param OXM class */ -public class MatchEntrySerializerRegistryHelper { +public class MatchEntrySerializerRegistryHelper { private short version; - private Class generalClass; + private Class generalClass; private SerializerRegistry serializerRegistry; /** @@ -28,7 +28,7 @@ public class MatchEntrySerializerRegistryHelper * @param generalClass * @param serializerRegistry */ - public MatchEntrySerializerRegistryHelper(short version, Class generalClass, + public MatchEntrySerializerRegistryHelper(short version, Class generalClass, SerializerRegistry serializerRegistry) { this.version = version; this.generalClass = generalClass; @@ -40,8 +40,8 @@ public class MatchEntrySerializerRegistryHelper * @param specificClass * @param serializer */ - public void registerSerializer( - Class specificClass, OFGeneralSerializer serializer) { + public void registerSerializer( + Class specificClass, OFGeneralSerializer serializer) { MatchEntrySerializerKey key = new MatchEntrySerializerKey<>(version, generalClass, specificClass); key.setExperimenterId(null); serializerRegistry.registerSerializer(key, serializer); -- 2.36.6