0edb216da9f12bb42814461c507d6ed8491850f8
[yangtools.git] / common / concepts / src / main / java / org / opendaylight / yangtools / concepts / AbstractUncheckedCodec.java
1 /*
2  * Copyright (c) 2019 PANTHEON.tech, s.r.o. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.yangtools.concepts;
9
10 import com.google.common.annotations.Beta;
11 import org.eclipse.jdt.annotation.NonNull;
12 import org.eclipse.jdt.annotation.NonNullByDefault;
13
14 /**
15  * An abstract base class enforcing nullness contract around {@link UncheckedCodec} interface.
16  *
17  * @param <P> Product type
18  * @param <I> Input type
19  * @param <X> Error exception type
20  */
21 @Beta
22 @NonNullByDefault
23 public abstract class AbstractUncheckedCodec<P, I, X extends RuntimeException> extends AbstractCodec<P, I, X>
24         implements UncheckedCodec<P, I, X> {
25     @Override
26     protected abstract @NonNull I deserializeImpl(@NonNull P product);
27
28     // implementation is guarded from nulls and verified not to return null
29     @Override
30     protected abstract @NonNull P serializeImpl(@NonNull I input);
31 }