Extensibility support - added possibility to unregister registered (de)serializers
[openflowjava.git] / openflow-protocol-api / src / main / java / org / opendaylight / openflowjava / protocol / api / extensibility / DeserializerRegistry.java
1 /*\r
2  * Copyright (c) 2013 Pantheon Technologies s.r.o. and others.  All rights reserved.\r
3  *\r
4  * This program and the accompanying materials are made available under the\r
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
7  */\r
8 package org.opendaylight.openflowjava.protocol.api.extensibility;\r
9 \r
10 \r
11 /**\r
12  * @author michal.polkorab\r
13  *\r
14  */\r
15 public interface DeserializerRegistry {\r
16 \r
17     /**\r
18      * Initializes deserializers\r
19      */\r
20     public void init();\r
21 \r
22     /**\r
23      * @param key used for deserializer lookup\r
24      * @return deserializer found\r
25      */\r
26     public <SERIALIZER_TYPE extends OFGeneralDeserializer>\r
27             SERIALIZER_TYPE getDeserializer(MessageCodeKey key);\r
28 \r
29     /**\r
30      * Registers deserializer under key\r
31      * @param key used to registry lookup\r
32      * @param deserializer deserializer instance\r
33      */\r
34     public void registerDeserializer(MessageCodeKey key, OFGeneralDeserializer deserializer);\r
35 \r
36     /**\r
37      * Unregisters deserializer under key\r
38      * @param key used to registry lookup\r
39      * @param deserializer deserializer instance\r
40      * @return true if deserializer was removed,\r
41      *  false if no deserializer was found under specified key\r
42      */\r
43     public boolean unregisterDeserializer(MessageCodeKey key);\r
44 }\r