Thomas Vachuska | d404c51 | 2014-10-23 14:19:46 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Thomas Vachuska | d404c51 | 2014-10-23 14:19:46 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
Thomas Vachuska | d404c51 | 2014-10-23 14:19:46 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
Thomas Vachuska | d404c51 | 2014-10-23 14:19:46 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.codec; |
Thomas Vachuska | d404c51 | 2014-10-23 14:19:46 -0700 | [diff] [blame] | 17 | |
| 18 | import java.util.Set; |
| 19 | |
| 20 | /** |
| 21 | * Service for registering and retrieving JSON codecs for various entities. |
| 22 | */ |
| 23 | public interface CodecService { |
| 24 | |
| 25 | /** |
| 26 | * Returns the set of classes with currently registered codecs. |
| 27 | * |
| 28 | * @return set of entity classes |
| 29 | */ |
| 30 | Set<Class<?>> getCodecs(); |
| 31 | |
| 32 | /** |
| 33 | * Returns the JSON codec for the specified entity class. |
| 34 | * |
| 35 | * @param entityClass entity class |
Thomas Vachuska | ca60f2b | 2014-11-06 01:34:28 -0800 | [diff] [blame] | 36 | * @param <T> entity type |
Thomas Vachuska | d404c51 | 2014-10-23 14:19:46 -0700 | [diff] [blame] | 37 | * @return JSON codec; null if no codec available for the class |
| 38 | */ |
Thomas Vachuska | ca60f2b | 2014-11-06 01:34:28 -0800 | [diff] [blame] | 39 | <T> JsonCodec<T> getCodec(Class<T> entityClass); |
Thomas Vachuska | d404c51 | 2014-10-23 14:19:46 -0700 | [diff] [blame] | 40 | |
| 41 | /** |
| 42 | * Registers the specified JSON codec for the given entity class. |
| 43 | * |
| 44 | * @param entityClass entity class |
| 45 | * @param codec JSON codec |
Thomas Vachuska | 2292567 | 2014-11-11 17:57:53 -0800 | [diff] [blame] | 46 | * @param <T> entity type |
Thomas Vachuska | d404c51 | 2014-10-23 14:19:46 -0700 | [diff] [blame] | 47 | */ |
Thomas Vachuska | ca60f2b | 2014-11-06 01:34:28 -0800 | [diff] [blame] | 48 | <T> void registerCodec(Class<T> entityClass, JsonCodec<T> codec); |
Thomas Vachuska | d404c51 | 2014-10-23 14:19:46 -0700 | [diff] [blame] | 49 | |
| 50 | /** |
| 51 | * Unregisters the JSON codec for the specified entity class. |
| 52 | * |
| 53 | * @param entityClass entity class |
| 54 | */ |
| 55 | void unregisterCodec(Class<?> entityClass); |
| 56 | |
| 57 | } |