/
Adapter.java
executable file
·56 lines (50 loc) · 1.79 KB
/
Adapter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/*
* Copyright (c) 2017 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.protocoladapter;
import org.eclipse.ditto.model.base.json.Jsonifiable;
/**
* An {@code Adapter} maps objects of type {@link T} to an {@link Adaptable} and vice versa.
*
* @param <T> the type mapped by this {@code Adapter}.
*/
public interface Adapter<T extends Jsonifiable> {
/**
* Maps the given {@code adaptable} to it's corresponding {@code T}.
*
* @param adaptable the adaptable to map.
* @return the mapped object.
* @throws NullPointerException if {@code adaptable} is {@code null}.
*/
T fromAdaptable(Adaptable adaptable);
/**
* Maps the given {@code t} to it's corresponding {@code Adaptable} using the {@link TopicPath.Channel#TWIN Twin}
* channel.
*
* @param t the object to map.
* @return the mapped adaptable.
* @throws NullPointerException if {@code t} is {@code null}.
*/
default Adaptable toAdaptable(final T t) {
return toAdaptable(t, TopicPath.Channel.TWIN);
}
/**
* Maps the given {@code t} to it's corresponding {@code Adaptable}.
*
* @param t the object to map.
* @param channel the Channel (Twin/Live) to use.
* @return the mapped adaptable.
* @throws NullPointerException if {@code t} is {@code null}.
* @throws IllegalArgumentException if {@code channel} is unknown.
*/
Adaptable toAdaptable(T t, TopicPath.Channel channel);
}